TipcMonClientBufferGetWatch

Name

TipcMonClientBufferGetWatch — determine if this RTclient is watching message-related buffer information in an RTclient

Synopsis

T_BOOL TipcMonClientBufferGetWatch(client_name, watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

Arguments

client_name — name of RTclient to get watch status for (wildcard names allowed, or use T_IPC_MON_ALL to indicate a watch of all RTclients matching the value of Monitor_Scope)

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcMonClientBufferGetWatch gets whether this RTclient is watching message-related buffer information in the client_name RTclient. The client_name argument can be the unique subject name of a single RTclient, a wildcarded subject name to match many RTclients, or T_IPC_MON_ALL to watch all RTclients in the project that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_CLIENT_BUFFER_STATUS message each time the message queue for the connection to RTserver changes in the watched RTclient.

Each MON_CLIENT_BUFFER_STATUS message contains five fields:

To set whether this RTclient is watching RTclient buffer information, use TipcMonClientBufferSetWatch. To poll once for RTclient buffer information, use TipcMonClientBufferPoll.

For an example of how MON_CLIENT_BUFFER_STATUS messages can be used, see the RTmon GDI Watch Client Buffer window.

Caution

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

See Also

TipcMonClientBufferPoll, TipcMonClientBufferSetWatch

Examples

This example uses TipcMonClientBufferGetWatch to get the status of watching buffer information in the primary RTclient:

T_BOOL watch_status; 
 
if (!TipcMonClientBufferGetWatch("primary", &watch_status)) { 
  return;  return; /* error */ 
} 
TutOut("This RTclient is %s RTclient buffer information in ", 
       watch_status ? "watching" : "not watching"); 
TutOut("primary.\n");