Multiple Connection Monitoring Functions (TipcSrvMon*)

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

In general, two types of monitoring are supported:

Polling Functions (TipcSrvMon*Poll)

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

TipcSrvMonClientBufferPoll — poll once for RTclient message-related buffer information 

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

TipcSrvMonClientCbPoll — poll once for RTclient callback information 

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

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

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

TipcSrvMonClientExtPoll — poll for extension data of an RTclient 

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

TipcSrvMonClientGeneralPoll — poll once for RTclient general information 

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

TipcSrvMonClientInfoPoll — poll for RTclient information 

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

TipcSrvMonClientMsgTrafficPoll — poll once for RTclient message traffic information 

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

TipcSrvMonClientMsgTypeExPoll — poll once for RTclient message type information 

T_BOOL TipcSrvMonClientMsgTypeExPoll(srv, client_name, 
msg_type_name) 
T_IPC_SRV srv; 
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.

TipcSrvMonClientMsgTypePoll — poll once for RTclient message type information 

T_BOOL TipcSrvMonClientMsgTypePoll(srv, client_name, 
msg_type_name) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR msg_type_name;

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

T_BOOL TipcSrvMonClientNamesNumPoll(srv) 
T_IPC_SRV srv;

TipcSrvMonClientNamesPoll — poll once for RTclient names 

T_BOOL TipcSrvMonClientNamesPoll(srv) 
T_IPC_SRV srv;

TipcSrvMonClientOptionPoll — poll once for RTclient option information 

T_BOOL TipcSrvMonClientOptionPoll(srv, client_name, option_name) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR option_name;

TipcSrvMonClientSubjectExPoll — poll once for RTclient subject information 

T_BOOL TipcSrvMonClientSubjectExPoll(srv, client_name, 
subject_name) 
T_IPC_SRV srv; 
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.

TipcSrvMonClientSubjectPoll — poll once for RTclient subject information 

T_BOOL TipcSrvMonClientSubjectPoll(srv, client_name, subject_name) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR subject_name;

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

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

TipcSrvMonClientSubscribePoll — poll once for subjects to which an RTclient subscribes 

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

TipcSrvMonClientTimePoll — poll once for RTclient time information 

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

TipcSrvMonClientVersionPoll — poll once for RTclient version information 

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

TipcSrvMonProjectNamesPoll — poll once for project names 

T_BOOL TipcSrvMonProjectNamesPoll(srv) 
T_IPC_SRV srv;

TipcSrvMonServerBufferPoll — poll once for RTserver message-related buffer information 

T_BOOL TipcSrvMonServerBufferPoll(srv, server_name, 
connected_process_name) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name;

TipcSrvMonServerConnPoll — poll once for RTserver connections 

T_BOOL TipcSrvMonServerConnPoll(srv) 
T_IPC_SRV srv;

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

T_BOOL TipcSrvMonServerCpuPoll(srv, server_name) 
T_IPC_SRV srv; 
T_STR server_name;

TipcSrvMonServerGeneralPoll — poll once for RTserver general information 

T_BOOL TipcSrvMonServerGeneralPoll(srv, server_name) 
T_IPC_SRV srv; 
T_STR server_name;

TipcSrvMonServerMsgTrafficExPoll — poll once for RTserver message traffic information 

T_BOOL TipcSrvMonServerMsgTrafficExPoll(srv, server_name, 
connected_process_name) 
T_IPC_SRV srv; 
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.

TipcSrvMonServerMsgTrafficPoll — poll once for RTserver message traffic information 

T_BOOL TipcSrvMonServerMsgTrafficPoll(srv, server_name, 
connected_process_name) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name;

TipcSrvMonServerNamesPoll — poll once for RTserver names 

T_BOOL TipcSrvMonServerNamesPoll(srv) 
T_IPC_SRV srv;

TipcSrvMonServerOptionPoll — poll once for RTserver option information 

T_BOOL TipcSrvMonServerOptionPoll(srv, server_name, option_name) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR option_name;

TipcSrvMonServerRoutePoll — poll once for RTserver route information 

T_BOOL TipcSrvMonServerRoutePoll(srv, server_name, dest_server_name) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR dest_server_name;

