Configuration Guide

Event Queue Options

# Reference <-

## event_queue_name (event_queue) <-

  The name of an event queue, limited to 128 alphanumeric characters, hyphens or underscores.

  This is only used for XML Configuration Files.

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | string
  When to Set: | Can only be set during object initialization.
  Version: | This option was implemented in LBM 4.3/UME 3.3/UMQ 2.3.

## queue_age_enabled (event_queue) <-

  Controls whether the length of time each event spends on the event queue is measured.

  Useful only if you are monitoring event queue statistics.

  See Event Queue Object for a full description of Event Queues.

  See Monitoring for an overview of monitoring an Ultra Messaging network.

  Scope: | event_queue
  Type: | int
  Default value: | 0
  When to Set: | May be set during operation.

  Value | Description
  --- | ---
  1 | Enables measuring of event queue entry ages.
  0 | Disables measuring of event queue entry ages. Default for all.

## queue_cancellation_callbacks_enabled (event_queue) <-

  Flag indicating whether the event queue is to do appropriate locking to provide cancellation callback support for cancel/delete functions.

  This must be enabled if you want to use the extended form of object deletion with a callback that indicates completion of the deletion.

  For example, see lbm_src_delete_ex().

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | int
  When to Set: | Can only be set during object initialization.

  Value | Description
  --- | ---
  1 | Provide support for cancellation callbacks.
  0 | Do not provide cancellation callback support. Default for all.

## queue_count_enabled (event_queue) <-

  Controls whether the numbers of each type of queue entry are counted.

  Useful only if you are monitoring event queue statistics.

  See Event Queue Object for a full description of Event Queues.

  See Monitoring for an overview of monitoring an Ultra Messaging network.

  Scope: | event_queue
  Type: | int
  Default value: | 0
  When to Set: | May be set during operation.

  Value | Description
  --- | ---
  1 | Enables counting event queue entries.
  0 | Disables counting of event queue entries. Default for all.

## queue_delay_warning (event_queue) <-

  The event queue delay threshold (in microseconds) at which the monitor function for the event queue is called.

  This delay is the time that an event has been queued before being dispatched. A value of 0 indicates the event queue delay is not to be monitored and checked.

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | lbm_ulong_t
  Units: | microseconds
  Default value: | 0 (not monitored)
  When to Set: | May be set during operation.

## queue_enqueue_notification (event_queue) <-

  Flag indicating whether to call the monitor function when an event is enqueued into the given event queue.

  The thread enqueuing the event is the one that calls this function. So, when this is called, the monitoring function in use should only assume this is only notification of enqueuing. The monitor function should not dispatch events directly.

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | int
  When to Set: | May be set during operation.

  Value | Description
  --- | ---
  1 | Enable notification.
  0 | Disable notification. Default for all.

## queue_objects_purged_on_close (event_queue) <-

  Flag indicating whether the event queue should be immediately purged of any pending events associated with a recently closed object (e.g. source, receiver) during the close operation, or be left on the queue to be discarded as the event queue drains normally.

  In either case, UM does not deliver the defunct events to the application. The `Immediate purge` setting reclaims memory immediately, while the `Delay purge` setting spreads the reclamation work over time, reducing the CPU impact of closing objects associated with the queue.

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | int
  When to Set: | Can only be set during object initialization.

  Value | Description
  --- | ---
  1 | Immediate purge. Default for all.
  0 | Delay purge.

## queue_service_time_enabled (event_queue) <-

  Controls whether the amount of time required to service each event on the event queue is measured.

  Useful only if you are monitoring event queue statistics.

  See Event Queue Object for a full description of Event Queues.

  See Monitoring for an overview of monitoring an Ultra Messaging network.

  Scope: | event_queue
  Type: | int
  Default value: | 0
  When to Set: | May be set during operation.

  Value | Description
  --- | ---
  1 | Enables measuring of event queue service times.
  0 | Disables measuring of event queue service times. Default for all.

## queue_size_warning (event_queue) <-

  The event queue size threshold (in number of events) at which the monitor function for the event queue is called.

  A value of 0 indicates the event queue size is not to be monitored and checked.

  See Event Queue Object for a full description of Event Queues.

  Scope: | event_queue
  Type: | lbm_ulong_t
  Units: | number of events
  Default value: | 0 (not monitored)
  When to Set: | May be set during operation.