Monitoring Functions (TipcMon*)

There are two types of monitoring data that SmartSockets supports when monitoring your distributed application:

In general, two types of monitoring are supported:

Polling Functions (TipcMon*Poll)

The TipcMon*Poll functions are used to do a one-time poll for information about various aspects of a SmartSockets project or to retrieve data generated by an RTclient, referred to as extension data.

TipcMonClientBufferPoll — poll once for RTclient message-related buffer information

T_BOOL TipcMonClientBufferPoll(client_name) 
T_STR client_name; 

TipcMonClientCbPoll — poll once for RTclient callback information

T_BOOL TipcMonClientCbPoll(client_name) 
T_STR client_name; 

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

T_BOOL TipcMonClientCpuPoll(client_name) 
T_STR client_name; 

TipcMonClientExtPoll — poll for extension data of an RTclient

T_BOOL TipcMonClientExtPoll(client_name) 
T_STR client_name; 

TipcMonClientGeneralPoll — poll once for RTclient general information

T_BOOL TipcMonClientGeneralPoll(client_name) 
T_STR client_name; 

TipcMonClientInfoPoll — poll for RTclient information

T_BOOL TipcMonClientInfoPoll(client_name) 
T_STR client_name; 

TipcMonClientMsgTrafficPoll — poll once for RTclient message traffic information

T_BOOL TipcMonClientMsgTrafficPoll(client_name) 
T_STR client_name; 

TipcMonClientMsgTypeExPoll — poll once for RTclient message type information

T_BOOL TipcMonClientMsgTypeExPoll(client_name, msg_type_name) 
T_STR client_name; 
T_STR msg_type_name; 

The previous Ex function supersedes its older counterpart for all new development. Use the following older method only when operating with clients prior to release 6.7.

TipcMonClientMsgTypePoll — poll once for RTclient message type information

T_BOOL TipcMonClientMsgTypePoll(client_name, msg_type_name) 
T_STR client_name; 
T_STR msg_type_name; 

TipcMonClientNamesNumPoll — poll for the number of RTclients in the current project that match the value of the Monitor_Scope option

T_BOOL TipcMonClientNamesNumPoll() 

TipcMonClientNamesPoll — poll once for RTclient names

T_BOOL TipcMonClientNamesPoll() 

TipcMonClientOptionPoll — poll once for RTclient option information

T_BOOL TipcMonClientOptionPoll(client_name, option_name) 
T_STR client_name; 
T_STR option_name; 

TipcMonClientSubjectExPoll — poll once for RTclient subject information

T_BOOL TipcMonClientSubjectExPoll(client_name, subject_name) 
T_STR client_name; 
T_STR subject_name; 

The previous Ex function supersedes its older counterpart for all new development. Use the following older method only when operating with clients prior to release 6.7.

TipcMonClientSubjectPoll — poll once for RTclient subject information

T_BOOL TipcMonClientSubjectPoll(client_name, subject_name) 
T_STR client_name; 
T_STR subject_name; 

TipcMonClientSubscribeNumPoll — poll for the number of subjects subscribed to by an RTclient

T_BOOL TipcMonClientSubscribeNumPoll(client_name) 
T_STR client_name; 

TipcMonClientSubscribePoll — poll once for subjects to which an RTclient subscribes

T_BOOL TipcMonClientSubscribePoll(client_name) 
T_STR client_name;  

TipcMonClientTimePoll — poll once for RTclient time information

T_BOOL TipcMonClientTimePoll(client_name) 
T_STR client_name; 

TipcMonClientVersionPoll — poll once for RTclient version

T_BOOL TipcMonClientVersionPoll(client_name) 
T_STR client_name; 

TipcMonProjectNamesPoll — poll once for project names

T_BOOL TipcMonProjectNamesPoll() 

TipcMonServerBufferPoll — poll once for RTserver message-related buffer information

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

TipcMonServerConnPoll — poll once for RTserver connections

T_BOOL TipcMonServerConnPoll() 

TipcMonServerCpuPoll — poll for the percentage of CPU time used by an RTserver

