watch

Name

watch — display monitoring information whenever it changes

Synopsis

Supported for RTmon only:

watch 
watch client_buffer client 
watch client_msg_recv client msg_type 
watch client_msg_send client msg_type 
watch client_names 
watch client_subscribe client 
watch client_time client 
watch project_names 
watch server_conn 
watch server_names 
watch subject_names 
watch subject_subscribe subject 

Description

The watch command turns on watching for monitoring information. Depending on the type of watch performed, the request may go to one or all RTserver and RTclient processes. Every time the watched information changes, RTmon receives updated information. The run command can be used to receive and display the watch responses. For most watch categories, when watching is turned on, RTmon also receives an initial status message so that RTmon can immediately display the current status. The watch command uses the TipcMonTypeSetWatch API functions to start the watching.

For all of the user-specifiable parameters (client, server, subject), a single item can be specified by name or @ (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.

When @ (at sign) or a wildcarded value is used for a user-specifiable parameter, both current and future items of that type are watched. For example, the command watch client_subscribe /... not only turns on watching in all current RTclient processes but also all future RTclient processes!

If watch is called without any arguments, all the categories currently being watched are printed, one on each line.

The watch client_buffer command watches buffer information in client.

The watch client_msg_recv command watches messages of type msg_type being received in client.

The watch client_msg_send command watches message of type msg_type being sent from client.

The watch client_names command watches client (RTclient processes) names.

The watch client_subscribe command watches the subjects to which client is subscribing.

The watch client_time command watches time in client.

The watch project_names command watches project names.

The watch server_conn command watches connection information about all RTservers.

The watch server_names command watches server (RTserver processes) names.

The watch subject_names command watches subject names.

The watch subject_subscribe command watches 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 (entering at the GDI MON> prompt) when using the GDI. These three commands are always available, though, 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 watch command causes RTmon to connect to RTserver if it has not already done so.

The watch command prints a warning message if a watch is requested for a category that is already being watched.

See Also

run, unwatch

Examples

MON> watch client_subscribe /... 
Start watching client_subscribe </...>. 
MON> run 100000 5 
WATCH> Current Subjects Being Subscribed to by Client 
/_workstatoin1_27709: 
  /_all /_workstation1 /_workstation1_27709 /_mon 
Timeout of 5 was reached.