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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acquireLock(String lockName, String lockHolder, Integer timeout) A non blocking lock utilizing Redis to create a lock that can be utilized by distributed servers.
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.

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,
                  Integer timeout)

A non blocking lock utilizing Redis to create a lock that can be utilized by distributed servers. Call this method again to renew your lock before it expires if you wish to guarantee holding the lock.

Parameters:

lockName - all calls to this method will contend for a unique lock with the name of lockName

timeout - seconds until the lock will expire

lockHolder - a unique string used to tell if you are the current holder of a lock for both acquisition, and extension

Returns:

Whether or not the lock was acquired.