TipcMonClientCongestionGetWatch

Name

TipcMonClientCongestionGetWatch — determine if the RTclient is watching a client's write buffer for congestion

Synopsis

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

Arguments

client_name — name of the RTclient for which a watch is being checked

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcMonClientCongestionGetWatch gets whether the RTclient is watching for congestion in the client_name RTclient write buffer. 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_return argument is set to TRUE if the watch is currently active, FALSE if not.

Caution

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

RTclient write buffer congestion can only be watched, not polled.

See Also

TipcMonClientBufferSetWatch, TipcMonClientCongestionSetWatch, TipcMonServerCongestionSetWatch, TipcMonServerCongestionGetWatch

Examples

This example uses TipcMonClientCongestionGetWatch to determine the status of a buffer congestion watch in the primary RTclient:

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