The interval at which all currently outstanding UMQ commands (registrations, de-registrations, message list commands, indexed queueing commands, etc.) are re-sent if they have not yet been acknowledged by the queue.
The maximum number of UMQ commands (registrations, de-registrations, message list commands, indexed queueing commands, etc.) that may be outstanding at one time for each configured queue. This option value must be greater than 0. Reducing this value may help alleviate some load on the UMQ queue daemon, but may potentially cause registrations and other commands to take longer to complete.
The maximum interval to delay sending consumption reports on the receiver. Delaying consumption reports allows them to be batched together for efficiency but at the expense of delaying the consumption reports themselves individually. The value of 0 indicates the consumption reports should not be delayed.
Specifies the number of Multicast Immediate Messages allowed to be in flight (unstabilized at a queue) before a new message send either blocks or triggers a notification (source event).
Specifies the number of messages allowed to be in flight (unstabilized at a queue) before a new message send either blocks or triggers a notification (source event).
The behavior that UMQ follows when a Multicast Immediate Message send exceeds the context's umq_flight_size.
| Scope: | context |
| 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/UMQ 1.1.1 |
| String value | Integer value | Description |
|---|---|---|
Block |
LBM_FLIGHT_SIZE_BEHAVIOR_BLOCK |
The send call blocks when a MIM send exceeds the context's flight size. If the MIM send is 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 (context event), indicating that the flight size has been surpassed. UMQ also sends a context event notification if the number of in-flight messages falls below the configured flight size. |
The behavior that UMQ follows when a message send exceeds the source's umq_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/UMQ 1.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. UMQ also sends a source event notification if the number of in-flight messages falls below the configured flight size. |
The maximum interval to hold control and data information within the UM queue delivery controller.
Controls whether new receivers are immediately eligible for index assignment upon
registration with a queue (the default) or whether they are ineligible upon registration
and must be explicitly made eligible via a call to lbm_rcv_umq_index_start_assignment().
| Scope: | receiver |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 4.2/UME 3.2/UMQ 1.2 |
| String value | Integer value | Description |
|---|---|---|
Eligible |
LBM_RCV_TOPIC_ATTR_UMQ_INDEX_ASSIGN_ELIGIBILITY_ELIGIBLE |
The receiver may be assigned indices as soon as it registers with a queue. Default for all. |
Ineligible |
LBM_RCV_TOPIC_ATTR_UMQ_INDEX_ASSIGN_ELIGIBILITY_INELIGIBLE |
The receiver must first call lbm_rcv_umq_index_start_assignment() before it can be assigned
any indices. |
The interval between retransmissions of data messages when submitting to a Queue.
Flag indicating the context is interested in receiving notifications of message stability from Queues via the context event mechanism. Even when turned off, Queues will continue to send message stability notifications to the context for retention purposes. However, no notification will be delivered to the application.
Flag indicating the source is interested in receiving notifications of message stability from UMQ via the source event mechanism. Even when turned off, UMQ continues to send message stability notifications to the source for retention purposes. However, UMQ delivers no notification to the application.
Establishes the period of time from when a queue enqueues a Multicast Immediate Message (MIM) until the time the message cannot be assigned or reassigned to a receiver. The default value of 0 (zero) disables this option. See also Message Lifetimes and Reassignment.
Establishes the period of time from when a queue enqueues a message until the time the message cannot be assigned or reassigned to a receiver. The queue deletes the message upon expiration of the lifetime. You can also configure a message-total-lifetime for the source's topic on the queue. The queue uses whichever is shorter. The default value of 0 (zero) disables this option. See also Message Lifetimes and Reassignment.
The timeout value used to indicate when a queue is marked inactive. The queue must be active within this interval to be marked inactive. This value must be much larger than the check interval.
The interval between activity checks of the individual UMQ queues.
The queue to submit messages to when sending.
Flag indicating the source only desires queue participants to listen to the topic.
Flag indicating if the receiver desires to participate in Queuing operations or not.
| Scope: | receiver |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 3.6/UME 3.0/UMQ 1.0. Value "2" was added in UMQ 5.2.1. |
| String value | Integer value | Description |
|---|---|---|
"1" (Integer value as a string.) |
1 |
The receiver desires to participate in Queuing operations. Default for all. |
"0" (Integer value as a string.) |
0 |
The receiver does not wish to participate in Queuing operations. |
"2" (Integer value as a string.) |
2 |
The receiver desires to participate in Queuing operations as an observer receiver only. Observer receivers cannot be assigned nor consume queue messages, but can retrieve information about currently enqueued messages. |
The interval between queries sent for resolving Queues.
This 64-bit string value assigns a registration ID to a context and associates it with a queue, using the format "qname:RegID". The RegID must be unique for each queue-context pair, however, a context can register with more than one queue (using its same RegID or a different RegID). A NULL value erases all RegIDs created via this option (required before you reassign a new RegID value to a context). NOTE: We no longer recommend setting this option, because a) if not set, UM automatically generates a unique registration ID when registering with the queue, and b) the umq_session_id option provides a more efficient way to manage UMQ context registration IDs.
32-bit value that is used as an identifier to instruct the queue as to the type of receiver the receiver should be.
Indicates if an application requires a queue to authenticate itself before accepting the queue's responses to Queue Browser commands. See also Queue Browser.
The behavior that the context 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 context 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.
| Scope: | context |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 3.6/UME 3.0/UMQ 1.0. |
| String value | Integer value | Description |
|---|---|---|
any, any-group |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ANY |
Message is considered stable once it is stable in any group. Default for all. |
majority |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_MAJORITY |
Message is considered stable once it is stable in a majority of groups. |
all, all-groups |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL |
Message is considered stable once it is stable in all groups. |
all-active |
LBM_SRC_TOPIC_ATTR_UMQ_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 queues. Intergroup stability requires at least one stable group. |
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 context 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.
| Scope: | source |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 3.6/UME 3.0/UMQ 1.0. |
| String value | Integer value | Description |
|---|---|---|
any, any-group |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ANY |
Message will be considered stable once any group has reached intra-group stability for the message. Default for all. |
majority |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_MAJORITY |
Message will be considered stable once a majority of groups have reached intra-group stability for the message. |
all, all-groups |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL |
Message will be considered stable once all groups have reached intra-group stability for the message. |
all-active |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL_ACTIVE |
Message will be considered stable once all active groups have reached intra-group stability for the message. |
The behavior that the context 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 context 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.
| Scope: | context |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 3.6/UME 3.0/UMQ 1.0. |
| String value | Integer value | Description |
|---|---|---|
quorum |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_QUORUM |
Message is considered stable within the group once a quorum (or majority) of the queues have acknowledged the message as stable. Default for all. |
all, all-stores |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL |
Message is considered stable with the group once all queues have acknowledged the message as stable. |
all-active |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL_ACTIVE |
Message is considered stable with the group once all active queues have acknowledged the message as stable. |
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 context 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.
| Scope: | source |
| Type: | int |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 3.6/UME 3.0/UMQ 1.0. |
| String value | Integer value | Description |
|---|---|---|
quorum |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_QUORUM |
Message will be considered stable within the group once a quorum (or majority) of the queues have acknowledged the message as stable. Default for all. |
all, all-stores |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL |
Message will be considered stable with the group once all queues have acknowledged the message as stable. |
all-active |
LBM_SRC_TOPIC_ATTR_UMQ_STABLE_BEHAVIOR_ALL_ACTIVE |
Message will be considered stable with the group once all active queues have acknowledged the message as stable. |
The interval between retransmission request messages to the queue.
The maximum number of messages to request at a single time from the queue. A value of 0 indicates no maximum.
Specifies the Session ID to use for managing sources and receivers within a context. A value of 0 (zero) indicates no Session ID is to be set. See also Queue 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.
Application set specifications to be used by a source when using UMQ Ultra Load Balancing. Specifications use the format, "Index1:ID1,ID2,...;Index2:ID3,ID4,...", where "Index1" and "Index2" are the indices of the application sets and "ID1", "ID2" are receiver type IDs that belong in application set "Index1" and "ID3" and "ID4" are receiver type IDs that belong in application set "Index2". The index values used for application sets may be specified in any order, however, they must be contiguous starting with 0 when the topic is allocated. This specification format applies to the string version of this setting as well. At least one application set specification means the source will use UMQ Ultra Load Balancing. If no application sets are specified, the source will not use UMQ Ultra Load Balancing.
The assignment function for one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". UMQ uses the unsigned long int value of the entry.
The events mask of one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses a mask of "value1" and application set "Index2" uses a mask of "value2". The values may follow the same format as described in umq_ulb_events. Application sets use the value of 0 as the default event mask. UMQ uses the unsigned long int value of the entry.
The behavior for the load factor for one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". UMQ uses the unsigned long int value of the entry.
| Scope: | source |
| Type: | lbm_umq_ulb_application_set_attr_t |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 4.1/UME 3.1/UMQ 1.1. |
| String value | Integer value | Description |
|---|---|---|
ignored |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_LF_BEHAVIOR_IGNORED |
Load Factor information not sent and not processed or taken into assignment consideration. Default for all. |
provisioned |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_LF_BEHAVIOR_PROVISIONED |
Load Factor information on number of sources sent and processed as well as taken into consideration to reduce the active portion size for each receiver. |
dynamic |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_LF_BEHAVIOR_DYNAMIC |
Load Factor information sent and processed as well as taken into consideration during assignment to weight receiver choice. |
The message lifetime in milliseconds of one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". A message lifetime of 0 means UMQ never discards the message. Application sets use the value of 0 as the default message lifetime. UMQ uses the unsigned long int value of the entry.
The maximum number of message reassignments before UMQ discards a message for one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". UMQ applies the initial assignment to this maximum. Setting this option to 1 means that the message will never be reassigned. The default value of 0 means UMQ never discards the message due to too many reassignments. Application sets use the value of 0 as the default. UMQ uses the unsigned long int value of the entry.
The message reassignment timeout (in milliseconds) of one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". A message reassignment timeout of 0 means UMQ never reassigns the message. Application sets use the value of 10000 (10 seconds) as the default. UMQ uses the unsigned long int value of the entry.
The receiver activity timeout (in milliseconds) of one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". Application sets use the value of 10000 (10 seconds) as the default. UMQ uses the unsigned long int value of the entry.
The interval (in milliseconds) between keepalive messages to receivers for one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". Application sets use the value of 1000 (1 seconds) as the default. UMQ uses the unsigned long int value of the entry.
The bias assignment towards unassigned receivers for one or more application sets specified as a list of entries in the format, "Index1:value1;Index2:value2;..." where application set "Index1" uses "value1" and application set "Index2" uses "value2". Large values increase the bias toward unassigned receivers. Zero (0) disables the bias.
The interval upon which UMQ Ultra Load Balancing sources check for message reassignment, message discards, and receiver liveness.
A mask indicating what UMQ Ultra Load Balancing events should be delivered to the source event callback. Applies to all application sets and receiver types for the source. For the configuration file as well as string versions of this option, the string value may be formatted as hexadecimal value or a list of enumerated values separated by a '|' or ','.
| Scope: | source |
| Type: | string |
| Units: | mask |
| Default value: | 0 |
| When to Set: | Can only be set during object initialization. |
| Version: | This option was implemented in LBM 4.1/UME 3.1/UMQ 1.1. |
| String value | Integer value | Description |
|---|---|---|
MSG_CONSUME, MsgConsume |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_MSG_CONSUME |
Deliver message consumption events. |
MSG_TIMEOUT, MsgTimeout |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_MSG_TIMEOUT |
Deliver message timeout/discard events. |
MSG_ASSIGNMENT, MsgAssignment |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_MSG_ASSIGNMENT |
Deliver message assignment events. |
MSG_REASSIGNMENT, MsgReassignment |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_MSG_REASSIGNMENT |
Deliver message reassignment events. |
MSG_COMPLETE, MsgComplete |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_MSG_COMPLETE |
Deliver message completion events. Messages are complete once they are consumed or discarded from all application sets. |
RCV_TIMEOUT, RcvTimeout |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_RCV_TIMEOUT |
Deliver receiver timeout events. |
RCV_REGISTRATION, RcvRegistration |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_RCV_REGISTRATION |
Deliver receiver registration events. |
RCV_DEREGISTRATION, RcvDeregistration |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_RCV_DEREGISTRATION
|
Deliver receiver deregistration events. |
RCV_READY, RcvReady |
LBM_SRC_TOPIC_ATTR_UMQ_ULB_EVENT_RCV_READY |
Deliver receiver ready events. |
Specifies the number of messages allowed to be in flight (unconsumed) before a new message send either blocks or triggers a notification (source event).
The behavior that UMQ follows when a message send exceeds the source's ulb_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/UMQ 1.1.1 |
| String value | Integer value | Description |
|---|---|---|
Block |
LBM_FLIGHT_SIZE_BEHAVIOR_BLOCK |
The send call blocks when a message send exceeds the source's flight size. If the message send is 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. UMQ also sends a source event notification if the number of in-flight messages falls below the configured flight size. |
Set the events mask of one or more receiver types specified as a list of entries in the format, "ID1:value1;ID2:value2;..." where receiver type "ID1" uses a mask of "value1" and receiver type "ID2" uses a mask of "value2". The values may follow the same format as described in umq_ulb_events. Receiver types use the value of 0 as the default event mask. UMQ uses the unsigned long int value of the entry.
The portion size of one or more receiver types specified as a list of entries in the format, "ID1:value1;ID2:value2;..." where receiver type "ID1" uses a portion size of "value1" and receiver type ID2 uses a portion size of "value2". Receiver types use the value of 1 as the default portion size. UMQ uses the unsigned long int value of the entry.
The priority of one or more receiver types specified as a list of entries in the format, "ID1:value1;ID2:value2;..." where receiver type "ID1" uses a priority of "value1" and receiver type "ID2" uses a priority of "value2". Receiver types use the value of 0 as the default priority. UMQ uses the int value of the entry.
The timeout value used to indicate when a ULB source is unresponsive. The ULB source must not be active within this interval to be considered unresponsive. This value must be much larger than the source check interval.
The interval between activity checks of a ULB source. Allow a ULB receiver to proactively attempt re-registration with a ULB source if the receiver has not seen any activity (including keepalives) from that source in a specified amount of time, provided the source's transport session is still alive and valid.
Copyright (c) 2004 - 2014 Informatica Corporation. All rights reserved.