Ultra Messaging (UM) message definitions for Persistent Store Daemon Statistics. In particular, the messages defined here are used to monitor the health and operation of the UM Persistent Store. See Store Binary Daemon Statistics for general information on daemon statistics. See Persistence for general information on the Persistent Store. See Fundamental Concepts for an introduction to Ultra Messaging. More...

Data Structures
struct	umestore_dmon_msg_hdr_t_stct
	Common message header structure included at the start of all messages. More...

struct	umestore_store_dmon_config_msg_t_stct
	Message containing unchanging daemon information set at Store daemon startup. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_CONFIG. ) One or more of these will be published for a given daemon, one for each <store> element configured. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_store_pattern_dmon_config_msg_t_stct
	Message containing unchanging Store pattern information set at store daemon startup. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_PATTERN_CONFIG ) One or more of these will be published for a given Store, one for each <topic> configured. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_topic_dmon_config_msg_t_stct
	Message containing topic name of one or more registered sources. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_TOPIC_CONFIG ) Zero or more of these will be published for a given Store, one for each topic that has at least one source registration. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_repo_dmon_config_msg_t_stct
	Message containing repository configuration defined during source registration. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_REPO_CONFIG ) Zero or more of these will be published for a given Store, one for each source which registers with the Store. Many of the fields are not necessarily set to the value configured on the Store, but instead can be overridden by the source. See each option's documentation for details. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_rcv_dmon_config_msg_t_stct
	Message containing repository configuration defined during receiver registration. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_RCV_CONFIG ) Zero or more of these will be published for a given Store, one for each receiver which registers with the Store. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_smart_heap_dmon_stat_msg_t_stct
	Message containing smart heap statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_SMART_HEAP_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_store_dmon_stat_msg_t_stct
	Message containing Store message statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_repo_dmon_stat_msg_t_stct
	Message containing Store repository statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_REPO_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_disk_dmon_stat_msg_t_stct
	Message containing Store disk statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_DISK_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

struct	umestore_rcv_dmon_stat_msg_t_stct
	Message containing Store receiver statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_RCV_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC. More...

Macros
#define	LBM_UMESTORE_DMON_VERSION_STRLEN 256

#define	LBM_UMESTORE_DMON_STORE_NAME_STRLEN 256

#define	LBM_UMESTORE_DMON_TOPIC_PATTERN_STRLEN 256

#define	LBM_UMESTORE_DMON_FILENAME_MAX_STRLEN 256

#define	LBM_UMESTORE_DMON_MPG_SMART_HEAP_STATS 1
	Value of umestore_dmon_msg_hdr_t_stct::type for a memory statistics message of type: umestore_smart_heap_dmon_stat_msg_t.

#define	LBM_UMESTORE_DMON_MPG_STORE_STATS 2
	Value of umestore_dmon_msg_hdr_t_stct::type for a Store statistics message of type: umestore_store_dmon_stat_msg_t.

#define	LBM_UMESTORE_DMON_MPG_REPO_STATS 3
	Value of umestore_dmon_msg_hdr_t_stct::type for a Repository statistics message (associated with a source) of type: umestore_repo_dmon_stat_msg_t.

#define	LBM_UMESTORE_DMON_MPG_DISK_STATS 4
	Value of umestore_dmon_msg_hdr_t_stct::type for a disk statistics message of type: umestore_disk_dmon_stat_msg_t.

#define	LBM_UMESTORE_DMON_MPG_RCV_STATS 5
	Value of umestore_dmon_msg_hdr_t_stct::type for a receiver statistics message of type: umestore_rcv_dmon_stat_msg_t.

#define	LBM_UMESTORE_DMON_MPG_STORE_CONFIG 101
	Value of umestore_dmon_msg_hdr_t_stct::type for a Store configuration message of type: umestore_store_dmon_config_msg_t.

#define	LBM_UMESTORE_DMON_MPG_STORE_PATTERN_CONFIG 102
	Value of umestore_dmon_msg_hdr_t_stct::type for a Store topic pattern message of type: umestore_store_pattern_dmon_config_msg_t.

#define	LBM_UMESTORE_DMON_MPG_STORE_TOPIC_CONFIG 103
	Value of umestore_dmon_msg_hdr_t_stct::type for a Store topic match message of type: umestore_topic_dmon_config_msg_t.

#define	LBM_UMESTORE_DMON_MPG_REPO_CONFIG 104
	Value of umestore_dmon_msg_hdr_t_stct::type for a repository configuration message (associated with a source) of type: umestore_repo_dmon_config_msg_t.

#define	LBM_UMESTORE_DMON_MPG_RCV_CONFIG 105
	Value of umestore_dmon_msg_hdr_t_stct::type for a receiver configuration message of type: umestore_rcv_dmon_config_msg_t.

