TipcSrvMonClientBufferPoll

TipcSrvMonClientBufferPoll — poll once for RTclient message-related buffer information

Synopsis

T_BOOL TipcSrvMonClientBufferPoll(srv, client_name) 
T_IPC_SRV srv; 
T_STR client_name;

Arguments

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

Return Values

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

Diagnostics

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

Description

TipcSrvMonClientBufferPoll polls for RTclient message-related buffer information by sending a MON_CLIENT_BUFFER_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_BUFFER_POLL_RESULT message. The response may or may not come back quickly, depending on what the polled RTclient is doing. The polling RTclient can use functions such as TipcSrvConnMsgSearchType or TipcSrvConnMainLoop to get the response.

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

Caution

TipcSrvMonClientBufferPoll sends a MON_CLIENT_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 RTclient named client_name does not exist; the poll is silently dropped.

See Also

Examples

This example uses TipcSrvMonClientBufferPoll to poll for buffer information in all RTclients (including this one), creates a callback to process the incoming MON_CLIENT_BUFFER_POLL_RESULT messages, and then waits up to 10 seconds for the poll results:

/* =============================================================== */ 
/*..process_mon_client_buffer_poll_result -- process a MON_CLIENT_BUFFER_POLL_RESULT 
message */ 
void T_ENTRY process_mon_client_buffer_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_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 the fields from the message */ 
  if (!TipcMsgRead(data->msg,  
                   T_IPC_FT_STR, &client_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)) { 
    return;  /* error */ 
  }  
 
  TutOut("Got CLIENT_BUFFER poll result.\n"); 
  TutOut("RTclient name = %s\n", client_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); 
} /* process_mon_client_buffer_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcSrvMonClientBufferPoll(srv, "/...")) { 
  return;  /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_CLIENT_BUFFER_POLL_RESULT); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (TipcSrvConnProcessCbCreate(srv, mt,  
                               process_mon_client_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 */ 
}