org.openimaj.kestrel

Class SimpleKestrelClient

java.lang.Object

org.openimaj.kestrel.SimpleKestrelClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class SimpleKestrelClient
extends Object
implements Closeable

A simple Kestrel client taken from https://github.com/hogelog/simple-kestrel-client by Hogelog. Using this one over KestrelThriftClient which seemed to have some major issues

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
SimpleKestrelClient(InetSocketAddress addr) initialise a Client instance using ServiceFactory from a ClientBuilder
SimpleKestrelClient(String host, int port) Initialise an InetSocketAddress.InetSocketAddress(String, int) instance

Method Summary

Modifier and Type	Method and Description
void	close()
void	delete(String queueName) Calls Client.delete(String) on the underlying Client instance.
String	get(String queueName) Get the next value in the queue
String	get(String queueName, com.twitter.util.Duration waitDuration) Get the next value from the queue
String	get(String queueName, int waitFor) Get the next value in the queue
byte[]	getByte(String queueName) Get the next value in the queue
byte[]	getByte(String queueName, com.twitter.util.Duration waitDuration) Get the next value from the queue
byte[]	getByte(String queueName, int waitFor) Get the next value in the queue
String	peek(String queueName) Get the next value without popping it
String	peek(String queueName, com.twitter.util.Duration waitDuration) The next value without popping it
String	peek(String queueName, int waitFor) The next value without popping it
byte[]	peekByte(String queueName) Get the next value without popping it
byte[]	peekByte(String queueName, com.twitter.util.Duration waitDuration) The next value without popping it
byte[]	peekByte(String queueName, int waitFor) The next value without popping it
void	set(String queueName, byte[] value) Performs a put with the byte array value with no expiration
void	set(String queueName, int exp, byte[] value) Performs a put with the byte array valye with an expiration
void	set(String queueName, int exp, String value) Performs a put kestrel call with the provided expiration.
void	set(String queueName, String value) Performs a put kestrel call on the string value with a expiary of 0 (i.e.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleKestrelClient

public SimpleKestrelClient(String host,
                           int port)

Initialise an InetSocketAddress.InetSocketAddress(String, int) instance

Parameters:

host -

port -

SimpleKestrelClient

public SimpleKestrelClient(InetSocketAddress addr)

initialise a Client instance using ServiceFactory from a ClientBuilder

Parameters:

addr -

Method Detail

delete

public void delete(String queueName)

Calls Client.delete(String) on the underlying Client instance. This deletes the underlying journal instance in the kestrel queue

Parameters:

queueName -

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

set

public void set(String queueName,
                String value)

Performs a put kestrel call on the string value with a expiary of 0 (i.e. does not expire)

Parameters:

queueName -

value -

set

public void set(String queueName,
                int exp,
                String value)

Performs a put kestrel call with the provided expiration.

Parameters:

queueName -

exp -

value -

set

public void set(String queueName,
                byte[] value)

Performs a put with the byte array value with no expiration

Parameters:

queueName -

value -

set

public void set(String queueName,
                int exp,
                byte[] value)

Performs a put with the byte array valye with an expiration

Parameters:

queueName -

exp -

value -

get

public String get(String queueName)

Get the next value in the queue

Parameters:

queueName -

Returns:

the next value

getByte

public byte[] getByte(String queueName)

Get the next value in the queue

Parameters:

queueName -

Returns:

the next value

getByte

public byte[] getByte(String queueName,
                      int waitFor)

Get the next value in the queue

Parameters:

queueName -

waitFor -

Returns:

the next value

get

public String get(String queueName,
                  int waitFor)

Get the next value in the queue

Parameters:

queueName -

waitFor -

Returns:

the next value

get

public String get(String queueName,
                  com.twitter.util.Duration waitDuration)

Get the next value from the queue

Parameters:

queueName -

waitDuration -

Returns:

the next value

getByte

public byte[] getByte(String queueName,
                      com.twitter.util.Duration waitDuration)

Get the next value from the queue

Parameters:

queueName -

waitDuration - an amount of time to wait before returning null

Returns:

the next value

peek

public String peek(String queueName)

Get the next value without popping it

Parameters:

queueName -

Returns:

the next value

peek

public String peek(String queueName,
                   int waitFor)

The next value without popping it

Parameters:

queueName -

waitFor - an amount of time to wait before returning null

Returns:

the next value

peek

public String peek(String queueName,
                   com.twitter.util.Duration waitDuration)

The next value without popping it

Parameters:

queueName -

waitDuration - an amount of time to wait before returning null

Returns:

the next value

peekByte

public byte[] peekByte(String queueName)

Get the next value without popping it

Parameters:

queueName -

Returns:

the next value

peekByte

public byte[] peekByte(String queueName,
                       int waitFor)

The next value without popping it

Parameters:

queueName -

waitFor - an amount of time to wait before returning null

Returns:

the next value

peekByte

public byte[] peekByte(String queueName,
                       com.twitter.util.Duration waitDuration)

The next value without popping it

Parameters:

queueName -

waitDuration - an amount of time to wait before returning null

Returns:

the next value