TipcMonClientNamesPoll

TRUE if the poll for RTclient names was successfully initiated, FALSE otherwise.

Diagnostics

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

Description

TipcMonClientNamesPoll polls for the RTclient names in the current project that match the value of the Monitor_Scope option by sending a MON_CLIENT_NAMES_POLL_CALL message to RTserver. RTserver responds by sending back a MON_CLIENT_NAMES_POLL_RESULT message. The response should come back quickly. The polling RTclient can use functions such as TipcSrvMsgSearchType or TipcSrvMainLoop to get the response. The MON_CLIENT_NAMES_POLL_RESULT message contains three fields:

a STR_ARRAY field containing the current RTclient names

a STR_ARRAY field containing RTclient info strings of the form "ident: user@node" (such as "Primary_RTclient: ssuser@workstation1")

a STR_ARRAY field containing the name of the RTserver each RTclient is connected to

To watch for created and destroyed RTclient names, use TipcMonClientNamesSetWatch.

Caution

TipcMonClientNamesPoll sends a MON_CLIENT_NAMES_POLL_CALL message to RTserver, but does not explicitly flush the message. See TipcSrvGetAutoFlushSize for more information on message buffering.

See Also

Examples

This example uses TipcMonClientNamesPoll to poll for RTclient names, waits up to 10 seconds for the poll result, and then prints the poll result message:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_STR *client_names; 
T_INT4 num_client_names; 
T_STR *info_strs; 
T_STR *server_names; 
T_INT4 counter; 
 
/* send the poll request out to RTserver */ 
if (!TipcMonClientNamesPoll()) { 
  return; /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_CLIENT_NAMES_POLL_RESULT); 
if (mt == NULL) { 
  return; /* error */ 
}  
 
/* wait up to 10 seconds for the poll result */ 
msg = TipcSrvMsgSearchType(10.0, mt); 
if (msg == NULL) { 
  return; /* error */ 
}  
 
/* set the current field to the first field */ 
if (!TipcMsgSetCurrent(msg, 0)) { 
  return; /* error */ 
} 
 
/* client_names, info_strs, and server_names contains the same number of elements */ 
if (!TipcMsgNextStrArray(msg, &client_names, &num_client_names) 
    || !TipcMsgNextStrArray(msg, &info_strs, &num_client_names) 
    || !TipcMsgNextStrArray(msg, &server_names, &num_client_names)) 
{ 
  return; /* error */ 
} 
 
TutOut("Got CLIENT_NAMES poll result.\n"); 
for (counter = 0; counter < num_client_names; counter++) { 
  TutOut("client_names[%d] = %s\n", counter, 
client_names[counter]); 
  TutOut("info_strs[%d] = %s\n", counter, info_strs[counter]); 
  TutOut("server_names[%d] = %s\n", counter, 
server_names[counter]); 
} 
 
/* clean up */ 
if (!TipcMsgDestroy(msg)) { 
  return; /* error */ 
}