net.greghaines.jesque.client

Class ClientImpl

java.lang.Object

net.greghaines.jesque.client.AbstractClient

net.greghaines.jesque.client.ClientImpl

All Implemented Interfaces:

Client

public class ClientImpl
extends AbstractClient

Basic implementation of the Client interface.

Author:

Greg Haines, Animesh Kumar

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_CHECK_CONNECTION_BEFORE_USE

Constructor Summary

Constructors

Constructor and Description
ClientImpl(Config config) Create a new ClientImpl, which creates it's own connection to Redis using values from the config.
ClientImpl(Config config, boolean checkConnectionBeforeUse) Create a new ClientImpl, which creates it's own connection to Redis using values from the config.
ClientImpl(Config config, long initialDelay, long period, TimeUnit timeUnit) Create a new ClientImpl, which creates it's own connection to Redis using values from the config and spawns a thread to ensure the connection stays open.

Method Summary

Modifier and Type	Method and Description
protected boolean	doAcquireLock(String lockName, String lockHolder, int timeout) Actually acquire the lock based upon the client acquisition model.
protected void	doBatchEnqueue(String queue, List<String> jobsJson) Actually enqueue the serialized jobs.
protected void	doDelayedEnqueue(String queue, String msg, long future)
protected void	doEnqueue(String queue, String jobJson) Actually enqueue the serialized job.
protected void	doPriorityEnqueue(String queue, String jobJson) Actually enqueue the serialized job with high priority.
protected void	doRecurringEnqueue(String queue, String msg, long future, long frequency)
protected void	doRemoveDelayedEnqueue(String queue, String msg)
protected void	doRemoveRecurringEnqueue(String queue, String msg)
void	end() Quits the connection to the Redis server.

Methods inherited from class net.greghaines.jesque.client.AbstractClient

acquireLock, batchEnqueue, delayedEnqueue, doAcquireLock, doBatchEnqueue, doDelayedEnqueue, doEnqueue, doPriorityEnqueue, doRecurringEnqueue, doRemoveDelayedEnqueue, doRemoveRecurringEnqueue, enqueue, getNamespace, key, priorityEnqueue, recurringEnqueue, removeDelayedEnqueue, removeRecurringEnqueue

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHECK_CONNECTION_BEFORE_USE

public static final boolean DEFAULT_CHECK_CONNECTION_BEFORE_USE

See Also:

Constant Field Values

Constructor Detail

ClientImpl

public ClientImpl(Config config)

Create a new ClientImpl, which creates it's own connection to Redis using values from the config. It will not verify the connection before use.

Parameters:

config - used to create a connection to Redis

ClientImpl

public ClientImpl(Config config,
                  boolean checkConnectionBeforeUse)

Create a new ClientImpl, which creates it's own connection to Redis using values from the config.

Parameters:

config - used to create a connection to Redis

checkConnectionBeforeUse - check to make sure the connection is alive before using it

Throws:

IllegalArgumentException - if the config is null

ClientImpl

public ClientImpl(Config config,
                  long initialDelay,
                  long period,
                  TimeUnit timeUnit)

Create a new ClientImpl, which creates it's own connection to Redis using values from the config and spawns a thread to ensure the connection stays open.

Parameters:

config - used to create a connection to Redis

initialDelay - the time to delay first connection check

period - the period between successive connection checks

timeUnit - the time unit of the initialDelay and period parameters

Method Detail

doEnqueue

protected void doEnqueue(String queue,
                         String jobJson)

Actually enqueue the serialized job.

Specified by:

doEnqueue in class AbstractClient

Parameters:

queue - the queue to add the Job to

jobJson - the serialized Job

doBatchEnqueue

protected void doBatchEnqueue(String queue,
                              List<String> jobsJson)

Actually enqueue the serialized jobs.

Specified by:

doBatchEnqueue in class AbstractClient

Parameters:

queue - the queue to add the Jobs to

jobsJson - the serialized Jobs

doPriorityEnqueue

protected void doPriorityEnqueue(String queue,
                                 String jobJson)

Actually enqueue the serialized job with high priority.

Specified by:

doPriorityEnqueue in class AbstractClient

Parameters:

queue - the queue to add the Job to

jobJson - the serialized Job

doAcquireLock

protected boolean doAcquireLock(String lockName,
                                String lockHolder,
                                int timeout)
                         throws Exception

Actually acquire the lock based upon the client acquisition model.

Specified by:

doAcquireLock in class AbstractClient

Parameters:

lockName - the name of the lock to acquire

lockHolder - a unique string identifying the caller

timeout - number of seconds until the lock will expire

Returns:

true, if the lock was acquired, false otherwise

Throws:

Exception - in case something goes wrong

end

public void end()

Quits the connection to the Redis server.

doDelayedEnqueue

protected void doDelayedEnqueue(String queue,
                                String msg,
                                long future)
                         throws Exception

Specified by:

doDelayedEnqueue in class AbstractClient

Throws:

Exception

doRemoveDelayedEnqueue

protected void doRemoveDelayedEnqueue(String queue,
                                      String msg)
                               throws Exception

Specified by:

doRemoveDelayedEnqueue in class AbstractClient

Throws:

Exception

doRecurringEnqueue

protected void doRecurringEnqueue(String queue,
                                  String msg,
                                  long future,
                                  long frequency)
                           throws Exception

Specified by:

doRecurringEnqueue in class AbstractClient

Throws:

Exception

doRemoveRecurringEnqueue

protected void doRemoveRecurringEnqueue(String queue,
                                        String msg)
                                 throws Exception

Specified by:

doRemoveRecurringEnqueue in class AbstractClient

Throws:

Exception