Deprecated Options

Reference  <-

datagram_acceleration_functions (context)  <-

DEPRECATED, do not use. Specifies the callback functions that implement Datagram Acceleration.

Refer to the description of lbm_datagram_acceleration_func_t for the callback definitions.

Scope:	context
Type:	lbm_datagram_acceleration_func_t
Default value:	NULL
When to Set:	Can only be set during object initialization.
Config File:	Cannot be set from an UM configuration file.
Version:	This option was implemented in UM 6.10
Version:	This option was deprecated in UM 6.13.1

delivery_control_loss_tablesz (receiver)  <-

DEPRECATED, this controls the size of the hash table index used for storing unrecoverable loss state on a per source per topic basis.

For LBT-RM and other datagram-based transport sessions only. Larger values mean larger hash tables and probably better CPU usage under loss scenarios at the cost of more memory per source per topic. Smaller values mean smaller hash tables and probably worse CPU usage under loss scenarios but with less memory usage. The value used should be a prime number for efficiency.

Scope:	receiver
Type:	size_t
Units:	table entries
Default value:	131
When to Set:	Can only be set during object initialization.
Version:	Deprecated

delivery_control_order_tablesz (receiver)  <-

DEPRECATED, this controls the size of the hash table index used for storing buffered data on a per source per topic basis when ordered delivery is used.

For LBT-RM and other datagram-based transport sessions only. Larger values mean larger hash tables and probably better CPU usage under loss scenarios at the cost of more memory per source per topic. Smaller values mean smaller hash tables and probably worse CPU usage under loss scenarios but with less memory usage. The value used should be a prime number for efficiency.

Scope:	receiver
Type:	size_t
Units:	table entries
Default value:	131
When to Set:	Can only be set during object initialization.
Version:	Deprecated

implicit_batching_type (source)  <-

DEPRECATED, determines the algorithm to use for implicit batching.

This option has been deprecated because the adaptive batching algorithm has the same worst case for latency as the default algorithm and is not better for throughput. This is because, even with adaptive batching, UM cannot predict when the application will stop sending, at which point (unless the application calls the flush API) the implicit batching interval must expire before the batch will be sent. To minimize latency while batching, it is most effective to call the flush API whenever the application will not immediately send another message.

Scope:	source
Type:	int
When to Set:	May be set during operation.
Version:	This option was deprecated in UM 6.9.

String value	Integer value	Description
"default"	LBM_SRC_TOPIC_ATTR_IMPLICIT_BATCH_TYPE_DEFAULT	Implicit batching is controlled entirely by the implicit_batching_minimum_length (source) and implicit_batching_interval (source) options. Refer to Message Batching for additional information. Default for all.
"adaptive"	LBM_SRC_TOPIC_ATTR_IMPLICIT_BATCH_TYPE_ADAPTIVE	Source-paced batching method that attempts to adjust the amount of messages sent in each batch automatically. The options, implicit_batching_minimum_length (source) and implicit_batching_interval (source), limit batch sizes and intervals but sizes and intervals will usually be much smaller. Setting this option may have a negative impact on maximum throughput.

network_compatibility_mode (context)  <-

DEPRECATED, enable compatibility mode which allows UM versions LBM-4.2/UME-3.2/UMQ-2.1 through UM 5.* to interoperate with UM versions prior to LBM-4.2/UME-3.2/UMQ-2.1 by blocking the sending of some header option types.

This option has no effect on Ultra Messaging Versions 6.0 and later.

Scope:	context
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 2.1.
Version:	This option was deprecated in UM 6.0 (documentation was updated to reflect this deprecation in UM 6.9).

otr_request_duration (receiver)  <-

DEPRECATED, the length of time a receiver continues to send OTR lost-message requests before giving up. This option is deprecated in favor of otr_request_message_timeout (receiver).

See Off-Transport Recovery (OTR).

