TipcMonServerMsgTrafficPoll

Name

TipcMonServerMsgTrafficPoll — poll once for RTserver message traffic information

The previous function, TipcMonServerMsgTrafficExPoll, supersedes this function for all new development. Use this older function only when operating with clients prior to release 6.7. This poll can truncate the statistics data that it returns.

Synopsis

T_BOOL TipcMonServerMsgTrafficPoll(server_name, connected_process_name) 
T_STR server_name; 
T_STR connected_process_name; 

Arguments

server_name — name of RTserver to poll for message traffic 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 message traffic 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 message traffic information was successfully initiated, FALSE otherwise.

Diagnostics

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

Description

TipcMonServerMsgTrafficPoll polls for RTserver message traffic information by sending a MON_SERVER_MSG_TRAFFIC_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 message traffic 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_MSG_TRAFFIC_POLL_RESULT message. The response should come back quickly. If connected_process_name is T_IPC_MON_ALL then the message traffic in the polled RTserver of all connected processes are polled. The polling RTclient can use functions such as TipcSrvMsgSearchType or TipcSrvMainLoop to get the response.

Each MON_SERVER_MSG_TRAFFIC_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 message traffic information, use TipcMonClientMsgTrafficPoll.

For an example of how MON_SERVER_MSG_TRAFFIC_POLL_RESULT messages can be used, see the RTmon GDI Watch Server Connections window.

Caution

TipcMonServerMsgTrafficPoll sends a MON_SERVER_MSG_TRAFFIC_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 message traffic information can only be polled, not watched.

See Also

TipcMonClientMsgTrafficPoll, TipcSrvMsgWrite

Examples

This example uses TipcMonServerMsgTrafficPoll to poll for all message traffic information in all RTservers, creates a callback to process the incoming MON_SERVER_MSG_TRAFFIC_POLL_RESULT messages, and then waits up to 10 seconds for the poll results:

/* =============================================================== */ 
/*..process_mon_server_msg_traffic_poll_result -- process a 
MON_SERVER_MSG_TRAFFIC_POLL_RESULT message */ 
void T_ENTRY process_mon_server_msg_traffic_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 total_msg_send; 
  T_INT4 total_msg_recv; 
  T_INT4 total_byte_send; 
  T_INT4 total_byte_recv; 
   
  /* 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_MSG_TRAFFIC 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, &total_msg_send, 
                     T_IPC_FT_INT4, &total_msg_recv, 
                     T_IPC_FT_INT4, &total_byte_send, 
                     T_IPC_FT_INT4, &total_byte_recv, 
                     NULL)) { 
    TutOut("connected process name = %s\n", 
connected_process_name); 
    TutOut("total msg send = %d\n", total_msg_send); 
    TutOut("total msg recv = %d\n", total_msg_recv); 
    TutOut("total byte send = %d\n", total_byte_send); 
    TutOut("total byte recv = %d\n", total_byte_recv); 
  } 
 
  /* make sure we reached the end of the message */ 
  if (TutErrNumGet() != T_ERR_MSG_EOM) { 
    return; /* error */ 
  } 
} /* process_mon_server_msg_traffic_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcMonServerMsgTrafficPoll("/...", T_IPC_MON_ALL)) { 
  return; /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_SERVER_MSG_TRAFFIC_POLL_RESULT); 
if (mt == NULL) { 
  return; /* error */ 
} 
 
if (TipcSrvProcessCbCreate(mt, 
                           
process_mon_server_msg_traffic_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 */ 
}