TipcMonClientSubscribeGetWatch

Name

TipcMonClientSubscribeGetWatch — determine if this RTclient is watching the subjects that an RTclient is subscribing to

Synopsis

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

Diagnostics

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

Description

TipcMonClientSubscribeGetWatch gets whether this RTclient is watching the subjects that the client_name RTclient is subscribing to. 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_SUBSCRIBE_STATUS message each time the watched RTclient starts or stops subscribing to a subject.

Each MON_CLIENT_SUBSCRIBE_STATUS message contains four fields:

To set whether this RTclient is watching the subjects that an RTclient is subscribing to, use TipcMonClientSubscribeSetWatch. To poll once for the subjects that an RTclient is subscribing to, use TipcMonClientSubscribePoll.

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

Caution

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

See Also

TipcMonClientSubscribePoll, TipcMonClientSubscribeSetWatch

Examples

This example uses TipcMonClientSubscribeGetWatch to get the status of watching subjects being subscribed to by the primary RTclient:

T_BOOL watch_status; 
 
if (!TipcMonClientSubscribeGetWatch("primary", &watch_status)) { 
  return; /* error */ 
} 
TutOut("This process is %s subjects being subscribed to by ", 
       watch_status ? "watching" : "not watching"); 
TutOut("primary.\n");