TipcSrvMonServerMaxClientLicensesGetWatch

Name

TipcSrvMonServerMaxClientLicensesGetWatch — determine if the RTserver is watching for the RTserver cloud to exceed the licensed number of RTclient connections

Synopsis

T_BOOL TipcSrvMonServerMaxClientLicensesGetWatch(srv, server_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR server_name; 
T_BOOL *watch_status_return; 

Arguments

srv — connection handle to RTserver

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

watch_status_return — storage for watch status

Return Values

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

Diagnostics

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

Description

TipcSrvMonServerMaxClientLicensesGetWatch determines whether the server_name RTserver is watching for the server cloud to exceed the maximum licensed number of RTclient connections. 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 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.

RTserver licenses can only be watched, not polled.

See Also

TipcSrvMonServerMaxClientLicensesSetWatch

Examples

This example uses TipcSrvMonServerMaxClientLicensesGetWatch to determine whether the RTserver is watching for the RTserver cloud to exceed the maximum licensed number of RTclient connections:

T_BOOL watch_status; 
 
if (!TipcSrvMonServerMaxClientLicensesGetWatch(srv, "/...",  
                                               &watch_status)) { 
  return;  /* error */ 
} 
 
TutOut("This RTclient is %s client rejections in ", 
       watch_status ? "watching" : "not watching"); 
TutOut("all servers.\n");