#define	LBM_UMESTORE_DMON_MAGIC 0x4542
	Value of umestore_dmon_msg_hdr_t_stct::magic indicating that the message does NOT need byte swapping.

#define	LBM_UMESTORE_DMON_ANTIMAGIC 0x4245
	Value of umestore_dmon_msg_hdr_t_stct::magic indicating that the message DOES need byte swapping.

#define	LBM_UMESTORE_DMON_VERSION 1
	Value of umestore_dmon_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	UMESTORE_DMON_MSG_HDR_T_SZ (offsetof(umestore_dmon_msg_hdr_t, tv_usec) + sizeof(lbm_uint32_t))

#define	UMESTORE_STORE_DMON_CONFIG_MSG_T_MIN_SZ (offsetof(umestore_store_dmon_config_msg_t, string_buffer) + 2)

#define	UMESTORE_STORE_PATTERN_DMON_CONFIG_MSG_T_MIN_SZ (offsetof(umestore_store_pattern_dmon_config_msg_t, pattern_buffer) + 2)

#define	UMESTORE_DMON_TOPIC_TYPE_DIRECT 0
	Value for umestore_store_pattern_dmon_config_msg_t_stct::type indicating that the pattern must be an exact match for the desired topic.

#define	UMESTORE_DMON_TOPIC_TYPE_PCRE 1
	Value for umestore_store_pattern_dmon_config_msg_t_stct::type indicating that the pattern is a PCRE-style regular expression to match the desired topics.

#define	UMESTORE_DMON_TOPIC_TYPE_REGEXP 2
	Value for umestore_store_pattern_dmon_config_msg_t_stct::type indicating that the pattern is a POSIX-style regular expression to match the desired topics. This type is deprecated.

#define	UMESTORE_TOPIC_DMON_CONFIG_MSG_T_MIN_SZ (offsetof(umestore_topic_dmon_config_msg_t, topic_name) + 2)

#define	UMESTORE_REPO_DMON_CONFIG_MSG_T_SZ (offsetof(umestore_repo_dmon_config_msg_t, allow_ack_on_reception) + sizeof(lbm_uint8_t))

#define	UMESTORE_DMON_REPO_TYPE_NOCACHE 0
	Value for umestore_repo_dmon_config_msg_t_stct::type indicating a "no-cache" repository.

#define	UMESTORE_DMON_REPO_TYPE_MEMORY 1
	Value for umestore_repo_dmon_config_msg_t_stct::type indicating a "memory" repository.

#define	UMESTORE_DMON_REPO_TYPE_DISK 2
	Value for umestore_repo_dmon_config_msg_t_stct::type indicating a "disk" repository.

#define	UMESTORE_DMON_REPO_DO_NOT_ACK_ON_RECEPTION 0
	Value for umestore_repo_dmon_config_msg_t_stct::allow_ack_on_reception indicating that the Store allows "ack on reception" behavior.

#define	UMESTORE_DMON_REPO_ACK_ON_RECEPTION 1
	Value for umestore_repo_dmon_config_msg_t_stct::allow_ack_on_reception indicating that the Store does not allow "ack on reception" behavior.

#define	UMESTORE_RCV_DMON_CONFIG_MSG_T_SZ (offsetof(umestore_rcv_dmon_config_msg_t, sin_port) + sizeof(lbm_uint16_t))

#define	UMESTORE_SMART_HEAP_DMON_STAT_MSG_T_MIN_SZ (offsetof(umestore_smart_heap_dmon_stat_msg_t, umestored_version_buffer) + 2)

#define	UMESTORE_STORE_DMON_STAT_MSG_T_SZ (offsetof(umestore_store_dmon_stat_msg_t, store_idx) + sizeof(lbm_uint16_t))

#define	UMESTORE_REPO_DMON_STAT_MSG_T_SZ (offsetof(umestore_repo_dmon_stat_msg_t, flags) + sizeof(lbm_uint8_t))

#define	UMESTORE_DMON_REPO_FLAG_INTENTIONAL_DROPS 0x1
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the Store is currently dropping messages due to reaching the repository-size-limit.

#define	UMESTORE_DMON_REPO_FLAG_ISN_SET 0x2
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the repository has an initial sequence number for this source.

#define	UMESTORE_DMON_REPO_FLAG_DISK_CKSUM 0x4
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating if checksumming is enabled. See repository-disk-message-checksum.

#define	UMESTORE_DMON_REPO_FLAG_SHUTTING_DOWN 0x8
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the Store is in the process of shutting down.

#define	UMESTORE_DMON_REPO_FLAG_RPP 0x10
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the repository is of type RPP. See repository-type.

#define	UMESTORE_DMON_REPO_FLAG_DELAY_WRITE 0x20
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the Store delays writes to disk. See repository-disk-write-delay.

