TipcSrvMonClientCpuPoll

Name

TipcSrvMonClientCpuPoll — poll for the percentage of CPU time used by an RTclient

Synopsis

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

Arguments

srv — connection handle to RTserver

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

Diagnostics

If TipcSrvMonClientCpuPoll fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcSrvMonClientCpuPoll polls for the percentage of CPU time used by an RTclient by sending a MON_CLIENT_CPU_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 srv argument indicates the connection on which the poll is to be sent.

The polled RTclient responds by sending back a MON_CLIENT_CPU_POLL_RESULT message. The response may or may not come back quickly, depending on what the polled RTclient is doing. Each MON_CLIENT_CPU_POLL_RESULT contains two fields:

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

If the RTclient cannot query the operating system, the value reported in the CPU percentage used field is a negative number.

Caution

There is no response message if the RTclient named client_name does not exist; the poll is silently dropped.

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

RTclient CPU usage information can only be polled, not watched.

See Also

TipcSrvMonServerCpuPoll

Examples

This example uses TipcSrvMonClientCpuPoll to poll for information in all RTclients, including the RTclient initiating the poll, creates a callback to process the incoming MON_CLIENT_CPU_POLL_RESULT messages, and then waits up to 10 seconds for the poll results:

/* =============================================================== */ 
/*..process_mon_client_cpu_poll_result – process a 
MON_CLIENT_CPU_POLL_RESULT message */ 
 
void process_mon_client_cpu_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_REAL4 cpu_utilization; 
 
  /* 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_REAL4, &cpu_utilization, 
                   NULL)) { 
    return;  /* error */ 
  } 
 
  TutOut("Got CLIENT_CPU poll result.\n"); 
  TutOut("RTclient name = %s\n", client_name); 
  TutOut("CPU utilization percentage = %f\n", cpu_utilization); 
}  /* process_mon_client_cpu_poll_result */ 
 
/* =============================================================== */ 
/*...code from calling function is below */ 
 
T_IPC_MT mt; 
 
/* send the poll request out to RTserver */ 
if (!TipcSrvMonClientCpuPoll(srv, "/...")) { 
  return;  /* error */ 
} 
 
mt = TipcMtLookupByNum(T_MT_MON_CLIENT_CPU_POLL_RESULT); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
if (TipcSrvConnProcessCbCreate(srv, mt,  
                               process_mon_client_cpu_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 */ 
}