TipcSrvMonServerStartTimePoll — poll once for RTserver start time and elapsed time 

T_BOOL TipcSrvMonServerStartTimePoll(srv, server_name) 
T_IPC_SRV srv; 
T_STR server_name;

TipcSrvMonServerTimePoll — poll once for RTserver time information 

T_BOOL TipcSrvMonServerTimePoll(srv, server_name) 
T_IPC_SRV srv; 
T_STR server_name;

TipcSrvMonServerVersionPoll — poll once for RTserver version information 

T_BOOL TipcSrvMonServerVersionPoll(srv, server_name) 
T_IPC_SRV srv; 
T_STR server_name;

TipcSrvMonSubjectNamesPoll — poll once for subject names 

T_BOOL TipcSrvMonSubjectNamesPoll(srv) 
T_IPC_SRV srv;

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

T_BOOL TipcSrvMonSubjectSubscribePoll(srv, subject_name) 
T_IPC_SRV srv; 
T_STR subject_name;

Watch Functions (TipcSrvMon*Watch)

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

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

T_BOOL TipcSrvMonClientBufferGetWatch(srv, client_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonClientBufferSetWatch(srv, client_name, 
watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonClientCongestionGetWatch(srv, client_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonClientCongestionSetWatch(srv, client_name, 
high_water, low_water, watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_INT4 high_water; 
T_INT4 low_water; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonClientMsgRecvGetWatch(srv, client_name, 
msg_type_name, watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL *watch_status_return;

TipcSrvMonClientMsgRecvSetWatch — start or stop watching RTclient received messages 

T_BOOL TipcSrvMonClientMsgRecvSetWatch(srv, client_name, 
msg_type_name, watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonClientMsgSendGetWatch(srv, client_name, 
msg_type_name, watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL *watch_status_return;

TipcSrvMonClientMsgSendSetWatch — start or stop watching RTclient sent messages 

T_BOOL TipcSrvMonClientMsgSendSetWatch(srv, client_name, 
msg_type_name, watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_STR msg_type_name; 
T_BOOL watch_status;

TipcSrvMonClientNamesGetWatch — determine whether this RTclient is watching RTclient names 

T_BOOL TipcSrvMonClientNamesGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return;

TipcSrvMonClientNamesSetWatch — start or stop watching RTclient names 

T_BOOL TipcSrvMonClientNamesSetWatch(srv, watch_status) 
T_IPC_SRV srv; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonClientSubscribeGetWatch(srv, client_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonClientSubscribeSetWatch(srv, client_name, 
watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonClientTimeGetWatch(srv, client_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL *watch_status_return;

TipcSrvMonClientTimeSetWatch — start or stop watching RTclient time information 

T_BOOL TipcSrvMonClientTimeSetWatch(srv, client_name, watch_status) 
T_IPC_SRV srv; 
T_STR client_name; 
T_BOOL watch_status;

TipcSrvMonPrintWatch — print all monitoring categories being watched 

T_BOOL TipcSrvMonPrintWatch(srv, func) 
T_IPC_SRV srv; 
T_OUT_FUNC func;

TipcSrvMonProjectNamesGetWatch — determine whether this RTclient is watching project names 

T_BOOL TipcSrvMonProjectNamesGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return;

TipcSrvMonProjectNamesSetWatch — start or stop watching project names 

T_BOOL TipcSrvMonProjectNamesSetWatch(srv, watch_status) 
T_IPC_SRV srv; 
T_BOOL watch_status;

TipcSrvMonServerCongestionGetWatch — determine if the server is watching a process’s write buffer for congestion 

T_BOOL TipcSrvMonServerCongestionGetWatch(srv, server_name, 
connected_process_name, watch_status_return) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonServerCongestionSetWatch(srv, server_name, 
connected_process_name, high_water, low_water, watch_status) 
T_IPC_SRV srv; 
T_STR server_name; 
T_STR connected_process_name; 
T_INT4 high_water; 
T_INT4 low_water; 
T_BOOL watch_status;

TipcSrvMonServerConnGetWatch — determine whether this RTclient is watching RTserver connections 

T_BOOL TipcSrvMonServerConnGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return;

TipcSrvMonServerConnSetWatch — start or stop watching RTserver connections 

T_BOOL TipcSrvMonServerConnSetWatch(srv, watch_status) 
T_IPC_SRV srv; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonServerMaxClientLicensesGetWatch(srv, 
server_name, watch_status_return) 
T_IPC_SRV srv; 
T_STR server_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonServerMaxClientLicensesSetWatch(srv, 
server_name, watch_status) 
T_IPC_SRV srv; 
T_STR server_name; 
T_BOOL watch_status;

TipcSrvMonServerNamesGetWatch — determine whether this RTclient is watching RTserver names 

T_BOOL TipcSrvMonServerNamesGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return;

TipcSrvMonServerNamesSetWatch — start or stop watching RTserver names 

T_BOOL TipcSrvMonServerNamesSetWatch(srv, watch_status) 
T_IPC_SRV srv; 
T_BOOL watch_status;

TipcSrvMonSubjectNamesGetWatch — determine whether this RTclient is watching subject names 

T_BOOL TipcSrvMonSubjectNamesGetWatch(srv, watch_status_return) 
T_IPC_SRV srv; 
T_BOOL *watch_status_return;

TipcSrvMonSubjectNamesSetWatch — start or stop watching subject names 

T_BOOL TipcSrvMonSubjectNamesSetWatch(srv, watch_status) 
T_IPC_SRV srv; 
T_BOOL watch_status;

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

T_BOOL TipcSrvMonSubjectSubscribeGetWatch(srv, subject_name, 
watch_status_return) 
T_IPC_SRV srv; 
T_STR subject_name; 
T_BOOL *watch_status_return;

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

T_BOOL TipcSrvMonSubjectSubscribeSetWatch(srv, subject_name, 
watch_status) 
T_IPC_SRV srv; 
T_STR subject_name; 
T_BOOL watch_status;

Extension Data Functions (TipcSrvMonExt*)

The TipcSrvMonExt* 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 TipcSrvMonClientExtPoll.

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

T_BOOL TipcSrvMonExtDelete(srv, field_name) 
T_IPC_SRV srv; 
T_STR field_name;

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

T_BOOL TipcSrvMonExtSetBinary(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_PTR data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetBool(srv, field_name, data) 
T_IPC_SRV srv; 
T_BOOL field_name; 
T_PTR data;

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

T_BOOL TipcSrvMonExtSetBoolArray(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_BOOL *data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetInt2(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT2 data;

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

T_BOOL TipcSrvMonExtSetInt2Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT2 *data; 
T_INT4 size

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

T_BOOL TipcSrvMonExtSetInt4(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT4 data;

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

T_BOOL TipcSrvMonExtSetInt4Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT4 *data;  
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetInt8(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT8 data;

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

T_BOOL TipcSrvMonExtSetInt8Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_INT8 *data;  
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetReal4(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_REAL4 data;

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

T_BOOL TipcSrvMonExtSetReal4Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_REAL4 *data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetReal8(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_REAL8 data;

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

T_BOOL TipcSrvMonExtSetReal8Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_REAL8 *data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetReal16(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_REAL16 data;

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

T_BOOL TipcSrvMonExtSetReal16Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name;  
T_REAL16 *data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetStr(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_STR data;

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

T_BOOL TipcSrvMonExtSetStrArray(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_STR *data; 
T_INT4 size;

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

T_BOOL TipcSrvMonExtSetUtf8(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_UTF8 data;

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

T_BOOL TipcSrvMonExtSetUtf8Array(srv, field_name, data, size) 
T_IPC_SRV srv; 
T_STR field_name; 
T_UTF8 *data; 
T_INT4 size;

Miscellaneous Functions

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

TipcSrvMonGetIdentStr — retrieve the monitoring identification string of this process 

T_BOOL TipcSrvMonGetIdentStr(srv, ident_str_return) 
T_IPC_SRV srv; 
T_STR *ident_str_return;

TipcSrvMonSetIdentStr — set the monitoring identification string of this process 

T_BOOL TipcSrvMonSetIdentStr(srv, ident_str) 
T_IPC_SRV srv; 
T_STR ident_str;
TIBCO SmartSockets™ API Quick Reference
Software Release 6.8, July 2006
Copyright © TIBCO Software Inc. All rights reserved
www.tibco.com