T_BOOL TipcMonServerCpuPoll(server_name) 
T_STR server_name; 

TipcMonServerGeneralPoll — poll once for RTserver general information

T_BOOL TipcMonServerGeneralPoll(server_name) 
T_STR server_name; 

TipcMonServerMsgTrafficExPoll — poll once for RTserver message traffic information

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

The previous Ex function supersedes its older counterpart for all new development. Use the following older method only when operating with servers prior to release 6.7.

TipcMonServerMsgTrafficPoll — poll once for RTserver message traffic information

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

TipcMonServerNamesPoll — poll once for RTserver names

T_BOOL TipcMonServerNamesPoll() 

TipcMonServerOptionPoll — poll once for RTserver option information

T_BOOL TipcMonServerOptionPoll(server_name, option_name) 
T_STR server_name; 
T_STR option_name; 

TipcMonServerRoutePoll — poll once for RTserver route information

T_BOOL TipcMonServerRoutePoll(server_name, dest_server_name) 
T_STR server_name; 
T_STR dest_server_name; 

TipcMonServerStartTimePoll — poll once for RTserver start time and elapsed time

T_BOOL TipcMonServerStartTimePoll(server_name) 
T_STR server_name; 

TipcMonServerTimePoll — poll once for RTserver time information

T_BOOL TipcMonServerTimePoll(server_name) 
T_STR server_name; 

TipcMonServerVersionPoll — poll once for RTserver version information

T_BOOL TipcMonServerVersionPoll(server_name) 
T_STR server_name; 

TipcMonSubjectNamesPoll — poll once for subject names

T_BOOL TipcMonSubjectNamesPoll() 

TipcMonSubjectSubscribePoll — poll once for RTclients that are subscribing to a subject

T_BOOL TipcMonSubjectSubscribePoll(subject_name) 
T_STR subject_name; 

Watch Functions (TipcMon*Watch)

The TipcMon*Watch functions are used to set up asynchronous notification when specified information in a SmartSockets project changes.

TipcMonClientBufferGetWatch — determine whether this RTclient is watching message-related buffer information in an RTclient

