Metrics Engine Documentation Index
Configuration Reference Home

Traditional Work Queue

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

The Traditional Work Queue is a type of work queue that uses a number of worker threads that watch a queue and pick up an operation to process whenever one becomes available.

The traditional work queue is a FIFO queue serviced by a fixed number of worker threads. This fixed number of threads can be changed on the fly, with the change taking effect as soon as it is made. You can limit the size of the work queue to a specified number of operations. When this many operations are in the queue, waiting to be picked up by threads, any new requests are rejected with an error message.

Parent Component
Properties
dsconfig Usage

Parent Component

The Traditional Work Queue component inherits from the Work Queue

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ num-worker-threads  None
↓ max-work-queue-capacity

Basic Properties

num-worker-threads

Description
Specifies the number of worker threads to be used for processing operations placed in the queue. If the value is increased, the additional worker threads are created immediately. If the value is reduced, the appropriate number of threads are destroyed as operations complete processing.
Default Value
None
Allowed Values
An integer value. Lower limit is 1. Upper limit is 2147483647 .
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

max-work-queue-capacity

Description
Specifies the maximum number of queued operations that can be in the work queue at any given time. If the work queue is already full and additional requests are received by the server, the requests are rejected. A value of zero indicates that there is no limit to the size of the queue.
Default Value
0
Allowed Values
An integer value. Lower limit is 0. Upper limit is 2147483647 .
Multi-Valued
No
Required
No
Admin Action Required
The Metrics Engine must be restarted for changes to this setting to take effect. This modification requires that you manually restart the server for the change to take effect


dsconfig Usage

To view the Work Queue configuration:

dsconfig get-work-queue-prop
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the Work Queue configuration:

dsconfig set-work-queue-prop
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...