TipcMonServerConnGetWatch

Name

TipcMonServerConnGetWatch — determine if this RTclient is watching RTserver connections

Synopsis

T_BOOL TipcMonServerConnGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

Arguments

watch_status_return — storage for watch status

Return Values

TRUE if the RTserver connections watch status was successfully retrieved, FALSE otherwise.

Diagnostics

If TipcMonServerConnGetWatch fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMonServerConnGetWatch gets whether this RTclient is watching RTserver connections of the RTservers that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_SERVER_CONN_STATUS message each time a connection between RTservers is created or destroyed.

Each MON_SERVER_CONN_STATUS message contains eight fields (all the array fields have the same number of elements):

To set whether this RTclient is watching RTserver connections, use TipcMonServerConnSetWatch. To poll once for RTserver connections, use TipcMonServerConnPoll.

For an example of how MON_SERVER_CONN_STATUS messages can be used, see the RTmon GDI Watch Server Connections window.

Caution

If TipcMonServerConnGetWatch returns FALSE, it does not store a value in watch_status_return.

See Also

TipcMonServerConnPoll, TipcMonServerConnSetWatch

Examples

This example uses TipcMonServerConnGetWatch to get the status of watching RTserver connections:

T_BOOL watch_status; 
 
if (!TipcMonServerConnGetWatch(&watch_status)) { 
  return; /* error */ 
} 
TutOut("This process is %s RTserver connections.\n", 
       watch_status ? "watching" : "not watching");