TipcSrvMonServerConnGetWatch

Name

TipcSrvMonServerConnGetWatch — determine whether this RTclient is watching RTserver connections

Synopsis

T_BOOL TipcSrvMonServerConnGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return; 

Arguments

srv — connection handle to RTserver

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcSrvMonServerConnGetWatch determines 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 TipcSrvMonServerConnSetWatch. To poll once for RTserver connections, use TipcSrvMonServerConnPoll.

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

Caution

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

See Also

TipcSrvMonServerConnPoll, TipcSrvMonServerConnSetWatch

Examples

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

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