tnwgdmonmsgs.h File Reference

Ultra Messaging (UM) message definitions for DRO Daemon Statistics. The "tnwgdmonmsgs.h" header file defines message structures for use by applications that monitor the operation of a UM network. In particular, the messages defined here are used to monitor the health and operation of the UM Dynamic Router (DRO). See Store Binary Daemon Statistics for general information on daemon statistics. See DRO for general information on the DRO. See Fundamental Concepts for an introduction to Ultra Messaging. More...

Go to the source code of this file.

Data Structures
struct	tnwg_dstat_msg_hdr_t_stct
	Common message header structure included at the start of all messages. Used by tnwg_dstat_mallinfo_msg_t, tnwg_dstat_portalstats_msg_t, tnwg_dstat_gatewaycfg_msg_t tnwg_pcfg_stat_grp_msg_t, tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_mallinfo_stat_grp_record_t_stct
	Structure containing memory statistics. Used by tnwg_dstat_mallinfo_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_mallinfo_msg_t_stct
	Message containing memory allocation statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_MALLINFO ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_endpoint_receive_stats_t_stct
	Structure containing receiving statistics for an endpoint portal. Used by tnwg_portal_endpoint_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_endpoint_send_stats_t_stct
	Structure containing sending statistics for an endpoint portal. Used by tnwg_portal_endpoint_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_peer_receive_stats_t_stct
	Structure containing receiving statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_peer_send_stats_t_stct
	Structure containing sending statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_peer_udp_receive_stats_t_stct
	Structure containing Receive UDP statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_peer_udp_send_stats_t_stct
	Structure containing Send UDP statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_portal_endpoint_dstat_record_t_stct
	Structure containing sending and receiving statistics for an endpoint portal. Used by tnwg_portalstats_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_portal_peer_dstat_record_t_stct
	Structure containing sending and receiving statistics for a peer portal. More...
struct	tnwg_portalstats_dstat_record_t_stct
	Structure containing sending and receiving statistics for peer or endpoint portal. Used by tnwg_dstat_portalstats_msg_t. The full length of this structure is defined by the longest of its union elements. However, when messages are sent, the actual size of the selected union element is used. That size is recorded in tnwg_dstat_record_hdr_t_stct::record_length. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_record_hdr_t_stct
	Structure containing general information about a peer or endpoint portal. Used by tnwg_dstat_portalstats_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_portalstats_msg_t_stct
	Message containing portal statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_PORTSTAT ) This message can have different lengths, depending on which element of the union tnwg_portalstats_dstat_record_t_stct::ptype is selected, based on the value of tnwg_dstat_record_hdr_t_stct::portal_type. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_dstat_gatewaycfg_msg_t_stct
	Message containing DRO configuration information. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_GATEWAYCFG ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_pcfg_stat_grp_rec_hdr_t_stct
	Structure containing portal configuration information. Used by tnwg_pcfg_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_pcfg_stat_grp_msg_t_stct
	Message containing memory allocation statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_PORTCFG ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_rm_stat_grp_local_info_t_stct
	Structure containing high-level information about this UM Router's (DRO) view of the current topology. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_rm_stat_grp_portal_info_t_stct
	Structure containing routing information specific to a particular portal. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_rm_stat_grp_othergw_info_t_stct
	Each UM Router (DRO) tracks a small amount of information about every other DRO in the network. This structure represents this DRO's view of a remote DRO's tnwg_rm_stat_grp_local_info_t. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_rm_stat_grp_othergw_neighbor_t_stct
	Structure containing this UM Router's (DRO) view of a remote DRO's portal information. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...
struct	tnwg_rm_stat_grp_msg_t_stct
	Message containing routing information. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_RM_LOCAL,   TNWG_DSTATTYPE_RM_PORTAL, TNWG_DSTATTYPE_RM_OTHERGW,   TNWG_DSTATTYPE_RM_OTHERGW_NBR ) This message can have different lengths, depending on which element of the union msgtype is selected, based on the message type in tnwg_dstat_msg_hdr_t_stct::type. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC. More...

Macros
#define	LBM_TNWG_DMON_VERSION   1
	Value of tnwg_dstat_msg_hdr_t_stct::version indicating the version of the monitoring daemon. See Daemon Statistics Versioning for general information on versioning of these structures.
#define	TNWG_DSTAT_FILENAME_MAX_STRLEN   256
#define	TNWG_DSTAT_MAX_PORTAL_NAME_LEN   256
#define	TNWG_DSTAT_MAX_GATEWAY_NAME_LEN   256
#define	TNWG_DSTATTYPE_INVALID   0
	For internal use only.
