net.greghaines.jesque.worker

Interface Worker

All Superinterfaces:

JobExecutor, Runnable, WorkerEventEmitter

All Known Implementing Classes:

WorkerExitOnEmpty, WorkerImpl, WorkerPool

public interface Worker
extends JobExecutor, Runnable, WorkerEventEmitter

A Worker polls for Jobs from a specified list of queues, executing them in sequence and notifying WorkerListeners in the process.

Workers are designed to be run in a Thread or an ExecutorService. E.g.:

 final Worker worker = new WorkerImpl(config, Worker.ALL_QUEUES, 
                Arrays.asList("TestAction"));
 final Thread t = new Thread(worker);
 t.start();
 Thread.yield();
 ...
 worker.end();
 t.join();
 

Author:

Greg Haines

Nested Class Summary

Nested classes/interfaces inherited from interface net.greghaines.jesque.worker.JobExecutor

JobExecutor.State

Field Summary

Fields

Modifier and Type	Field and Description
static Collection<String>	ALL_QUEUES Special value to tell a Worker to poll all currently available queues.

Method Summary

Methods

Modifier and Type	Method and Description
void	addQueue(String queueName) Poll the given queue.
String	getName() Returns the name of this Worker.
Collection<String>	getQueues() The queues that this Worker will poll.
boolean	isPaused() Returns whether this worker is paused.
void	removeAllQueues() Stop polling all queues.
void	removeQueue(String queueName, boolean all) Stop polling the given queue.
void	setQueues(Collection<String> queues) Clear any current queues and poll the given queues.
void	togglePause(boolean paused) Toggle whether this worker will process any new jobs.

Methods inherited from interface net.greghaines.jesque.worker.JobExecutor

addJobType, end, getExceptionHandler, getJobTypes, isProcessingJob, isShutdown, join, removeJobName, removeJobType, setExceptionHandler, setJobTypes

Methods inherited from interface java.lang.Runnable

run

Methods inherited from interface net.greghaines.jesque.worker.WorkerEventEmitter

addListener, addListener, removeAllListeners, removeAllListeners, removeListener, removeListener

Field Detail

ALL_QUEUES

static final Collection<String> ALL_QUEUES

Special value to tell a Worker to poll all currently available queues.

Method Detail

getName

String getName()

Returns the name of this Worker.

Returns:

the name of this Worker

isPaused

boolean isPaused()

Returns whether this worker is paused.

Returns:

whether this worker is paused. If true, the worker is not processing any new jobs; if false, the worker is processing new jobs

togglePause

void togglePause(boolean paused)

Toggle whether this worker will process any new jobs.

Parameters:

paused - if true, the worker will not process any new jobs; if false, the worker will process new jobs

getQueues

Collection<String> getQueues()

The queues that this Worker will poll.

Returns:

an unmodifiable view of the queues to be polled

addQueue

void addQueue(String queueName)

Poll the given queue. If the queue exists multiple times, it will be checked that many times per loop. This allows for a queue to be given higher priority by checking it more often.

Parameters:

queueName - the name of the queue to poll

removeQueue

void removeQueue(String queueName,
               boolean all)

Stop polling the given queue. If the all argument is true, all instances of the queue will be removed, otherwise, only one instance is removed.

Parameters:

queueName - the queue to stop polling

all - whether to remove all or only one of the instances

removeAllQueues

void removeAllQueues()

Stop polling all queues.

setQueues

void setQueues(Collection<String> queues)

Clear any current queues and poll the given queues.

Parameters:

queues - the queues to poll