TipcMonServerTimePoll

Name

TipcMonServerTimePoll — poll once for RTserver time information

Synopsis

T_BOOL TipcMonServerTimePoll(server_name) 
T_STR server_name; 

Arguments

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

Return Values

TRUE if the poll for RTserver time information was successfully initiated, FALSE otherwise.

Diagnostics

If TipcMonServerTimePoll fails, it returns FALSE and sets the global SmartSockets error number to one of:

Description

TipcMonServerTimePoll polls for RTserver time information by sending a MON_SERVER_TIME_POLL_CALL message to the server_name RTserver. 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 polled RTserver responds by sending back a MON_SERVER_TIME_POLL_RESULT message. The response should come back quickly. The polling RTclient can use functions such as TipcSrvMsgSearchType or TipcSrvMainLoop to get the response.

Each MON_SERVER_TIME_POLL_RESULT message contains four fields:

There are multiple responses only if server_name is a wildcard or T_IPC_MON_ALL.

To poll once for RTclient time information, use TipcMonClientTimePoll.

Caution

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

There is no response message if the RTserver named server_name does not exist; the poll is silently dropped.

RTserver time information can only be polled, not watched, as RTserver does not have the notion of current time as RTclients do.

See Also

TipcMonClientTimePoll, TipcSrvMsgWrite

Examples

This example uses TipcMonServerTimePoll to poll for time information in all RTservers, creates a callback to process the incoming MON_SERVER_TIME_POLL_RESULT messages, then waits up to 10 seconds for the poll results:

/* =============================================================== */ 
/*..process_mon_server_time_poll_result -- process a MON_SERVER_TIME_POLL_RESULT 
message */ 
void T_ENTRY process_mon_server_time_poll_result(conn, data, arg) 
T_IPC_CONN conn; 
T_IPC_CONN_PROCESS_CB_DATA data; 
T_CB_ARG arg; 
{ 
  T_STR server_name; 
  T_REAL8 wall_time; 
  T_STR wall_time_str; 
  T_REAL8 cpu_time; 
   
  /* must set current field first */ 
  if (!TipcMsgSetCurrent(data->msg, 0)) { 
    return; /* error */ 
  }  
 
  /* get the fields from the message */ 
  if (!TipcMsgRead(data->msg,  
                   T_IPC_FT_STR, &server_name, 
                   T_IPC_FT_REAL8, &wall_time, 
                   T_IPC_FT_STR, &wall_time_str, 
                   T_IPC_FT_REAL8, &cpu_time, 
                   NULL)) { 
    return; /* error */ 
  }  
 
  TutOut("Got SERVER_TIME poll result.\n"); 
  TutOut("RTserver name = %s\n", server_name); 
  TutOut("wall time = %f\n", wall_time); 
  TutOut("wall time str = %s\n", wall_time_str); 
  TutOut("CPU time = %f\n", cpu_time); 
} /* process_mon_server_time_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcMonServerTimePoll("/...")) { 
  return; /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_SERVER_TIME_POLL_RESULT); 
if (mt == NULL) { 
  return; /* error */ 
} 
 
if (TipcSrvProcessCbCreate(mt, 
process_mon_server_time_poll_result, 
                           NULL) == NULL) { 
  return; /* error */ 
} 
 
/* read and process all poll results (as well as any other incoming 
messages) that arrive within the next 10 seconds */ 
if (!TipcSrvMainLoop(10.0)) { 
  return; /* error */ 
}