#define	TNWG_DSTATTYPE_RM   1
	For internal use only.
#define	TNWG_DSTATTYPE_RM_LOCAL   2
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Local Route Information message, of type: tnwg_rm_stat_grp_msg_t. For this message type, the union field tnwg_rm_stat_grp_msg_t_stct::msgtype.local should be used.
#define	TNWG_DSTATTYPE_RM_PORTAL   3
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Portal Route Information message, of type: tnwg_rm_stat_grp_msg_t. For this message type, the union field tnwg_rm_stat_grp_msg_t_stct::msgtype.portal should be used.
#define	TNWG_DSTATTYPE_RM_OTHERGW   4
	Value of tnwg_dstat_msg_hdr_t_stct::type for an Other DRO Route Information message, of type: tnwg_rm_stat_grp_msg_t. For this message type, the union field tnwg_rm_stat_grp_msg_t_stct::msgtype.othergw should be used.
#define	TNWG_DSTATTYPE_RM_OTHERGW_NBR   5
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Neighbor DRO Route Information message, of type: tnwg_rm_stat_grp_msg_t. For this message type, the union field tnwg_rm_stat_grp_msg_t_stct::msgtype.neighbor should be used.
#define	TNWG_DSTATTYPE_PORTSTAT   6
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Portal Statistics message, of type: tnwg_dstat_portalstats_msg_t.
#define	TNWG_DSTATTYPE_GATEWAYCFG   7
	Value of tnwg_dstat_msg_hdr_t_stct::type for a DRO Configuration message, of type: tnwg_dstat_gatewaycfg_msg_t.
#define	TNWG_DSTATTYPE_PORTCFG   8
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Portal Configuration message, of type: tnwg_pcfg_stat_grp_msg_t.
#define	TNWG_DSTATTYPE_MALLINFO   9
	Value of tnwg_dstat_msg_hdr_t_stct::type for a Memory Allocation Statistics message, of type: tnwg_dstat_mallinfo_msg_t.
#define	LBM_TNWG_DAEMON_MAGIC   0x4542
	Value of tnwg_dstat_msg_hdr_t_stct::magic indicating that the message does NOT need byte swapping.
#define	LBM_TNWG_DAEMON_ANTIMAGIC   0x4245
	Value of tnwg_dstat_msg_hdr_t_stct::magic indicating that the message DOES need byte swapping.
#define	TNWG_DSTAT_Portal_Type_Endpoint   0
	Value of tnwg_dstat_record_hdr_t_stct::portal_type and tnwg_pcfg_stat_grp_rec_hdr_t_stct::portal_type for endpoint portals.
#define	TNWG_DSTAT_Portal_Type_Peer   1
	Value of tnwg_dstat_record_hdr_t_stct::portal_type and tnwg_pcfg_stat_grp_rec_hdr_t_stct::portal_type for peer portals.
#define	TNWG_DSTAT_Domain_Type   0
	value of tnwg_rm_stat_grp_othergw_neighbor_t::domain_or_gateway for domain-type neighbor route information.
#define	TNWG_DSTAT_Gateway_Type   1
	value of tnwg_rm_stat_grp_othergw_neighbor_t::domain_or_gateway for DRO-type neighbor route information.
#define	MAX_ATTR_TYPE_NAME_LEN   64

Typedefs
typedef struct tnwg_dstat_msg_hdr_t_stct	tnwg_dstat_msg_hdr_t
	Common message header structure included at the start of all messages. Used by tnwg_dstat_mallinfo_msg_t, tnwg_dstat_portalstats_msg_t, tnwg_dstat_gatewaycfg_msg_t tnwg_pcfg_stat_grp_msg_t, tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_mallinfo_stat_grp_record_t_stct	tnwg_mallinfo_stat_grp_record_t
	Structure containing memory statistics. Used by tnwg_dstat_mallinfo_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_mallinfo_msg_t_stct	tnwg_dstat_mallinfo_msg_t
	Message containing memory allocation statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_MALLINFO ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_endpoint_receive_stats_t_stct	tnwg_dstat_endpoint_receive_stats_t
	Structure containing receiving statistics for an endpoint portal. Used by tnwg_portal_endpoint_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_endpoint_send_stats_t_stct	tnwg_dstat_endpoint_send_stats_t
	Structure containing sending statistics for an endpoint portal. Used by tnwg_portal_endpoint_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_peer_receive_stats_t_stct	tnwg_dstat_peer_receive_stats_t
	Structure containing receiving statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_peer_send_stats_t_stct	tnwg_dstat_peer_send_stats_t
	Structure containing sending statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_peer_udp_receive_stats_t_stct	tnwg_dstat_peer_udp_receive_stats_t
	Structure containing Receive UDP statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_peer_udp_send_stats_t_stct	tnwg_dstat_peer_udp_send_stats_t
	Structure containing Send UDP statistics for a peer portal. Used by tnwg_portal_peer_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_portal_endpoint_dstat_record_t_stct	tnwg_portal_endpoint_dstat_record_t
	Structure containing sending and receiving statistics for an endpoint portal. Used by tnwg_portalstats_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_portal_peer_dstat_record_t_stct	tnwg_portal_peer_dstat_record_t
	Structure containing sending and receiving statistics for a peer portal. More...
