com.aspc.job

Class QueueConfig

java.lang.Object

com.aspc.job.QueueConfig

public class QueueConfig
extends java.lang.Object

Handles jobs.
THREAD MODE: SINGLE-THREADED

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
DBQueue	queue The queue.

Constructor Summary

Constructors

Constructor and Description
QueueConfig(DBQueue queue) constructor

Method Summary

Modifier and Type	Method and Description
QueueConfig	disable() Disable the job manager queue
QueueConfig	enable() Enable the job manager queue
long	getBidDelayPerJob() The amount of time to pause per job.
java.lang.String	getFilter() get the filter
long	getMaxPause() Get the max pause time
int	getOpenSlots() The number of open slots
boolean	isEnable() is the queue enabled ?
QueueConfig	setBidDelayPerJob(long msecs) The amount of time to pause per job.
QueueConfig	setBidDelayPerJob(java.lang.String duration) The amount of time to pause per job.
QueueConfig	setFilter(java.lang.String filter) Set the max pause time.
QueueConfig	setMaxPause(long msecs) Set the max pause time.
QueueConfig	setOpenSlots(int maxSlots) The maximum number of slots open in this worker.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

queue

public final DBQueue queue

The queue.

Constructor Detail

QueueConfig

public QueueConfig(@Nonnull
                   DBQueue queue)

constructor

Parameters:

queue - The raw queue

Method Detail

setOpenSlots

public QueueConfig setOpenSlots(int maxSlots)

The maximum number of slots open in this worker.

Parameters:

maxSlots - The number of slots open

Returns:

this

getOpenSlots

@CheckReturnValue
public int getOpenSlots()

The number of open slots

Returns:

the number of open slots, zero if the queue is disabled.

getMaxPause

@CheckReturnValue
public long getMaxPause()

Get the max pause time

Returns:

milliseconds

disable

public QueueConfig disable()

Disable the job manager queue

Returns:

this

enable

public QueueConfig enable()

Enable the job manager queue

Returns:

this;

isEnable

@CheckReturnValue
public boolean isEnable()

is the queue enabled ?

Returns:

true if enabled.

setMaxPause

public QueueConfig setMaxPause(long msecs)

Set the max pause time.

Parameters:

msecs - The max pause time

Returns:

this

getFilter

@CheckReturnValue
 @Nullable
public java.lang.String getFilter()

get the filter

Returns:

milliseconds

setFilter

public QueueConfig setFilter(@Nullable
                             java.lang.String filter)

Set the max pause time.

Parameters:

filter - the filter

Returns:

this

getBidDelayPerJob

@CheckReturnValue
public long getBidDelayPerJob()

The amount of time to pause per job.

Returns:

milliseconds

setBidDelayPerJob

public QueueConfig setBidDelayPerJob(long msecs)

The amount of time to pause per job.

Parameters:

msecs - to pause

Returns:

this

setBidDelayPerJob

public QueueConfig setBidDelayPerJob(java.lang.String duration)
                              throws InvalidDataException

The amount of time to pause per job.

Parameters:

duration - to pause

Returns:

this

Throws:

InvalidDataException