TipcMonClientNamesGetWatch

Name

TipcMonClientNamesGetWatch — determine if this RTclient is watching RTclient names

Synopsis

T_BOOL TipcMonClientNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return;

Arguments

watch_status_return — storage for watch status

Return Values

TRUE if the RTclient names watch status was successfully retrieved, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — watch_status_return was null

Description

TipcMonClientNamesGetWatch gets whether this RTclient is watching the RTclient names in the current project that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_CLIENT_NAMES_STATUS message each time an RTclient is created or destroyed. An RTclient is considered created when it connects to RTserver. An RTclient is considered destroyed when it disconnects from RTserver.

Each MON_CLIENT_NAMES_STATUS message contains five fields:

a STR_ARRAY field containing the current RTclient names

a STR_ARRAY field containing RTclient info strings of the form "ident: user@node" (such as "Runtime_RTie: ssuser@workstation1")

a STR_ARRAY field containing the name of the RTserver each RTclient is connected to

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

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

To set whether this RTclient is watching RTclient names, use TipcMonClientNamesSetWatch. To poll once for the RTclient names, use TipcMonClientNamesPoll.

Caution

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

Examples

This example uses TipcMonClientNamesGetWatch to get the status of watching RTclient names:

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