The interval between checks by UMP of consumed, unacknowledged messages. See also ume_use_ack_batching.
Establishes the period of time from a receiver's last activity to the release of the receiver's Reg ID. Stores return an error to any new request for the receiver's Reg ID during this period. Overrides the receiver-activity-timeout setting configured for the receiver's topic on the store. The default value of 0 (zero) disables this option. See also Proxy Sources.
Establishes the period of time from a source's last activity to the release of the source's Reg ID. Stores return an error to any new source requesting the source's Reg ID during this period. If proxy sources are enabled (ume_proxy_source), the store does not release the source's Reg ID and UMP elects a proxy source. Overrides the source-activity-timeout setting configured for the source's topic on the store. The default value of 0 (zero) disables this option. If neither proxy sources nor ume_state_lifetime are configured, the store also deletes the source's state and cache. See also Proxy Sources.
Specifies whether or not UMP allows the sending of confirmed delivery notifications back to the source.
Flag indicating the source is interested in receiving notifications of delivery of messages to receivers (confirmed delivery) via the source event mechanism. When turned off, receivers do not send delivery confirmation notifications to the source unless the release policy dictates the need for them.
| String value | Integer value | Description |
|---|---|---|
0 |
LBM_SRC_TOPIC_ATTR_UME_CDELV_EVENT_NONE |
The source does not wish to receive delivery confirmation notifications. |
1 |
LBM_SRC_TOPIC_ATTR_UME_CDELV_EVENT_PER_FRAGMENT |
The source wishes to receive delivery confirmation notifications for all messages and message fragments. Default for all. |
2 |
LBM_SRC_TOPIC_ATTR_UME_CDELV_EVENT_PER_MESSAGE |
The source wishes to receive only one delivery confirmation for a message regardless of how many fragments it comprised. |
3 |
LBM_SRC_TOPIC_ATTR_UME_CDELV_EVENT_FRAG_AND_MSG |
The source wishes to receive delivery confirmation notifications for all messages and message fragments. In addition, the notification contains a WHOLE_MESSAGE_CONFIRMED flag when the last fragment of a message has been delivered. |
The behavior that the receiver will follow when determining the consensus sequence number used as the sequence number to begin reception at upon re-registration after a failure or suspension. This setting is only used when quorum-consensus is also used on the source.
| String value | Integer value | Description |
|---|---|---|
lowest |
LBM_RCV_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_LOWEST |
Consensus is determined as the lowest of the latest sequence numbers seen from any store. |
majority |
LBM_RCV_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_MAJORITY |
Consensus is determined as the latest sequence number agreed upon by the majority of stores within a group. Between groups, the latest of all majority decisions is used. Default for all. |
highest |
LBM_RCV_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_HIGHEST |
Consensus is determined as the highest of the latest sequence numbers seen from any store. |
The behavior that the source will follow when determining the consensus sequence number used as the first message of a source upon re-registration after a failure or suspension. This setting is only used when quorum-consensus is also used.
| String value | Integer value | Description |
|---|---|---|
lowest |
LBM_SRC_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_LOWEST |
Consensus is determined as the lowest of the latest sequence numbers seen from any store. |
majority |
LBM_SRC_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_MAJORITY |
Consensus is determined as the latest sequence number agreed upon by the majority of stores within a group. Between groups, the latest of all majority decisions is used. Default for all. |
highest |
LBM_SRC_TOPIC_ATTR_UME_QC_SQN_BEHAVIOR_HIGHEST |
Consensus is determined as the highest of the latest sequence numbers seen from any store. |
Flag indicating if the receiver should automatically send acknowledgements to any stores and to the source or if the application desires to explicitly generate acknowledgements itself. See also Explicit Acknowledgments.
Specifies the number of messages allowed to be in flight (unstabilized at a store and without delivery confirmation) before a new message send either blocks or triggers a notification (source event).
The behavior that UMP follows when a message send exceeds the source's ume_flight_size.
| Scope: | source |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 4.1.1/UME 3.1.1 |
| String value | Integer value | Description |
|---|---|---|
Block |
LBM_FLIGHT_SIZE_BEHAVIOR_BLOCK |
The send call blocks when a source sends a message that exceeds it's flight size. If the source uses a non-blocking send, the send returns an LBM_EWOULD_BLOCK. Default for all. |
Notify |
LBM_FLIGHT_SIZE_BEHAVIOR_NOTIFY |
A message send that exceeds the configured flight size does not block but triggers a flight size notification (source event), indicating that the flight size has been surpassed. UMP also sends a source event notification if the number of in-flight messages falls below the configured flight size. |
Specifies the message payload in bytes allowed to be in flight (unstabilized at a store and without delivery confirmation) before a new message send either blocks or triggers a notification source event. UMP monitors both this option and ume_flight_size. If either threshold is met, the configured blocking or notification behavior executes. See ume_flight_size_behavior. When using Receiver-paced Persistence, set this option greater than 0 (zero) but less than or equal to the repository's source-flight-size-bytes-maximum value.
Callback function (and associated client data pointer) that is called when a source is forced to release a retained message due to size limitations specified. This callback is called directly in line and does not use the event queue. Therefore the callback function used should not block or it will block the context thread processing. A value of NULL for the callback turns off the callback being called.
Flag indicating the source should allow late join operation for receivers and persistent stores. This is a compatibility setting. The late_join setting should be used instead.
Flag indicating the source is interested in receiving notifications of message stability from persistent stores via the source event mechanism. Even when turned off, stores continue to send message stability notifications to the source for retention purposes. However, no notification will be delivered to the application.
| String value | Integer value | Description |
|---|---|---|
0 |
LBM_SRC_TOPIC_ATTR_UME_STABLE_EVENT_NONE |
The source does not wish to receive message stability notifications from the store. |
1 |
LBM_SRC_TOPIC_ATTR_UME_STABLE_EVENT_FRAGMENT |
The source wishes to receive all message and message fragment stability notifications from the store. Default for all. |
2 |
LBM_SRC_TOPIC_ATTR_UME_STABLE_EVENT_MESSAGE |
The source wishes to receive only a single message stability notifications from the store when the entire message has been stabilized. This notification contains the Sequence Number of the last fragment of the whole message but does NOT contain store information. |
3 |
LBM_SRC_TOPIC_ATTR_UME_STABLE_EVENT_FRAG_AND_MSG |
The source wishes to receive all message and message fragment stability notifications from the store. In addition, the notification contains a WHOLE_MESSAGE_STABLE flag when the last fragment of a message has been stabilized. |
Controls whether any stores with which the source registers should provide a proxy source in the event the actual source terminates. Proxy source support is only available for quorum/consensus store configurations. In addition, proxy source support requires that the source register with an actual registration ID, and not request that the store assign it a registration ID.
The maximum interval between delivery confirmations or keepalive messages send to the source. Expiration of this interval triggers another keepalive and an interval reset.
Specifies that the receiver is a Receiver-paced Persistence (RPP) receiver. If the repository has set repository-allow-receiver-paced-persistence to 0 (disable), setting this option to 1 creates a store registration error.
Specifies that the source is a Receiver-paced Persistence (RPP) source and may change certain topic repository options to values allowed by the repository. If the repository has set repository-allow-receiver-paced-persistence to 0 (disable), setting this option to 1 creates a store registration error.
Callback function (and associated client data pointer) that is called when a receiver is about to complete registration from the stores in use by the source and the low sequence number is to be determined. The application has the ability to modify the sequence number to use if it desires. This callback is called directly in line and does not use the event queue. Therefore the callback function used should not block or it will block the context thread processing. A value of NULL for the callback turns off the callback being called.
Callback function (and associated client data pointer) that is called when a receiver is about to attempt to register with a persistent store. The app must return the registration ID to request from the store or 0 if it will allow the store to allocate one. This function passes additional extended information, such as the store being used and a source client data pointer, etc. This callback is called directly in line and does not use the event queue. Therefore the callback function used should not block or it will block the context thread processing. A value of NULL for the callback turns off the callback being called.
Callback function (and associated client data pointer) that is called when a receiver is about to attempt to register with a persistent store. The app must return the registration ID to request from the store or 0 if it will allow the store to allocate one. This callback is called directly in line and does not use the event queue. Therefore the callback function used should not block or it will block the context thread processing. A value of NULL for the callback turns off the callback being called. This setting is provided for compatibility. The ume_registration_extended_function setting should be used instead.
The interval between registration attempts by the receiver to a persistent store in use by the source.
The interval between registration attempts by the source. When using the round-robin store behavior, this is the value between registration attempts with the various stores. In other words, attempt to register with primary, wait interval, attempt to register with secondary, wait interval, etc.
For topics with a repository-type of disk or reduced-fd, specifies that the stability acknowledgement should be sent upon message reception by the store instead of when the message has been written to disk. When using Receiver-paced Persistence, if the repository has set repository-allow-ack-on-reception to 0 (disable), setting this option to 1 creates a store registration error. This option has no effect on Source-paced Persistence repositories.
For topics with a repository-type of disk or reduced-fd, specifies the maximum amount of disk space used to store retained messages. Using the default value of 0 (zero) implements the repository's repository-disk-file-size-limit value. When not set to 0, UMP enforces a minimum value of 196992. When using Receiver-paced Persistence and you require that the source dictates the repository's repository-disk-file-size-limit value, you must set this option greater than 0 (zero) but less than or equal to the repository's current repository-disk-file-size-limit value.
For topics with a repository-type of memory, disk or reduced-fd, specifies the maximum number of message bytes retained (includes payload only). When using Receiver-paced Persistence and you require that the source dictates the repository's repository-size-limit value, you must set this option greater than 0 (zero) but less than or equal to the repository's current repository-size-limit value. For the disk or reduced-fd repository type, this value configures the size of the memory cache. Using the default value of 0 (zero) implements the repository's value for this option.
For topics with a repository-type of memory, disk or reduced-fd, specifies the minimum number of message bytes retained (includes payload only). When using Receiver-paced Persistence and you require that the source dictates the repository's repository-size-threshold value, you must set this option greater than 0 (zero) but less than or equal to the repository's current repository-size-threshold value. For the disk or reduced-fd repository type, this value configures the size of the memory cache. Using the default value of 0 (zero) implements the repository's value for this option.
The behavior that the source will follow when determining the stability of a message from an inter-group perspective. This has a direct impact on the release policy for the source in that a message must be stable before it may be released. To be stable, a message must first be stable within the group and then stable between groups.
| String value | Integer value | Description |
|---|---|---|
any, any-group |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_ANY |
Message is considered stable once it is stable in any group. Default for all. |
majority |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_MAJORITY |
Message is considered stable once it is stable in a majority of groups. |
all, all-groups |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_ALL |
Message is considered stable once all groups have reached intra-group stability for the message. |
all-active |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_ALL_ACTIVE |
Message is considered stable once it is stable in all active groups. A group is considered active if it has at least a quorum of active or registered stores. Intergroup stability requires at least one stable group. |
The behavior that the source will follow when determining the stability of a message from an intra-group perspective. This has a direct impact on the release policy for the source in that a message must be stable before it may be released. To be stable, a message must first be stable within the group and then stable between groups.
| String value | Integer value | Description |
|---|---|---|
quorum |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_QUORUM |
Message is considered stable within the group once a quorum (or majority) of the stores have acknowledged the message as stable. Default for all. |
all, all-stores |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_ALL |
Message is considered stable within the group once all stores have acknowledged the message as stable. |
all-active |
LBM_SRC_TOPIC_ATTR_UME_STABLE_BEHAVIOR_ALL_ACTIVE |
Message is considered stable within the group once each registered store in that group has acknowledged the message as stable. Only stores registered with a source are considered "active". |
The release policy regarding aggregate size limit before messages are forced to be released. If the total number of bytes retained for the source is less than this amount, they may be released depending on other retention settings. If the total number of bytes exceeds this amount, then the message is forced to be released and a log message generated. This setting is provided for compatibility. The retransmit_retention_size_limit setting should be used instead.
The release policy regarding aggregate size threshold before messages are released. If the total number of bytes retained for the source is less than this amount, they will not be released. If the total number of bytes exceeds this amount, then the message may be released if no other release policy setting overrides the decision. A value of 0 indicates there is no size threshold set. This setting is provided for compatibility. The retransmit_retention_size_threshold setting should be used instead.
The release policy regarding the number of confirmations from different receivers required before the source can release a message. This option enhances, but does not supersede, message stability notification from the store(s). If the number of unique confirmations for a message is less than this amount, the message will not be released. If the number of unique confirmations for a message exceeds or equals this amount, then the message may be released if no other release policy setting overrides the decision. A value of 0 indicates there is no unique number of confirmations required for reclamation.
The maximum interval between when a retransmission request is first sent and when it is given up on and loss is reported. This setting is provided for compatibility. The retransmit_request_generation_interval setting should be used instead.
The interval between retransmission request messages to the persistent store or to the source. This setting is provided for compatibility. The retransmit_request_interval setting should be used instead.
The maximum number of messages to request back from the current latest message when late joining a topic or when registering with a UMP store. A value of 0 indicates no maximum. This setting is provided for compatibility. The retransmit_request_maximum setting should be used instead.
The maximum number of messages to request at a single time from the store or source. A value of 0 indicates no maximum. This setting is provided for compatibility. The retransmit_request_outstanding_maximum setting should be used instead.
Specifies the default Session ID to use for sources and receivers within a context. A value of 0 (zero) indicates no Session ID is to be set. See also Managing RegIDs with Session IDs.. Valid formats for session IDs are as follows: A hexadecimal string with a maximum value of FFFFFFFFFFFFFFFE, prefixed with '0x'. An octal string with a maximum value of 1777777777777777777776 prefixed with '0'. A decimal string with a maximum value of 18446744073709551614. Prior to LBM 5.2.2, all UME session IDs were interpreted as hexadecimal, and did not accept the '0x' prefix. If upgrading from an earlier version to LBM 5.2.2 or later, prepend '0x' to the original setting to use the originally assigned session ID.
Specifies the Session ID to use for a receiver. A value of 0 (zero) indicates the context ume_session_id will be used. See also Managing RegIDs with Session IDs.. Valid formats for session IDs are as follows: A hexadecimal string with a maximum value of FFFFFFFFFFFFFFFE, prefixed with '0x'. An octal string with a maximum value of 1777777777777777777776 prefixed with '0'. A decimal string with a maximum value of 18446744073709551614. Prior to LBM 5.2.2, all UME session IDs were interpreted as hexadecimal, and did not accept the '0x' prefix. If upgrading from an earlier version to LBM 5.2.2 or later, prepend '0x' to the original setting to use the originally assigned session ID.
Specifies the Session ID to use for a source. A value of 0 (zero) indicates the context ume_session_id will be used. See also Managing RegIDs with Session IDs.. Valid formats for session IDs are as follows: A hexadecimal string with a maximum value of FFFFFFFFFFFFFFFE, prefixed with '0x'. An octal string with a maximum value of 1777777777777777777776 prefixed with '0'. A decimal string with a maximum value of 18446744073709551614. Prior to LBM 5.2.2, all UME session IDs were interpreted as hexadecimal, and did not accept the '0x' prefix. If upgrading from an earlier version to LBM 5.2.2 or later, prepend '0x' to the original setting to use the originally assigned session ID.
The expected maximum interval between keepalive or delivery confirmation messages from a receiver. If neither are received within the interval, the source declares the receiver "dead".
Establishes the period of time from a receiver's last activity to the deletion of the receiver's state and cache by the store. You can also configure a receiver-state-lifetime for the receiver's topic on the store. The store uses whichever is shorter. The default value of 0 (zero) disables this option. See also Proxy Sources.
Establishes the period of time from a source's last activity to the deletion of the source's state and cache by the store, regardless of whether a proxy source has been created or not. You can also configure a source-state-lifetime for the source's topic on the store. The store uses whichever is shorter. The default value of 0 (zero) disables this option. See also Proxy Sources.
Add a store specification to the list of stores specified for the source. Unlike most other UMP settings, every time this setting is called, it adds another store specification to the list and does NOT overwrite previous specifications. Each entry contains the IP address, TCP port, registration ID, and group index for the store. For the configuration file as well as string versions of setting this option, the string value is formatted as "IP:port:RegID:GroupIDX" where IP is the stores IP address, port is the TCP port for the store, RegID is the registration ID that the source desires to use, and GroupIDX is the group index that the store belongs to. The RegID and GroupIDX pieces may be left off the string if desired. If so, then the value of 0 is assumed for them. Because each entry adds a new store specification and does not overwrite previous values, an entry or string with the IP address of 0.0.0.0 and TCP port of 0 will cause all previous store specifications to be removed. A single store specification means the source will use persistence. If no stores are specified, then persistence will not be provided for the source.
The timeout value used to indicate when a store is unresponsive. The store must not be active within this interval to be considered unresponsive. This value must be much larger than the check interval.
The behavior that the source will follow for handling store failures.
| String value | Integer value | Description |
|---|---|---|
rr, round-robin |
LBM_SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_RR |
The source will use a single store at a time and when a store is unresponsive due to failure or disconnect, the next store in the list will be used. This will continue in a round-robin fashion until a store is found that is available. Default for all. |
qc, quorum-consensus |
LBM_SRC_TOPIC_ATTR_UME_STORE_BEHAVIOR_QC |
The source will use multiple stores at the same time based on store and store group configuration. |
The interval between activity checks of the current store.
Add a store group specification to the list of store groups specified for the source. Unlike other UMP settings, every time this setting is called, it adds another store group specification to the list and does NOT overwrite previous specifications. Each entry contains the group index and group size for the group. For the configuration file as well as string versions of setting this option, the string value is formatted as "GroupIDX:GroupSZ" where GroupIDX is the index of the group and GroupSZ is the size of the group. Because each entry adds a new store specification and does not overwrite previous values, an entry or string with the group index of 0 and group size of 0 will cause all previous store group specifications to be removed.
Add a store specification to the list of stores specified for the source. Unlike other UMP settings, every time this setting is called, it adds another store specification to the list and does NOT overwrite previous specifications. Each entry contains the store name, registration ID, and group index for the store. For the configuration file as well as string versions of setting this option, the string value is formatted as "name:RegID:GroupIDX" where name is the name of the store configured with the store attribute, context-name in the umestored XML configuration file, RegID is the registration ID that the source desires to use, and GroupIDX is the group index that the store belongs to. The RegID and GroupIDX pieces may be left off the string if desired. If so, then the value of 0 is assumed for them. Store names are restricted to 128 characters in length, and may contain only alphanumeric characters, hyphens, and underscores.
Specifies whether or not UMP allows the batching of consumption acknowledgments sent to the store(s). If enabled, UMP checks for contiguous sequence numbered messages at the ume_ack_batching_interval. See also Batching Acknowledgments.
Flag indicating if the receiver should participate in late join operation or not. This is a compatibility setting. The use_late_join setting should be used instead.
Flag indicating if the receiver should participate in using a persistent store or not.
32-bit value that is used as a user set identifier to be included as the receiver registration ID in acknowledgements send by any receivers in the context to sources as confirmed delivery notifications. The value is not interpreted by UMP in any way and has no relation to registration IDs used by the receiver. A value of 0 indicates no user set value is in use and should not be sent with acknowledgements
For topics with a repository-type of disk, specifies the delay in milliseconds before the repository persists a message to disk. When using Receiver-paced Persistence, you must set this option greater than 0 (zero) but less than or equal to the repository's write-delay value.
Copyright (c) 2004 - 2014 Informatica Corporation. All rights reserved.