TipcSrvMonServerNamesGetWatch

Name

TipcSrvMonServerNamesGetWatch — determine if this RTclient is watching RTserver names

Synopsis

T_BOOL TipcSrvMonServerNamesGetWatch(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 names watch status was successfully retrieved, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — srv or watch_status_return was null

Description

TipcSrvMonServerNamesGetWatch determines whether this RTclient is watching the RTserver names that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_SERVER_NAMES_STATUS message each time an RTserver is created or destroyed. An RTserver is considered created when it starts up (and usually connects to other RTservers). An RTserver is considered destroyed when it terminates or disconnects from other RTservers.

Each MON_SERVER_NAMES_STATUS message contains four fields:

a STR_ARRAY field containing the current RTserver names

a STR_ARRAY field containing RTserver info strings of the form "ident: user@node" (for example, "Primary_RTclient: ssuser@workstation1")

a STR field containing the name of the created RTserver (or "" if not applicable)

a STR field containing the name of the destroyed RTserver (or "" if not applicable)

To set whether this RTclient is watching RTserver names, use TipcSrvMonServerNamesSetWatch. To poll once for RTserver names, use TipcSrvMonServerNamesPoll.

Caution

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

Examples

This example uses TipcSrvMonServerNamesGetWatch to get the status of watching RTserver names:

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