TipcMonClientMsgSendGetWatch

Name

TipcMonClientMsgSendGetWatch — determine if this RTclient is watching sent messages in an RTclient

Synopsis

T_BOOL TipcMonClientMsgSendGetWatch(client_name, msg_type_name,  
                                    watch_status_return) 
T_STR client_name; 
T_STR msg_type_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)

msg_type_name — name of message type to get watch status for (use T_IPC_MON_ALL to indicate a watch of all message types)

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcMonClientMsgSendGetWatch gets whether this RTclient is watching sent messages 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_MSG_SEND_STATUS message each time a message is sent to RTserver in the watched RTclient.

If msg_type_name is T_IPC_MON_ALL, then all message types in the watched RTclient are watched.

Each MON_CLIENT_MSG_SEND_STATUS message contains two fields:

To set whether this RTclient is watching RTclient sent messages, use TipcMonClientMsgSendSetWatch.

For an example of how MON_CLIENT_MSG_SEND_STATUS messages can be used, see the RTmon GDI Watch Messages Sent window.

Caution

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

RTclient sent messages can only be watched, not polled.

See Also

TipcMonClientMsgSendSetWatch

Examples

This example uses TipcMonClientMsgSendGetWatch to get the status of watching all sent messages in the primary RTclient:

T_BOOL watch_status; 
 
if (!TipcMonClientMsgSendGetWatch("primary", T_IPC_MON_ALL,  
                                  &watch_status)) { 
  return;  /* error */ 
} 
TutOut("This process is %s all messages sent in primary.\n", 
       watch_status ? "watching" : "not watching");