TipcSrvMonServerCongestionGetWatch

Name

TipcSrvMonServerCongestionGetWatch — determine if the RTserver is watching for congestion in the RTserver write buffer of a connected process

Synopsis

T_BOOL TipcSrvMonServerCongestionGetWatch(srv, server_name, 
connected_process_name, watch_status_return) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name; 
T_BOOL *watch_status_return; 

Arguments

srv — connection handle to RTserver

server_name — name of RTserver to get watch status for (wildcard names allowed, or use T_IPC_MON_ALL to indicate a poll of all RTservers matching the value of Monitor_Scope)

connected_process_name — the name of the process to get watch status of (use T_IPC_MON_ALL to indicate a poll of all processes that the polled RTserver is connected to)

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcSrvMonServerCongestionGetWatch determines whether the server_name RTserver is watching for congestion in the connected_process_name write buffer. The server_name argument can be the unique subject name of a single RTserver, a wildcarded subject name to match many RTservers, or T_IPC_MON_ALL to poll all RTservers that match the value of the Monitor_Scope option. The connected_process_name argument can be the name of any RTclient connected to server_name, or T_IPC_MON_ALL to indicate a poll of all processes that the polled RTserver is connected to. The srv argument indicates the connection on which the watch is to be checked.

The watch_status_return argument is set to TRUE if the watch is currently active, FALSE if not.

Caution

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

Write buffer congestion can only be watched, not polled.

See Also

TipcSrvMonServerCongestionSetWatch, TipcSrvMonClientCongestionSetWatch, TipcSrvMonClientCongestionGetWatch

Examples

This example uses TipcSrvMonServerCongestionGetWatch to determine the status of a buffer congestion watch in all connections on all RTservers:

T_BOOL watch_status; 
 
if (!TipcSrvMonServerCongestionGetWatch(srv, "/...", 
T_IPC_MON_ALL,  
                                        &watch_status)) { 
  return;  /* error */ 
} 
 
TutOut("This RTclient is %s RTserver buffer congestion in ", 
       watch_status ? "watching" : "not watching"); 
TutOut("all connections on all servers.\n");