Scope:	receiver
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	20000 (20 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UM 5.2
Version:	This option was deprecated in UM 6.0

pattern_callback (wildcard_receiver)  <-

DEPRECATED, callback function (and associated client data pointer) that is called when a pattern match is desired for a topic discovered for a wildcard receiver if the pattern type is set to "appcb".

This callback is called by the context thread and can not use an event queue. Therefore the callback function used should not block or it will delay reception of latency-sensitive messages.

A function return value of 0 indicates the given topic should be considered part of the wildcard. A value of 1 or more indicates the topic should NOT be considered matching the wildcard.

Scope:	wildcard_receiver
Type:	lbm_wildcard_rcv_compare_func_t
Default value:	NULL
When to Set:	Can only be set during object initialization.
Config File:	Cannot be set from an UM configuration file.

rcv_sync_cache (receiver)  <-

DEPRECATED, UMCache only - a valid cache address (such as TCP:192.168.5.11:4567) in the standard form of TCP:address:port enables a UM receiver to use UMCache to receive a snapshot of larger, multiple-field messages stored by UMCache.

Receiving applications can then become synchronized with the live stream of messages sent on the receiver's topic. address is the IP address of the machine where the UMCache runs and port is the configured port where the cache request handler listens.

Scope:	receiver
Type:	umcache_reqlib_request_info_t
Default value:	NULL
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMS 5.0/UMP 5.0/UMQ 5.0
Version:	This option was deprecated in UM 6.9

rcv_sync_cache_timeout (receiver)  <-

DEPRECATED, the maximum time period that a UM receiver waits for a snapshot message from the UMCache.

UMCache only.

Scope:	receiver
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	2000 (2 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMS 5.0/UMP 5.0/UMQ 5.0
Version:	This option was deprecated in UM 6.9

receive_thread_pool_size (context)  <-

DEPRECATED, this option no longer functions.

It used to define the maximum number of threads available for transports (excluding the context thread). The MTT feature is replaced in 6.11 and beyond by Transport Services Provider (XSP).

Scope:	context
Type:	int
Default value:	4
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in LBM 4.1/UME 3.1.
Version:	This option was deprecated in UM 6.9
Version:	This option was removed from UM 6.11

resolver_active_source_interval (context)  <-

DEPRECATED, interval between sending Topic Resolution advertisements for active sources.

A value of 0 indicates that periodic advertisements should not be sent (sources will still respond to queries). When set to 0, the resolver_active_threshold should typically also be set to 0. See also Disabling Aspects of Topic Resolution.

Note: Although this option is eligible to be set during operation, two considerations exist.

If this option is disabled at initialization (set to 0), you cannot re-set the option during operation.

Disabling this option by setting it to 0 (zero) during operation prevents you from re-setting the option a second time during operation.

Scope:	context
Type:	unsigned long int
Units:	milliseconds
Default value:	1000 (1 second)
When to Set:	May be set during operation.
Version:	This option was deprecated in LBM 4.0

resolver_active_threshold (context)  <-

DEPRECATED, number of seconds since the last application message was sent to a source that causes that source to be marked inactive.

Inactive sources are not advertised periodically (but will continue to respond to queries). A value of 0 indicates that sources will advertise periodically regardless of how often the application sends messages. Note that for publishers with large numbers of sources, this can increase the topic resolution traffic load.

However, also note that this option SHOULD be set to 0 if periodic advertisements are disabled. See Disabling Aspects of Topic Resolution and Interrelated Configuration Options.

Scope:	context
Type:	unsigned long int
Units:	seconds
Default value:	60
When to Set:	May be set during operation.
Version:	This option was deprecated in LBM 4.0

resolver_context_advertisement_interval (context)  <-

DEPRECATED, interval between context advertisements.

Setting this option to 0 disables context advertisements, though DRO and other functionality depends upon context advertisements, so a value of 0 is not generally recommended.

Scope:	context
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	10000 (10 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UM 6.0

resolver_maximum_advertisements (context)  <-

DEPRECATED, maximum number of topics that will be advertised per active source interval.

A value of 0 means to advertise all topics.

Scope:	context
Type:	unsigned long int
Units:	Number of topics
Default value:	0 (all topics)
When to Set:	May be set during operation.
Version:	This option was deprecated in LBM 4.0

resolver_maximum_queries (context)  <-

DEPRECATED, maximum number of topics that will be queried for per query interval.

A value of 0 means to query for all topics that do not have at least one source.

Scope:	context
Type:	unsigned long int
Units:	Number of topics
Default value:	0 (all topics with no source)
When to Set:	May be set during operation.
Version:	This option was deprecated in LBM 4.0

resolver_query_interval (context)  <-

DEPRECATED, interval between query transmissions for receivers attempting Topic Resolution.

A value of 0 indicates queries should not be sent. See also Disabling Aspects of Topic Resolution.

Note: Although this option is eligible to be set during operation, two considerations exist.

If this option is disabled at initialization (set to 0), you cannot re-set the option during operation.

Disabling this option by setting it to 0 (zero) during operation prevents you from re-setting the option a second time during operation.

Scope:	context
Type:	unsigned long int
Units:	milliseconds
Default value:	100 (0.1 seconds)
When to Set:	May be set during operation.
Version:	This option was deprecated in LBM 4.0

resolver_query_max_interval (wildcard_receiver)  <-

DEPRECATED, this sets the maximum interval between wildcard queries in topic resolution (when used).

Only PCRE and regex pattern types can use wildcard queries. A value of 0 indicates wildcard queries should not be sent. UM currently queries a maximum of 250 unique wildcard patterns (receivers).

Note: Although this option is eligible to be set during operation, two considerations exist.

• If this option is disabled at initialization (set to 0), you cannot re-set the option during operation.

• Disabling this option by setting it to 0 (zero) during operation prevents you from re-setting the option a second time during operation.

Scope:	wildcard_receiver
Type:	unsigned long int
Units:	milliseconds
Default value:	0 (do not query)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in LBM 4.0

resolver_unicast_address (context)  <-

DEPRECATED, the IP address (or domain name of the IP address) to send unicast topic resolution messages to.

This option was deprecated in UMS 5.0. Use resolver_unicast_daemon (context) instead.

If set to 0.0.0.0 (INADDR_ANY), then topic resolution uses multicast (the default). If set to anything else, then topic resolution messages go to the IP address specified.

Scope:	context
Type:	struct in_addr
Default value:	0.0.0.0 (INADDR_ANY)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UMS 5.0.

resolver_unicast_destination_port (context)  <-

DEPRECATED, the UDP port to send unicast topic resolution messages to. This is the UDP port used by the UM resolution daemon (lbmrd).

This option was deprecated in UMS 5.0. Use resolver_unicast_daemon (context) instead.

See Port Assignments for more information about configuring ports.

Scope:	context
Type:	lbm_uint16_t
Default value:	15380
Byte order:	Network
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UMS 5.0.

resolver_unicast_port (context)  <-

DEPRECATED, the local UDP port used for unicast topic resolution messages.

This option was deprecated in UMS 5.0. Use resolver_unicast_daemon (context) instead. The UM resolution daemon (lbmrd) will send unicast topic resolution messages to this UDP port. A value of 0 indicates that UM should pick an open port in the range (resolver_unicast_port_low (context), resolver_unicast_port_high (context)). See Port Assignments for more information about configuring ports.

Scope:	context
Type:	lbm_uint16_t
Default value:	0 (pick open port)
Byte order:	Network
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UMS 5.0.

retransmit_message_map_tablesz (source)  <-

DEPRECATED, the size of the hash table that the source uses to store messages for the retention policy in effect.

A larger table means more messages can be stored more efficiently, but takes up more memory. A smaller table uses less memory, but costs more CPU time as more messages are retained. See Configuring Late Join for Large Numbers of Messages for additional information.

Scope:	source
Type:	size_t
Default value:	131
When to Set:	Can only be set during object initialization.
Version:	This option has been deprecated.

retransmit_request_generation_interval (receiver)  <-

DEPRECATED, the maximum interval between when a receiver first sends a retransmission request and when the receiver stops and reports loss on the remaining RXs not received.

See Configuring Late Join for Large Numbers of Messages for additional information.

This option is deprecated and has no effect. Use retransmit_request_message_timeout (receiver) instead.

Scope:	receiver
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	10000 (10 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UM 6.0

source_cost_evaluation_function (context)  <-

DEPRECATED, callback function that you can use in the lbm_src_cost_function_cb() to evaluate or determine the cost of a message path.

The DRO evaluates the cost of any new topic it detects. The callback supplied with this option can affect the cost of topics to bias the DRO toward certain message paths.

Scope:	context
Type:	lbm_src_cost_func_t
Default value:	NULL
When to Set:	Can only be set during object initialization.
Config File:	Cannot be set from an UM configuration file.
Version:	This option was implemented in UMS 5.0/UMP 5.0/UMQ 5.0
Version:	This option was deprecated in UM 6.0

transport_datagram_max_size (context)  <-

DEPRECATED, do not use. The maximum datagram size that can be generated by UM. The default value is 8192, the minimum is 400 bytes, and the maximum is 65535.

This configuration option is replaced by the following transport-specific options: transport_tcp_datagram_max_size (context), transport_lbtrm_datagram_max_size (context), transport_lbtru_datagram_max_size (context), transport_lbtipc_datagram_max_size (context), transport_lbtsmx_datagram_max_size (source).

Scope:	context
Type:	unsigned int
Units:	bytes
Default value:	8192
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in LBM 3.3.5/UME 2.0.3.
Version:	This option was deprecated in LBM 4.1

transport_lbtipc_acknowledgement_interval (receiver)  <-

DEPRECATED, period of time between acknowledgement (keepalive) messages sent from the receiver to the IPC source.

See also transport_lbtipc_client_activity_timeout (source).

Scope:	receiver
Type:	unsigned long int
Units:	milliseconds
Default value:	500 (0.5 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in LBM 4.0

transport_lbtipc_client_activity_timeout (source)  <-

DEPRECATED, the maximum period of inactivity (lack of acknowledgement keepalive messages) from a receiver before the source deletes the receiver from its active receiver table.

The IPC source signals all receivers in its active receiver's table when it writes new data to the shared memory area. See also transport_lbtipc_acknowledgement_interval (receiver).

Scope:	source
Type:	unsigned long int
Units:	milliseconds
Default value:	10,000 (10 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in LBM 4.0

transport_lbtrdma_datagram_max_size (context)  <-

DEPRECATED, the maximum datagram size that can be generated for a LBT-RDMA transport session. The default value is 4096, the minimum is 500 bytes, and the maximum is 4096.

See Message Fragmentation and Reassembly for more information.

Warning

When the DRO is in use, it is recommended that all UM applications and components (including the DRO and Persistent Store) share the same maximum datagram size setting. See Protocol Conversion.

Users of kernel-bypass drivers should also see Dynamic Fragmentation Reduction.

Scope:	context
Type:	lbm_uint_t
Units:	bytes
Default value:	4096
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_interface (source)  <-

DEPRECATED, do not use. Specifies the network interface over which UM LBT-RDMA sources receive connection requests from topic receivers.

You can specify the full IP address of the interface, or just the network part (see Specifying Interfaces for details).

Default is set to INADDR_ANY, meaning that it accepts incoming connection requests from any interface.

Be aware that the first source joining a transport session sets the interface with this option. Thus, setting a different interface for a subsequent topic that maps onto the same transport session will have no effect.

Scope:	source
Type:	lbm_ipv4_address_mask_t
Default value:	0.0.0.0 (INADDR_ANY)
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_maximum_ports (context)  <-

DEPRECATED, maximum number of LBT-RDMA sessions to allocate.

See Port Assignments for more information about configuring ports.

Scope:	context
Type:	lbm_uint16_t
Units:	number of ports
Default value:	5
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_port (source)  <-

DEPRECATED, port number for a specific source's LBT-RDMA session.

Must be outside the transport_lbtrdma_port_low (context) and transport_lbtrdma_port_high (context) range.

See Port Assignments for more information about configuring ports.

Scope:	source
Type:	lbm_uint16_t
Default value:	0 (zero)
Byte order:	Host
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_port_high (context)  <-

DEPRECATED, highest port number that can be assigned to a LBT-RDMA session.

See Port Assignments for more information about configuring ports.

Scope:	context
Type:	lbm_uint16_t
Default value:	20,020
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_port_low (context)  <-

DEPRECATED, lowest port number that can be assigned to a LBT-RDMA session.

See Port Assignments for more information about configuring ports.

Scope:	context
Type:	lbm_uint16_t
Default value:	20,001
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
Version:	This option was deprecated in UM 6.9

transport_lbtrdma_receiver_thread_behavior (context)  <-

DEPRECATED, receiver behavior for monitoring a LBT-RDMA source's shared memory area for new data.

LBT-RDMA is deprecated.

Scope:	context
Type:	int
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
Version:	This option was deprecated in UM 6.9

String value	Integer value	Description
"pend"	LBM_CTX_ATTR_RDMA_RCV_THREAD_PEND	Receiver waits (sleep) for notification from RDMA that the source has updated the shared memory area with new data. Default. Default for all.
"busy_wait"	LBM_CTX_ATTR_RDMA_RCV_THREAD_BUSY_WAIT	UM polls the shared memory area for new data.

transport_lbtrdma_transmission_window_size (source)  <-

DEPRECATED, size of an LBT-RDMA transport's shared memory area.

This value may vary across platforms. The actual size of the shared memory area equals the value you specify for this option plus about 64 KB for header information. The minimum value for this option is 65,536.

Refer to Source Object for additional information.

Scope:	source
Type:	size_t
Units:	bytes
Default value:	25165824 (24 MB)
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
Version:	This option was deprecated in UM 6.9

ume_message_map_tablesz (source)  <-

DEPRECATED, the size of the hash table that the source uses to store messages for the retention policy in effect.

A larger table means more messages can be stored more efficiently, but takes up more memory. A smaller table uses less memory, but costs more CPU time as more messages are retained. This setting no longer has any effect.

Scope:	source
Type:	size_t
Default value:	131
When to Set:	Can only be set during object initialization.
Version:	This option has been deprecated.

ume_primary_store_address (source)  <-

REMOVED. IPv4 address of the persistent Store to be used as the primary Store.

A value of 0.0.0.0 (or INADDR_ANY) indicates no Store is set as the primary. In other words, persistence is not enabled for the source.

This option is removed. Please use the ume_store (source) option instead.

Scope:	source
Type:	struct in_addr
Default value:	0.0.0.0 (INADDR_ANY)
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

ume_primary_store_port (source)  <-

REMOVED. TCP port of the primary persistent Store.

This option is removed. Please use the ume_store option instead.

See Port Assignments for more information about configuring ports.

Scope:	source
Type:	lbm_uint16_t
Default value:	14567
Byte order:	Network
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

ume_registration_id (source)  <-

DEPRECATED, 32-bit value that is used by a persistent Store to identify a source.

If a source desires to identify itself as a previously known source (after a crash or shutdown), it should set the ID to the value it was using before. A value of 0 indicates the source will allow the persistent Store to assign an ID. This option is deprecated. Its use is not recommended except by legacy systems. Please use the ume_store option instead.

Scope:	source
Type:	lbm_uint_t
Units:	identifier
Default value:	0 (allow persistent Store to assign ID)
When to Set:	Can only be set during object initialization.
Version:	This option was deprecated in UME 2.0

ume_retransmit_request_generation_interval (receiver)  <-

DEPRECATED, the maximum interval between when a retransmission request is first sent and when it is given up on and loss is reported.

This option is retained for backwards compatibility. The retransmit_request_generation_interval (receiver) option should be used instead.

Scope:	receiver
Type:	unsigned long int
Units:	milliseconds
Default value:	10000 (10 seconds)
When to Set:	Can only be set during object initialization.

ume_retransmit_request_interval (receiver)  <-

DEPRECATED, the interval between retransmission request messages to the persistent Store or to the source.

This option is retained for backwards compatibility. The retransmit_request_interval (receiver) option should be used instead.

Scope:	receiver
Type:	unsigned long int
Units:	milliseconds
Default value:	500 (0.5 seconds)
When to Set:	Can only be set during object initialization.

ume_retransmit_request_maximum (receiver)  <-

DEPRECATED, the maximum number of messages to request back from the current latest message when late joining a topic or when registering with a persistent Store.

A value of 0 indicates no maximum.

This option is retained for backwards compatibility. The retransmit_request_maximum (receiver) option should be used instead.

Scope:	receiver
Type:	unsigned long int
Units:	messages
Default value:	0
When to Set:	Can only be set during object initialization.

ume_retransmit_request_outstanding_maximum (receiver)  <-

DEPRECATED, the maximum number of messages to request at a single time from the Store or source.

A value of 0 indicates no maximum.

This option is retained for backwards compatibility. The retransmit_request_outstanding_maximum (receiver) option should be used instead.

Scope:	receiver
Type:	unsigned long int
Units:	messages
Default value:	10
When to Set:	Can only be set during object initialization.

ume_secondary_store_address (source)  <-

REMOVED. IPv4 address of the persistent Store to be used as the secondary Store.

A value of 0.0.0.0 (or INADDR_ANY) indicates no Store is set as the secondary.

This option is removed. Please use the ume_store (source) option instead.

Scope:	source
Type:	struct in_addr
Default value:	0.0.0.0 (INADDR_ANY)
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

ume_secondary_store_port (source)  <-

REMOVED. TCP port of the secondary persistent Store.

This option is removed. Please use the ume_store (source) option instead.

See Port Assignments for more information about configuring ports.

Scope:	source
Type:	lbm_uint16_t
Default value:	14567
Byte order:	Network
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

ume_tertiary_store_address (source)  <-

REMOVED. IPv4 address of the persistent Store to be used as the tertiary Store.

A value of 0.0.0.0 (or INADDR_ANY) indicates no Store is set as the tertiary.

This option is removed. Please use the ume_store (source) option instead.

Scope:	source
Type:	struct in_addr
Default value:	0.0.0.0 (INADDR_ANY)
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

ume_tertiary_store_port (source)  <-

REMOVED. TCP port of the tertiary persistent Store.

This option is removed. Please use the ume_store (source) option instead.

See Port Assignments for more information about configuring ports.

Scope:	source
Type:	lbm_uint16_t
Default value:	14567
Byte order:	Network
When to Set:	Can only be set during object initialization.
Version:	This option was removed in UME 2.0

umq_flight_size (context)  <-

DEPRECATED, 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).

See Ultra Load Balancing (ULB).

Scope:	context
Type:	unsigned int
Units:	messages
Default value:	1000
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
Version:	This option was deprecated in UMQ 6.8

umq_flight_size (source)  <-

DEPRECATED, 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).

See Ultra Load Balancing (ULB).

Scope:	source
Type:	unsigned int
Units:	messages
Default value:	1000
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
Version:	This option was deprecated in UM 6.8

umq_flight_size_behavior (context)  <-

DEPRECATED, the behavior that UMQ follows when a MIM send exceeds the context's flight size.

See Multicast Immediate Messaging for general information about MIM.

See umq_flight_size (source).

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
Version:	This option was deprecated in UMQ 6.8

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_EWOULDBLOCK. 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.

umq_flight_size_behavior (source)  <-

DEPRECATED, the behavior that UMQ follows when a message send exceeds the source's flight size.

See umq_flight_size (source).

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
Version:	This option was deprecated in UM 6.8

String value	Integer value	Description
"Block"	LBM_FLIGHT_SIZE_BEHAVIOR_BLOCK	The send call blocks when a source sends a message that exceeds its flight size. If the source uses a non-blocking send, the send returns an LBM_EWOULDBLOCK. 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.

umq_message_retransmission_interval (context)  <-

DEPRECATED, the interval between retransmissions of data messages when submitting to a Queue.

For general information on queuing, see Queuing.

Scope:	context
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	500 (0.5 seconds)
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.
Version:	This option was deprecated in UMQ 6.8

umq_message_stability_notification (context)  <-

DEPRECATED, 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.

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.
Version:	This option was deprecated in UMQ 6.8

Value	Description
1	The context wishes to receive message stability notification. Default for all.
0	The context does not wish to receive message stability notifications.

umq_msg_total_lifetime (context)  <-

DEPRECATED, establishes the period of time from when a queue receives a message, or, for ULB, when a source sends 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 set UMQ umestored option message-total-lifetime for the source's topic on the queue. However, the message-total-lifetime option is overridden by any value assigned to umq_msg_total_lifetime (source). The default value of 0 (zero) disables this option.

Note: This option is overridden by any message lifetime value set using send call, lbm_src_send_ex().

Scope:	context
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	0 (zero)
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in LBM 4.2 / UME 3.2 / UMQ 2.1
Version:	This option was deprecated in UMQ 6.8

umq_queue_check_interval (context)  <-

DEPRECATED, the interval between activity checks of the individual UMQ queues.

For general information on queuing, see Queuing.

Scope:	context
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	500 (0.5 seconds)
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.
Version:	This option was deprecated in UMQ 6.8

umq_queue_name (source)  <-

DEPRECATED, the queue to submit messages to when sending.

For general information on queuing, see Queuing.

Scope:	source
Type:	string
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.
Version:	This option was deprecated in UMQ 6.8

umq_queue_participants_only (source)  <-

DEPRECATED, flag indicating the source only desires queue participants to listen to the topic.

For general information on queuing, see Queuing.

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.
Version:	This option was deprecated in UMQ 6.8

Value	Description
1	The source desires that only queue participants listen to the topic.
0	The source desires anyone to listen to the topic without regard to queue participation. Default for all.

umq_queue_query_interval (context)  <-

DEPRECATED, the interval between queries sent for resolving Queues.

This option is no longer functional.

Scope:	context
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	200 (0.2 seconds)
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.
Version:	This option was deprecated in UMQ 6.8

umq_require_queue_authentication (context)  <-

DEPRECATED, indicates if an application requires a queue to authenticate itself before accepting the queue's responses to Queue Browser commands.

For general information on queuing, see Queuing.

Scope:	context
Type:	int
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.2.
Version:	This option was deprecated in UMQ 6.8

Value	Description
1	An application requires the queue to successfully authenticate before using browsing command responses from the queue. Default for all.
0	An application does not require queue authentication.

umq_retention_intergroup_stability_behavior (context)  <-

DEPRECATED, 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.
Version:	This option was deprecated in UMQ 6.8

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.

umq_retention_intergroup_stability_behavior (source)  <-

DEPRECATED, 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.
Version:	This option was deprecated in UMQ 6.8

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.

umq_retention_intragroup_stability_behavior (context)  <-

DEPRECATED, 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.
Version:	This option was deprecated in UMQ 6.8

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.

umq_retention_intragroup_stability_behavior (source)  <-

DEPRECATED, 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.
Version:	This option was deprecated in UMQ 6.8

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.

use_transport_thread (receiver)  <-

DEPRECATED, this option no longer functions.

It used to determine whether UM uses a thread from the receiver thread pool to process message data or if it uses the context thread, which is the default. The MTT feature is replaced in 6.11 and beyond by Transport Services Provider (XSP).

Scope:	receiver
Type:	int
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in LBM 4.1/UME 3.1.
Version:	This option was deprecated in UM 6.9
Version:	This option was removed from UM in UM 6.11

String value	Integer value	Description
"1"	1	UM uses a thread from the receiver thread pool.
"0"	0	UM uses the context thread to process message data. Default for all.