Package wt.queue

Interface QueueService

All Known Implementing Classes:

StandardQueueService

@RemoteInterface
public interface QueueService

Interface containing the methods supported by the queue service implementations. Methods allow the creation, starting, stopping, deleting and customizing queue execution.

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
WtQueue	enableThreadPoolExecution(WtQueue queue)	Enables thread pool execution for this queue (and saves the change to the database).
WtQueue	enableThreadPoolExecution(WtQueue queue, boolean value)	Enables or disables thread pool execution for this queue (and saves the change to the database).

Method Details

enableThreadPoolExecution

WtQueue enableThreadPoolExecution(WtQueue queue)
                           throws WTException

Enables thread pool execution for this queue (and saves the change to the database).

This is currently only supported for ProcessingQueues. Calling this method with a ScheduleQueue will result in an exception.

When thread pool execution is enabled for a queue, there is no guaranteed order of entry execution. Rather than being first-in, first-out, the queue will execute on a less strict first-in, first-priority basis. In return, multiple threads (and multiple method servers) may execute entries in parallel for higher throughput.

Tuning of pool execution is necessary for optimal performance. One can control the thread pool size for a given queue via wt.queue.PoolQueue.QueueName.threadPoolSize in wt.properties, where the default is the value of wt.queue.execEntriesCount.

Customization code should never call this method with an out-of-the-box (non-custom) queue as an argument. Doing this is completely unsupported and could lead to serious data integrity issues.

Supported API: true

Parameters:

queue - Queue to enable thread pool execution for

Returns:

WtQueue

Throws:

WTException

enableThreadPoolExecution

WtQueue enableThreadPoolExecution(WtQueue queue,
 boolean value)
                           throws WTException

Enables or disables thread pool execution for this queue (and saves the change to the database).

This is currently only supported for ProcessingQueues. Calling this method with a ScheduleQueue will result in an exception.

When thread pool execution is enabled for a queue, there is no guaranteed order of entry execution. Rather than being first-in, first-out, the queue will execute on a less strict first-in, first-priority basis. In return, multiple threads (and multiple method servers) may execute entries in parallel for higher throughput.

Tuning of pool execution is necessary for optimal performance. One can control the thread pool size for a given queue via wt.queue.PoolQueue.QueueName.threadPoolSize in wt.properties, where the default is the value of wt.queue.execEntriesCount.

Customization code should never call this method with an out-of-the-box (non-custom) queue as an argument. Doing this is completely unsupported and could lead to serious data integrity issues.

Supported API: true

Parameters:

queue - Queue to enable thread pool execution for

value - Boolean to enable or disable usage of pool execution

Returns:

WtQueue

Throws:

WTException