TipcSrvMonProjectNamesPoll

Name

TipcSrvMonProjectNamesPoll — poll once for project names

Synopsis

T_BOOL TipcSrvMonProjectNamesPoll(srv) 
T_IPC_SRV srv; 

Arguments

srv — connection handle to RTserver

Return Values

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

Diagnostics

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

Description

TipcSrvMonProjectNamesPoll polls for project names by sending a MON_PROJECT_NAMES_POLL_CALL message to RTserver. RTserver responds by sending back a MON_PROJECT_NAMES_POLL_RESULT message. The response should come back quickly. The polling RTclient can use functions such as TipcSrvConnMsgSearchType or TipcSrvConnMainLoop to get the response. The MON_PROJECT_NAMES_POLL_RESULT message contains one field, a STR_ARRAY field containing the current project names.

To watch for created and destroyed project names, use TipcSrvMonProjectNamesSetWatch.

Caution

TipcSrvMonProjectNamesPoll sends a MON_PROJECT_NAMES_POLL_CALL message to RTserver, but does not explicitly flush the message. See TipcSrvConnGetAutoFlushSize for more information on message buffering.

See Also

TipcSrvMonProjectNamesGetWatch, TipcSrvMonProjectNamesSetWatch, TipcSrvConnMsgWrite

Examples

This example uses TipcSrvMonProjectNamesPoll to poll for project 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 *project_names; 
T_INT4 num_project_names; 
T_INT4 counter; 
 
/* send the poll request out to RTserver */ 
if (!TipcSrvMonProjectNamesPoll(srv)) { 
  return;  /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_PROJECT_NAMES_POLL_RESULT); 
if (mt == NULL) { 
  return;  /* error */ 
}  
 
/* wait up to 10 seconds for the poll result */ 
msg = TipcSrvConnMsgSearchType(srv, 10.0, mt); 
if (msg == NULL) { 
  return;  /* error */ 
}  
 
/* set the current field to the first field */ 
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
} 
 
if (!TipcMsgNextStrArray(msg, &project_names, &num_project_names)) 
{ 
  return;  /* error */ 
} 
 
TutOut("Got PROJECT_NAMES poll result.\n"); 
for (counter = 0; counter < num_project_names; counter++) { 
  TutOut("project_names[%d] = %s\n", counter, 
project_names[counter]); 
} 
 
/* clean up */ 
if (!TipcMsgDestroy(msg)) { 
  return;  /* error */ 
}