TipcMonClientGeneralPoll

client_name — name of RTclient to poll for general 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 general information was successfully initiated, FALSE otherwise.

Diagnostics

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

Description

TipcMonClientGeneralPoll polls for RTclient general information by sending a MON_CLIENT_GENERAL_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_GENERAL_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 TipcSrvMsgSearchType or TipcSrvMainLoop to get the response.

a STR field containing the name of the RTclient

a STR field containing the process monitoring identifier (defaults to a major type of license, such as Development_RTmon)

a STR field containing the node name the RTclient is running on

a STR field containing the user name the RTclient is running under

an INT4 field containing the PID of the RTclient

a STR field containing the project the RTclient is a part of

a STR field containing the name of the RTserver the RTclient is connected to

a STR field containing the name of the SmartSockets architecture (such as sun4_solaris)

an INT4 field containing the current operating system sbrk value (the edge of the RTclient’s virtual memory address space)

an INT4 field containing the amount of change in the current operating system sbrk value (the edge of the process’s virtual memory address space) since the RTclient started (actually, since the process’s first call to any SmartSockets function)

an INT2 field containing the integer number format of the RTclient (really of type T_INT_FORMAT, but stored in an INT2 field to save space)

an INT2 field containing the real number format of the RTclient (really of type T_REAL_FORMAT, but stored in an INT2 field to save space)

a STR field containing the fully expanded logical connection name of the connection to RTserver

an INT4_ARRAY field containing the counted licenses that the RTclient has checked out (really an array of type T_LICENSE, but stored in an INT4_ARRAY field for portability)

a STR_ARRAY field containing the extra licenses that the RTclient has checked out (such as snmp)

a STR_ARRAY field containing the names of the subjects that the RTclient is subscribing to

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

For an example of how MON_CLIENT_GENERAL_POLL_RESULT messages can be used, see the RTmon GDI Client Information window.

Caution

TipcMonClientGeneralPoll sends a MON_CLIENT_GENERAL_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 does not exist; the poll is silently dropped.

See Also

Examples

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

/* =============================================================== */ 
/*..process_mon_client_general_poll_result -- process a 
MON_CLIENT_GENERAL_POLL_RESULT message */ 
void T_ENTRY process_mon_client_general_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 ident; 
  T_STR node_name; 
  T_STR user_name; 
  T_INT4 pid; 
  T_STR project; 
  T_STR server_name; 
  T_STR arch; 
  T_INT4 current_sbrk; 
  T_INT4 delta_sbrk; 
  T_INT2 int_format; 
  T_INT2 real_format; 
  T_STR logical_conn_name; 
  T_INT4 *counted_lic; 
  T_INT4 num_counted_lic; 
  T_STR *extra_lic; 
  T_INT4 num_extra_lic; 
  T_STR *subject_subscribe; 
  T_INT4 num_subject_subscribe; 
  T_INT4 counter; /* loop counter */ 
   
  /* 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_STR, &ident, 
                   T_IPC_FT_STR, &node_name, 
                   T_IPC_FT_STR, &user_name, 
                   T_IPC_FT_INT4, &pid, 
                   T_IPC_FT_STR, &project, 
                   T_IPC_FT_STR, &server_name, 
                   T_IPC_FT_STR, &arch, 
                   T_IPC_FT_INT4, &current_sbrk, 
                   T_IPC_FT_INT4, &delta_sbrk, 
                   T_IPC_FT_INT2, &int_format, 
                   T_IPC_FT_INT2, &real_format, 
                   T_IPC_FT_STR, &logical_conn_name, 
                   T_IPC_FT_INT4_ARRAY, &counted_lic,  
                    &num_counted_lic, 
                   T_IPC_FT_STR_ARRAY, &extra_lic, 
                    &num_extra_lic, 
                   T_IPC_FT_STR_ARRAY, &subject_subscribe, 
                    &num_subject_subscribe, 
                   NULL)) { 
    return;  /* error */ 
  }  
 
  TutOut("Got CLIENT_GENERAL poll result.\n"); 
  TutOut("RTclient name = %s\n", client_name); 
  TutOut("ident = %s\n", ident); 
  TutOut("node name = %s\n", node_name); 
  TutOut("user name = %s\n", user_name); 
  TutOut("pid = %d\n", pid); 
  TutOut("project = %s\n", project); 
  TutOut("RTserver name = %s\n", server_name); 
  TutOut("architecture = %s\n", arch); 
  TutOut("current sbrk value = %d\n", current_sbrk); 
  TutOut("delta sbrk value = %d\n", delta_sbrk); 
  TutOut("int format = %d\n", int_format); 
  TutOut("real format = %d\n", real_format); 
  TutOut("logical conn name = %s\n", logical_conn_name); 
  TutOut("counted licenses\n"); 
  for (counter = 0; counter < num_counted_lic; counter++) { 
    TutOut(" %d\n", counted_lic[counter]); 
  } 
  TutOut("extra licenses\n"); 
  for (counter = 0; counter < num_extra_lic; counter++) { 
    TutOut(" %s\n", extra_lic[counter]); 
  } 
  TutOut("subjects being subscribed to\n"); 
  for (counter = 0; counter < num_subject_subscribe; counter++) { 
    TutOut(" %s\n", subject_subscribe[counter]); 
  } 
} /* process_mon_client_general_poll_result */ 
 
/* =========================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcMonClientGeneralPoll("/...")) { 
  return;  /* error */ 
}  
 
mt = TipcMtLookupByNum(T_MT_MON_CLIENT_GENERAL_POLL_RESULT); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (TipcSrvProcessCbCreate(mt, 
                              process_mon_client_general_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 */ 
}