TipcSrvMonServerBufferPoll

Name

TipcSrvMonServerBufferPoll — poll once for RTserver message-related buffer information

Synopsis

T_BOOL TipcSrvMonServerBufferPoll(srv, server_name, connected_process_name) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name; 

Arguments

srv — connection handle to RTserver

server_name — name of RTserver to poll for buffer information (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 — name of connected process whose buffer in RTserver to poll (use T_IPC_MON_ALL to indicate a poll of all processes that the polled RTserver is connected to)

Return Values

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

Diagnostics

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

Description

TipcSrvMonServerBufferPoll polls for RTserver message-related buffer information by sending a MON_SERVER_BUFFER_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 buffer information of connected_process_name (which can be either an RTserver or another RTclient in the same project) is polled. The polled RTserver responds by sending back a MON_SERVER_BUFFER_POLL_RESULT message. The response should come back quickly. If connected_process_name is T_IPC_MON_ALL then the buffers in the polled RTserver of all connected processes are polled. The polling RTclient can use functions such as TipcSrvConnMsgSearchType or TipcSrvConnMainLoop to get the response.

Each MON_SERVER_BUFFER_POLL_RESULT message contains one fixed field followed by one or more groups of five fields. The fixed field is a STR field containing the name of the RTserver. The group of five fields is:

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

To poll once for RTclient buffer information, use TipcSrvMonClientBufferPoll.

For an example of how MON_SERVER_BUFFER_POLL_RESULT messages can be used, see the RTmon GDI Server Buffers window.

Caution

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

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

RTserver buffer information can only be polled, not watched.

See Also

TipcSrvMonClientBufferPoll, TipcSrvConnMsgWrite

Examples

This example uses TipcSrvMonServerBufferPoll to poll for all buffer information in all RTservers, creates a callback to process the incoming MON_SERVER_BUFFER_POLL_RESULT messages, and then waits up to 10 seconds for the poll results:

/* ===============================================================*/ 
/*..process_mon_server_buffer_poll_result -- process a 
MON_SERVER_BUFFER_POLL_RESULT message */ 
void T_ENTRY process_mon_server_buffer_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_STR connected_process_name; 
  T_INT4 msg_queue_count; 
  T_INT4 msg_queue_byte_count; 
  T_INT4 read_buffer_count; 
  T_INT4 write_buffer_count; 
   
  /* must set current field first */ 
  if (!TipcMsgSetCurrent(data->msg, 0)) { 
    return;  /* error */ 
  }  
 
  /* get first fixed field */ 
  if (!TipcMsgNextStr(data->msg, &server_name)) { 
    return;  /* error */ 
  } 
  TutOut("Got SERVER_BUFFER poll result.\n"); 
  TutOut("RTserver name = %s\n", server_name); 
 
  /* loop through all groups */ 
  while (TipcMsgRead(data->msg,  
                     T_IPC_FT_STR, &connected_process_name, 
                     T_IPC_FT_INT4, &msg_queue_count, 
                     T_IPC_FT_INT4, &msg_queue_byte_count, 
                     T_IPC_FT_INT4, &read_buffer_count, 
                     T_IPC_FT_INT4, &write_buffer_count, 
                     NULL)) { 
    TutOut("connected process name = %s\n", 
connected_process_name); 
    TutOut("msg queue count = %d\n", msg_queue_count); 
    TutOut("msg queue byte count = %d\n", msg_queue_byte_count); 
    TutOut("read buffer count = %d\n", read_buffer_count); 
    TutOut("write buffer count = %d\n", write_buffer_count); 
  } 
 
  /* make sure we reached the end of the message */ 
  if (TutErrNumGet() != T_ERR_MSG_EOM) { 
    return;  /* error */ 
  } 
 
} /* process_mon_server_buffer_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcSrvMonServerBufferPoll(srv, "/...", T_IPC_MON_ALL)) { 
  return;  /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_SERVER_BUFFER_POLL_RESULT); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (TipcSrvConnProcessCbCreate(srv, mt, 
process_mon_server_buffer_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 (!TipcSrvConnMainLoop(srv, 10.0)) { 
  return;  /* error */ 
}