#define	UMESTORE_DISK_DMON_STAT_MSG_T_SZ (offsetof(umestore_disk_dmon_stat_msg_t, store_idx) + sizeof(lbm_uint16_t))

#define	UMESTORE_RCV_DMON_STAT_MSG_T_SZ (offsetof(umestore_rcv_dmon_stat_msg_t, flags) + sizeof(lbm_uint16_t))

#define	UMESTORE_DMON_RCV_FLAG_FIRST_ACK 0x1
	Bit for umestore_rcv_dmon_stat_msg_t_stct::flags indicating that the receiver has acked at least one message.

#define	UMESTORE_DMON_RCV_FLAG_OOD 0x2
	Bit for umestore_rcv_dmon_stat_msg_t_stct::flags which is reserved for future use.

#define	UMESTORE_DMON_RCV_FLAG_CAPABILITY_QC 0x4
	Bit for umestore_rcv_dmon_stat_msg_t_stct::flags indicating that the receiver can handle Quorum/Consensus.

#define	UMESTORE_DMON_RCV_FLAG_SHUTTING_DOWN 0x8
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the Store's internal registration for this receiver is in the process of shutting down.

#define	UMESTORE_DMON_RCV_FLAG_DEREGISTERING 0x10
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that this receiver is in the process of deregistering.

#define	UMESTORE_DMON_RCV_FLAG_RPP 0x20
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the receiver is participating in RPP.

#define	UMESTORE_DMON_RCV_FLAG_RPP_IS_NON_BLOCKING 0x40
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the receiver is a non-blocking RPP receiver.

#define	UMESTORE_DMON_RCV_FLAG_KEEPALIVES_DISABLED 0x80
	Bit for umestore_repo_dmon_stat_msg_t_stct::flags indicating that the receiver will generate proactive keepalives and that the Store should not send keepalives.

Typedefs
typedef struct umestore_dmon_msg_hdr_t_stct	umestore_dmon_msg_hdr_t
	Common message header structure included at the start of all messages.

typedef struct umestore_store_dmon_config_msg_t_stct	umestore_store_dmon_config_msg_t
	Message containing unchanging daemon information set at Store daemon startup. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_CONFIG. ) One or more of these will be published for a given daemon, one for each <store> element configured. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_store_pattern_dmon_config_msg_t_stct	umestore_store_pattern_dmon_config_msg_t
	Message containing unchanging Store pattern information set at store daemon startup. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_PATTERN_CONFIG ) One or more of these will be published for a given Store, one for each <topic> configured. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_topic_dmon_config_msg_t_stct	umestore_topic_dmon_config_msg_t
	Message containing topic name of one or more registered sources. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_TOPIC_CONFIG ) Zero or more of these will be published for a given Store, one for each topic that has at least one source registration. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_repo_dmon_config_msg_t_stct	umestore_repo_dmon_config_msg_t
	Message containing repository configuration defined during source registration. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_REPO_CONFIG ) Zero or more of these will be published for a given Store, one for each source which registers with the Store. Many of the fields are not necessarily set to the value configured on the Store, but instead can be overridden by the source. See each option's documentation for details. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_rcv_dmon_config_msg_t_stct	umestore_rcv_dmon_config_msg_t
	Message containing repository configuration defined during receiver registration. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_RCV_CONFIG ) Zero or more of these will be published for a given Store, one for each receiver which registers with the Store. Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_smart_heap_dmon_stat_msg_t_stct	umestore_smart_heap_dmon_stat_msg_t
	Message containing smart heap statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_SMART_HEAP_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_store_dmon_stat_msg_t_stct	umestore_store_dmon_stat_msg_t
	Message containing Store message statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_STORE_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_repo_dmon_stat_msg_t_stct	umestore_repo_dmon_stat_msg_t
	Message containing Store repository statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_REPO_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_disk_dmon_stat_msg_t_stct	umestore_disk_dmon_stat_msg_t
	Message containing Store disk statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_DISK_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

typedef struct umestore_rcv_dmon_stat_msg_t_stct	umestore_rcv_dmon_stat_msg_t
	Message containing Store receiver statistics. ( umestore_dmon_msg_hdr_t_stct::type == LBM_UMESTORE_DMON_MPG_RCV_STATS ) Except where indicated, all fields of type `lbm_uintXX_t` should be byte-swapped if `hdr.magic` is equal to LBM_UMESTORE_DMON_ANTIMAGIC.

Detailed Description

Ultra Messaging (UM) message definitions for Persistent Store Daemon Statistics. In particular, the messages defined here are used to monitor the health and operation of the UM Persistent Store. See Store Binary Daemon Statistics for general information on daemon statistics. See Persistence for general information on the Persistent Store. See Fundamental Concepts for an introduction to Ultra Messaging.

Data Structures

Macros

Typedefs

Detailed Description