net.greghaines.jesque.client

Interface Client

All Known Implementing Classes:

AbstractClient, ClientImpl, ClientPoolImpl

public interface Client

A Client allows Jobs to be enqueued for execution by Workers.

Author:

Greg Haines, Animesh Kumar

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acquireLock(String lockName, String lockHolder, int timeout) Acquire a non-blocking distributed lock.
void	delayedEnqueue(String queue, Job job, long future) Queues a job in a given queue to be run in the future.
void	end() Quits the connection to the Redis server.
void	enqueue(String queue, Job job) Queues a job in a given queue to be run.
void	priorityEnqueue(String queue, Job job) Queues a job with high priority in a given queue to be run.
void	recurringEnqueue(String queue, Job job, long future, long frequency) Queues a job to be in the future and recur
void	removeDelayedEnqueue(String queue, Job job) Removes a queued future job.
void	removeRecurringEnqueue(String queue, Job job) Removes a queued recurring job.

Method Detail

enqueue

void enqueue(String queue,
           Job job)

Queues a job in a given queue to be run.

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

Throws:

IllegalArgumentException - if the queue is null or empty or if the job is null

priorityEnqueue

void priorityEnqueue(String queue,
                   Job job)

Queues a job with high priority in a given queue to be run.

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

Throws:

IllegalArgumentException - if the queue is null or empty or if the job is null

end

void end()

Quits the connection to the Redis server.

acquireLock

boolean acquireLock(String lockName,
                  String lockHolder,
                  int timeout)

Acquire a non-blocking distributed lock. Calling this method again renews the lock.

Parameters:

lockName - the name of the lock to acquire

timeout - number of seconds until the lock will expire

lockHolder - a unique string identifying the caller

Returns:

true, if the lock was acquired, false otherwise

delayedEnqueue

void delayedEnqueue(String queue,
                  Job job,
                  long future)

Queues a job in a given queue to be run in the future.

Parameters:

queue - the queue to add the Job to

job - the job to be enqueued

future - timestamp when the job will run

Throws:

IllegalArgumentException - if the queue is null or empty, if the job is null or if the timestamp is not in the future

removeDelayedEnqueue

void removeDelayedEnqueue(String queue,
                        Job job)

Removes a queued future job.

Parameters:

queue - the queue to remove the Job from

job - the job to be removed

Throws:

IllegalArgumentException - if the queue is null or empty, if the job is null

recurringEnqueue

void recurringEnqueue(String queue,
                    Job job,
                    long future,
                    long frequency)

Queues a job to be in the future and recur

Parameters:

queue - the queue to add the Job too

job - the job to be enqueued

future - timestamp when the job will run

frequency - frequency in millis how often the job will run

Throws:

IllegalArgumentException - if the queue is null or empty, if the job is null

removeRecurringEnqueue

void removeRecurringEnqueue(String queue,
                          Job job)

Removes a queued recurring job.

Parameters:

queue - the queue to remove the Job from

job - the job to be removed

Throws:

IllegalArgumentException - if the queue is null or empty, if the job is null