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

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

Methods

Modifier and Type	Method and Description
protected boolean	doAcquireLock(String lockName, String lockHolder, Integer timeout) Actually acquire the lock based upon the client acquisition model
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.
void	end() Quits the connection to the Redis server.

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

acquireLock, doAcquireLock, doEnqueue, doPriorityEnqueue, enqueue, getNamespace, key, priorityEnqueue

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)

Description copied from class: AbstractClient

Actually enqueue the serialized job.

Specified by:

doEnqueue in class AbstractClient

Parameters:

queue - the queue to add the Job to

jobJson - the serialized Job

doPriorityEnqueue

protected void doPriorityEnqueue(String queue,
                     String jobJson)

Description copied from class: AbstractClient

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

Description copied from class: AbstractClient

Actually acquire the lock based upon the client acquisition model

Specified by:

doAcquireLock in class AbstractClient

Parameters:

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

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

timeout - seconds until the lock will expire

Returns:

Whether or not the lock was acquired.

Throws:

Exception

end

public void end()

Description copied from interface: Client

Quits the connection to the Redis server.