typedef struct tnwg_portalstats_dstat_record_t_stct	tnwg_portalstats_dstat_record_t
	Structure containing sending and receiving statistics for peer or endpoint portal. Used by tnwg_dstat_portalstats_msg_t. The full length of this structure is defined by the longest of its union elements. However, when messages are sent, the actual size of the selected union element is used. That size is recorded in tnwg_dstat_record_hdr_t_stct::record_length. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_record_hdr_t_stct	tnwg_dstat_record_hdr_t
	Structure containing general information about a peer or endpoint portal. Used by tnwg_dstat_portalstats_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_portalstats_msg_t_stct	tnwg_dstat_portalstats_msg_t
	Message containing portal statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_PORTSTAT ) This message can have different lengths, depending on which element of the union tnwg_portalstats_dstat_record_t_stct::ptype is selected, based on the value of tnwg_dstat_record_hdr_t_stct::portal_type. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_dstat_gatewaycfg_msg_t_stct	tnwg_dstat_gatewaycfg_msg_t
	Message containing DRO configuration information. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_GATEWAYCFG ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_pcfg_stat_grp_rec_hdr_t_stct	tnwg_pcfg_stat_grp_rec_hdr_t
	Structure containing portal configuration information. Used by tnwg_pcfg_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_pcfg_stat_grp_msg_t_stct	tnwg_pcfg_stat_grp_msg_t
	Message containing memory allocation statistics. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_PORTCFG ) Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_rm_stat_grp_local_info_t_stct	tnwg_rm_stat_grp_local_info_t
	Structure containing high-level information about this UM Router's (DRO) view of the current topology. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_rm_stat_grp_portal_info_t_stct	tnwg_rm_stat_grp_portal_info_t
	Structure containing routing information specific to a particular portal. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_rm_stat_grp_othergw_info_t_stct	tnwg_rm_stat_grp_othergw_info_t
	Each UM Router (DRO) tracks a small amount of information about every other DRO in the network. This structure represents this DRO's view of a remote DRO's tnwg_rm_stat_grp_local_info_t. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_rm_stat_grp_othergw_neighbor_t_stct	tnwg_rm_stat_grp_othergw_neighbor_t
	Structure containing this UM Router's (DRO) view of a remote DRO's portal information. Used by tnwg_rm_stat_grp_msg_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.
typedef struct tnwg_rm_stat_grp_msg_t_stct	tnwg_rm_stat_grp_msg_t
	Message containing routing information. ( tnwg_dstat_msg_hdr_t_stct::type == TNWG_DSTATTYPE_RM_LOCAL,   TNWG_DSTATTYPE_RM_PORTAL, TNWG_DSTATTYPE_RM_OTHERGW,   TNWG_DSTATTYPE_RM_OTHERGW_NBR ) This message can have different lengths, depending on which element of the union msgtype is selected, based on the message type in tnwg_dstat_msg_hdr_t_stct::type. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.

Detailed Description

Ultra Messaging (UM) message definitions for DRO Daemon Statistics. The "tnwgdmonmsgs.h" header file defines message structures for use by applications that monitor the operation of a UM network. In particular, the messages defined here are used to monitor the health and operation of the UM Dynamic Router (DRO). See Store Binary Daemon Statistics for general information on daemon statistics. See DRO for general information on the DRO. See Fundamental Concepts for an introduction to Ultra Messaging.

Typedef Documentation

typedef struct tnwg_portal_peer_dstat_record_t_stct tnwg_portal_peer_dstat_record_t

Structure containing sending and receiving statistics for a peer portal.

Used by tnwg_portalstats_dstat_record_t. Except where indicated, all fields of type lbm_uintXX_t should be byte-swapped if hdr.magic is equal to LBM_TNWG_DAEMON_ANTIMAGIC.

Note that fields remote_interest_topics, remote_interest_pcre_patterns, and remote_interest_regex_patterns are not used by peer portals, and are set to zero.