T_BOOL TipcMonClientBufferGetWatch(client_name, watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

TipcMonClientBufferSetWatch — start or stop watching RTclient message-related buffer information

T_BOOL TipcMonClientBufferSetWatch(client_name, watch_status) 
T_STR client_name; 
T_BOOL watch_status; 

TipcMonClientCongestionGetWatch — determine if the RTclient is watching a client's write buffer for congestion

T_BOOL TipcMonClientCongestionGetWatch(client_name, 
watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

TipcMonClientCongestionSetWatch — start or stop watching for congestion in an RTclient’s write buffer

T_BOOL TipcMonClientCongestionSetWatch(client_name, high_water, 
low_water, watch_status) 
T_STR client_name; 
T_INT4 high_water; 
T_INT4 low_water; 
T_BOOL watch_status; 

TipcMonClientMsgRecvGetWatch — determine whether this RTclient is watching received messages in an RTclient

T_BOOL TipcMonClientMsgRecvGetWatch(client_name, msg_type_name, 
watch_status_return) 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL *watch_status_return; 

TipcMonClientMsgRecvSetWatch — start or stop watching RTclient received messages

T_BOOL TipcMonClientMsgRecvSetWatch(client_name, msg_type_name, 
watch_status) 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL watch_status; 

TipcMonClientMsgSendGetWatch — determine whether this RTclient is watching sent messages in an RTclient

T_BOOL TipcMonClientMsgSendGetWatch(client_name, msg_type_name, 
watch_status_return) 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL *watch_status_return; 

TipcMonClientMsgSendSetWatch — start or stop watching RTclient sent messages

T_BOOL TipcMonClientMsgSendSetWatch(client_name, msg_type_name, 
watch_status) 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL watch_status; 

TipcMonClientNamesGetWatch — determine whether this RTclient is watching RTclient names

T_BOOL TipcMonClientNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

TipcMonClientNamesSetWatch — start or stop watching RTclient names

T_BOOL TipcMonClientNamesSetWatch(watch_status) 
T_BOOL watch_status; 

TipcMonClientSubscribeGetWatch — determine whether this RTclient is watching the subjects that an RTclient is subscribing to

T_BOOL TipcMonClientSubscribeGetWatch(client_name, 
watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

TipcMonClientSubscribeSetWatch — start or stop watching the subjects that an RTclient is subscribing to

T_BOOL TipcMonClientSubscribeSetWatch(client_name, watch_status) 
T_STR client_name; 
T_BOOL watch_status; 

TipcMonClientTimeGetWatch — determine whether this RTclient is watching time information in an RTclient

T_BOOL TipcMonClientTimeGetWatch(client_name, watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

TipcMonClientTimeSetWatch — start or stop watching RTclient time information

T_BOOL TipcMonClientTimeSetWatch(client_name, watch_status) 
T_STR client_name; 
T_BOOL watch_status; 

TipcMonPrintWatch — print all monitoring categories being watched

T_BOOL TipcMonPrintWatch(func) 
T_OUT_FUNC func; 

TipcMonProjectNamesGetWatch — determine whether this RTclient is watching project names

T_BOOL TipcMonProjectNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

TipcMonProjectNamesSetWatch — start or stop watching project names

T_BOOL TipcMonProjectNamesSetWatch(watch_status) 
T_BOOL watch_status; 

TipcMonServerCongestionGetWatch — determine if the server is watching for congestion in the RTserver write buffer of a connected process

T_BOOL TipcMonServerCongestionGetWatch(server_name, 
connected_process_name, watch_status_return) 
T_STR server_name; 
T_STR connected_process_name; 
T_BOOL *watch_status_return; 

TipcMonServerCongestionSetWatch — start or stop watching for congestion in the RTserver write buffer of a connected process

T_BOOL TipcMonServerCongestionSetWatch(server_name, 
connected_process_name, high_water, low_water, watch_status) 
T_STR server_name; 
T_STR connected_process_name; 
T_INT4 high_water; 
T_INT4 low_water; 
T_BOOL watch_status; 

TipcMonServerConnGetWatch — determine whether this RTclient is watching RTserver connections

T_BOOL TipcMonServerConnGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

TipcMonServerConnSetWatch — start or stop watching RTserver connections

T_BOOL TipcMonServerConnSetWatch(watch_status) 
T_BOOL watch_status; 

TipcMonServerMaxClientLicensesGetWatch — determine if the RTserver is watching for the server cloud to exceed the licensed number of RTclient connections

T_BOOL TipcMonServerMaxClientLicensesGetWatch(server_name, 
watch_status_return) 
T_STR server_name; 
T_BOOL *watch_status_return; 

TipcMonServerMaxClientLicensesSetWatch — start or stop watching for a server to exceed the licensed number of RTclient connections

T_BOOL TipcMonServerMaxClientLicensesSetWatch(server_name, 
watch_status) 
T_STR server_name; 
T_BOOL watch_status; 

TipcMonServerNamesGetWatch — determine whether this RTclient is watching RTserver names

T_BOOL TipcMonServerNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

TipcMonServerNamesSetWatch — start or stop watching RTserver names

T_BOOL TipcMonServerNamesSetWatch(watch_status) 
T_BOOL watch_status; 

TipcMonSubjectNamesGetWatch — determine whether this RTclient is watching subject names

T_BOOL TipcMonSubjectNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return; 

TipcMonSubjectNamesSetWatch — start or stop watching subject names

T_BOOL TipcMonSubjectNamesSetWatch(watch_status) 
T_BOOL watch_status; 

TipcMonSubjectSubscribeGetWatch — determine whether this RTclient is watching the RTclients that are subscribing to a subject

T_BOOL TipcMonSubjectSubscribeGetWatch(subject_name, 
watch_status_return) 
T_STR subject_name; 
T_BOOL *watch_status_return; 

TipcMonSubjectSubscribeSetWatch — start or stop watching the RTclients that are subscribing to a subject

T_BOOL TipcMonSubjectSubscribeSetWatch(subject_name, watch_status) 
T_STR subject_name; 
T_BOOL watch_status; 

Extension Data Functions (TipcMonExt*)

The TipcMonExt* functions are used to delete, define, or update a field in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message. This message is returned to another RTclient that polls for RTclient information by issuing TipcMonClientExtPoll.

TipcMonExtDelete — remove a field from an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtDelete(field_name) 
T_STR field_name; 

TipcMonExtSetBinary — add or update a field of type BINARY in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetBinary(field_name, data, size) 
T_STR field_name; 
T_PTR data; 
T_INT4 size; 

TipcMonExtSetBool — add or update a field of type BOOL in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetBool(field_name, data) 
T_STR field_name; 
T_BOOL data; 

TipcMonExtSetBoolArray — add or update a field containing an array of type BOOL in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetBoolArray(field_name, data, size) 
T_STR field_name; 
T_BOOL *data; 
T_INT4 size; 

TipcMonExtSetInt2 — add or update a field of type INT2 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt2(field_name, data) 
T_STR field_name; 
T_INT2 data; 

TipcMonExtSetInt2Array — add or update a field containing an array of type INT2 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt2Array(field_name, data, size) 
T_STR field_name; 
T_INT2 *data; 
T_INT4 size 

TipcMonExtSetInt4 — add or update a field of type INT4 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt4(field_name, data) 
T_STR field_name; 
T_INT4 data; 

TipcMonExtSetInt4Array — add or update a field containing an array of type INT4 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt4Array(field_name, data, size) 
T_STR field_name; 
T_INT4 *data;  
T_INT4 size; 

TipcMonExtSetInt8 — add or update a field of type INT8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt8(field_name, data) 
T_STR field_name; 
T_INT8 data; 

TipcMonExtSetInt8Array — add or update a field containing an array of type INT8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetInt8Array(field_name, data, size) 
T_STR field_name; 
T_INT8 *data;  
T_INT4 size; 

TipcMonExtSetReal4 — add or update a field of type REAL4 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal4(field_name, data) 
T_STR field_name; 
T_REAL4 data; 

TipcMonExtSetReal4Array — add or update a field containing an array of type REAL4 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal4Array(field_name, data, size) 
T_STR field_name; 
T_REAL4 *data; 
T_INT4 size; 

TipcMonExtSetReal8 — add or update a field of type REAL8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal8(field_name, data) 
T_STR field_name; 
T_REAL8 data; 

TipcMonExtSetReal8Array — add or update a field containing an array of type REAL8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal8Array(field_name, data, size) 
T_STR field_name; 
T_REAL8 *data; 
T_INT4 size; 

TipcMonExtSetReal16 — add or update a field of type REAL16 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal16(field_name, data) 
T_STR field_name; 
T_REAL16 data; 

TipcMonExtSetReal16Array — add or update a field containing an array of type REAL16 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetReal16Array(field_name, data, size) 
T_STR field_name;  
T_REAL16 *data; 
T_INT4 size; 

TipcMonExtSetStr — add or update a field of type STR in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetStr(field_name, data) 
T_STR field_name; 
T_STR data; 

TipcMonExtSetStArray — add or update a field containing an array of type STR in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetStrArray(field_name, data, size) 
T_STR field_name; 
T_STR *data; 
T_INT4 size; 

TipcMonExtSetUtf8 — add or update a field of type UTF8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetUtf8(field_name, data) 
T_STR field_name; 
T_UTF8 data; 

TipcMonExtSetUtf8Array — add or update a field containing an array of type UTF8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

T_BOOL TipcMonExtSetUtf8Array(field_name, data, size) 
T_STR field_name; 
T_UTF8 *data; 
T_INT4 size; 

Miscellaneous Functions

These functions do not fit with any of the other established categories:

TipcMonGetIdentStr — retrieve the monitoring identification string of this process

T_BOOL TipcMonGetIdentStr(ident_str_return) 
T_STR *ident_str_return; 

TipcMonSetIdentStr — set the monitoring identification string of this process

T_BOOL TipcMonSetIdentStr(ident_str) 
T_STR ident_str;