TipcMonClientMsgTypePoll

	The previous function, `TipcMonClientMsgTypeExPoll`, 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.

client_name — name of RTclient to poll for message type information (wildcard names allowed, or use T_IPC_MON_ALL to indicate a poll of all RTclients matching the value of Monitor_Scope)

msg_type_name — name of message type to poll for information (use T_IPC_MON_ALL to indicate a poll of all message types)

Return Values

TRUE if the poll for RTclient message type information was successfully initiated, FALSE otherwise.

Diagnostics

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

Description

TipcMonClientMsgTypePoll polls for RTclient message type information by sending a MON_CLIENT_MSG_TYPE_POLL_CALL message to the client_name RTclient. The client_name argument can be the unique subject name of a single RTclient, a wildcarded subject name to match many RTclients, or T_IPC_MON_ALL to poll all RTclients in the project that match the value of the Monitor_Scope option. The polled RTclient responds by sending back a MON_CLIENT_MSG_TYPE_POLL_RESULT message. The response may or may not come back quickly, depending on what the polled RTclient is doing. If msg_type_name is T_IPC_MON_ALL, then all message types in the polled RTclient are polled. The polling RTclient can use functions such as TipcSrvMsgSearchType or TipcSrvMainLoop to get the response.

Each MON_CLIENT_MSG_TYPE_POLL_RESULT message contains one fixed field and one or more groups of fifteen fields. The fixed field is a STR field containing the name of the RTclient. The group of fifteen fields is:

a STR field containing the name of the message type

an INT4 field containing the message type number

a STR field containing the message type grammar

an INT4 field containing whether the message type priority is known (really of type T_BOOL)

an INT2 field containing the message type priority (not applicable if the previous field is FALSE)

an INT4 field containing the message type delivery mode (really of type T_IPC_DELIVERY_MODE)

an INT4 field containing the message type user-defined property

an INT4 field containing the number of read callbacks the polled RTclient connection has for this message type

an INT4 field containing the number of write callbacks the polled RTclient connection has for this message type

an INT4 field containing the number of process callbacks the polled RTclient connection has for this message type

an INT4 field containing the number of queue callbacks the polled RTclient connection has for this message type

an INT4 field containing the number of messages the polled RTclient connection has sent for this message type

an INT4 field containing the number of messages the polled RTclient connection has received for this message type

an INT4 field containing the number of bytes the polled RTclient connection has sent for this message type

an INT4 field containing the number of bytes the polled RTclient connection has received for this message type

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

To poll once for global message traffic information, use TipcMonClientMsgTrafficPoll. To poll once for message traffic information by subject, use TipcMonClientSubjectPoll. To poll once for global callback information, use TipcMonClientCbPoll.

Caution

TipcMonClientMsgTypePoll sends a MON_CLIENT_MSG_TYPE_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 RTclient named client_name or the message type named msg_type_name does not exist; the poll is silently dropped.

See Also

Examples

This example uses TipcMonClientMsgTypePoll to poll for all message type information in all RTclients (including this one), creates a callback to process the incoming MON_CLIENT_MSG_TYPE_POLL_RESULT messages, and then waits up to 10 seconds for the poll results.

/* =============================================================== */ 
/*..process_mon_client_msg_type_poll_result -- process a 
MON_CLIENT_MSG_TYPE_POLL_RESULT message */ 
void T_ENTRY process_mon_client_msg_type_poll_result( 
                        conn, data, arg) 
 
T_IPC_CONN conn; 
T_IPC_CONN_PROCESS_CB_DATA data; 
T_CB_ARG arg; 
{ 
  T_STR client_name; 
  T_STR msg_type_name; 
  T_INT4 num; 
  T_STR grammar; 
  T_INT4 priority_known; /* really (T_BOOL) */ 
  T_INT2 priority; /* not applicable if priority_known is FALSE */ 
  T_INT4 delivery_mode; /* really T_IPC_DELIVERY_MODE */ 
  T_INT4 user_prop; 
  T_INT4 num_read_cb; 
  T_INT4 num_write_cb; 
  T_INT4 num_process_cb; 
  T_INT4 num_queue_cb; 
  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, &client_name)) { 
    return; /* error */ 
  } 
  TutOut("Got CLIENT_MSG_TYPE poll result.\n"); 
  TutOut("RTclient name = %s\n", client_name); 
 
  /* loop through all groups */ 
  while (TipcMsgRead(data->msg,  
                     T_IPC_FT_STR, &msg_type_name, 
                     T_IPC_FT_INT4, &num, 
                     T_IPC_FT_STR, &grammar, 
                     T_IPC_FT_INT4, &priority_known, 
                     T_IPC_FT_INT2, &priority, 
                     T_IPC_FT_INT4, &delivery_mode, 
                     T_IPC_FT_INT4, &user_prop, 
                     T_IPC_FT_INT4, &num_read_cb, 
                     T_IPC_FT_INT4, &num_write_cb, 
                     T_IPC_FT_INT4, &num_process_cb, 
                     T_IPC_FT_INT4, &num_queue_cb, 
                     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("message type name = %s\n", msg_type_name); 
    TutOut("num = %d\n", num); 
    TutOut("grammar = %s\n", grammar); 
    if (priority_known) { 
      TutOut("priority = %d\n", priority); 
    } 
    else { 
      TutOut("priority = unknown\n"); 
    } 
    TutOut("delivery mode = %d\n", delivery_mode); 
    TutOut("user prop = %d\n", user_prop); 
    TutOut("num read cb = %d\n", num_read_cb); 
    TutOut("num write cb = %d\n", num_write_cb); 
    TutOut("num process cb = %d\n", num_process_cb); 
    TutOut("num queue cb = %d\n", num_queue_cb); 
    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_client_msg_type_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcMonClientMsgTypePoll("/...", T_IPC_MON_ALL)) { 
  return; /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_CLIENT_MSG_TYPE_POLL_RESULT); 
if (mt == NULL) { 
  return; /* error */ 
} 
 
if (TipcSrvProcessCbCreate(mt, 
                           process_mon_client_msg_type_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 */ 
}