poll


Name

poll — make a one-time request for monitoring information

Synopsis

Supported for RTmon only:

poll client_buffer client 
poll client_cb client 
poll client_cpu client 
poll client_ext client 
poll client_general client 
poll client_info client 
poll client_msg_type_ex client msg_type 
poll client_msg_type client msg_type 
poll client_names 
poll client_names_num 
poll client_option client option 
poll client_subject_ex client subject 
poll client_subject client subject 
poll client_subscribe client 
poll client_subscribe_num client 
poll client_time client 
poll client_version client 
poll project_names 
poll server_buffer server process 
poll server_cpu server 
poll server_conn 
poll server_general server 
poll server_msg_traffic_ex server process 
poll server_msg_traffic server process 
poll server_names 
poll server_option server option 
poll server_route server dest_server 
poll server_start_time server 
poll server_time server 
poll server_version server 
poll subject_names 
poll subject_subscribe subject 

Description

The poll command sends a message to request a snapshot of some current monitoring information. Depending on the type of poll performed, the request may go to one or all RTserver and RTclient processes. After a poll, the run command can be used to receive and display the poll responses. The poll command uses the TipcMonTypePoll API functions (such as TipcMonProjectNamesPoll for poll project_names) to send the request.

For all of the user-specifiable parameters (client, server, subject, and so on), either a single item can be specified by name, or @ (an at sign) can be used to specify all items that match Monitor_Scope or all items of that type (such as all RTclients or all subjects). For client (RTclient processes), server (RTserver processes), and process (RTclient or RTserver processes), the process is identified by its unique subject. See Specifying Items to be Monitored for complete information on monitoring parameters.

Polls ending in _ex supersede corresponding older forms because the older forms can truncate the traffic data. (The older forms are retained for backward compatibility with clients older than release 6.7.)

The poll client_buffer command polls client for buffer information.

The poll client_cb command polls client for callback information.

The poll client_cpu command polls client for client CPU usage.

The poll client_ext command polls client for information set by the user (with TipcMonExtSet*).

The poll client_info command polls client for general information.

The poll client_general command polls client for general information.

The poll client_msg_traffic command polls client for message traffic information. (Clients older than release 6.7 might return truncated values. If this occurs, RTmon will print an INFO level trace message.)

The poll client_msg_type_ex command polls client for message traffic information. (The older form client_msg_traffic is retained only for backward compatibility.)

The poll client_names command polls RTserver for client (RTclient processes) names.

The poll client_names_num command polls RTserver for the number of clients that are currently connected.

The poll client_option command polls client for option information.

The poll client_subject_ex command polls client for subject information. (The older form client_subject is retained only for backward compatibility.)

The poll client_subscribe command polls RTserver for the subjects to which client is subscribing.

The poll client_subscribe_num command polls RTserver for the number of subjects to which client subscribes.

The poll client_time command polls client for time information.

The poll client_version command polls client for version information.

The poll project_names command polls RTserver for project names.

The poll server_buffer command polls server for information on its buffer to process.

The poll server_conn command polls RTserver for connection information about all RTservers.

The poll server_cpu command polls RTserver for server CPU utilization.

The poll server_general command polls server for general information.

The poll server_msg_traffic_ex command polls server for message traffic information. (The older form server_msg_traffic is retained only for backward compatibility.)

The poll server_names command polls RTserver for server (RTserver processes) names.

The poll server_option command polls server for option information.

The poll server_route command polls server for route information.

The poll server_start_time command polls RTserver for start time and elapsed time information.

The poll server_time command polls server for time information.

The poll server_version command polls RTserver for version information.

The poll subject_names command polls RTserver for subject names in the current project.

The poll subject_subscribe command polls RTserver for the RTclient processes that are subscribing to the subject subject.

Caution

The RTmon GDI uses the poll, watch, and unwatch commands to control RTmon. Because the GDI needs complete control over these commands, these three commands are unavailable for interactive use when using the GDI (for example, the user cannot enter a poll command at the GDI MON> prompt). These three commands are always available when using the runtime RTmon.

Only one project at a time can be monitored by each RTmon process. Information in other projects is not visible. To monitor a different project, the option Project must be changed, and then RTmon must disconnect and reconnect to RTserver.

The poll command causes RTmon to connect to RTserver if it has not already done so.

See Also

run, watch, unwatch

Examples

MON> poll client_names 
Polled for client_names. 
MON> run 1 
POLL> Current Clients: 
 /_workstation1_13806 [Runtime_RTmon: ssuser@workstation1] 
   connected to RTserver /_workstation1_13746 
Processed a mon_client_names_poll_result message. 
MON> poll client_general /... /* poll all clients */ 
Polled for client_general. 
MON> run 1 
/* Notice that we have polled ourself. */ 
Processed a mon_client_general_poll_call message. 
MON> run 1 
/* Here’s the response from ourself. There would be additional responses if any other clients were 
running. */ 
POLL> General Info From Client /_workstation1_13806 
  ident = Runtime_RTmon, node = workstation1, user = ssuser, pid = 
1376 
  arch = sun4_solaris, project = rtworks, 
         RTserver name = /_workstation1_1376 
  logical conn name to RTserver: local:workstation1:RTSERVER 
  subject subscribe: /_all /_mon /_workstation1 /_workstation1_1376 
  int format = BIG_ENDIAN, real format = IEEE 
  current sbrk = 274456, delta sbrk = 159744 
Processed a mon_client_general_poll_result message. 

TIBCO SmartSockets™ User’s Guide
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com