org.openimaj.kestrel

Class KestrelServerSpec

java.lang.Object

org.openimaj.kestrel.KestrelServerSpec

public class KestrelServerSpec
extends Object

Define a connection to a single or set of Kestrel servers

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_KESTREL_MEMCACHED_PORT the default kestrel memcached port
static int	DEFAULT_KESTREL_TEXT_PORT the default kestrel text protocol port
static int	DEFAULT_KESTREL_THRIFT_PORT the default kestrel thrift port
String	host the kestrel host
static String	LOCALHOST the localhost
int	port the kestrel host port

Constructor Summary

Constructors

Constructor and Description
KestrelServerSpec(String kestrelHost, int port) A single kestrel host

Method Summary

Modifier and Type	Method and Description
void	close()
KestrelThriftClient	getValidClient() Get a valid Kestrel client, reconnecting if necessary
static String	kestrelAddressListAsString(List<KestrelServerSpec> kestrelSpecList, int port) Construct a string that looks like this: "host1:port1 host2:port2" from the list of KestrelServerSpec
static KestrelServerSpec	localMemcached()
static KestrelServerSpec	localText()
static KestrelServerSpec	localThrift()
static List<KestrelServerSpec>	parseKestrelAddressList(List<String> kestrelHosts) Parse a list of strings in the format: host:port.
static Iterator<KestrelThriftClient>	thriftClientIterator(List<KestrelServerSpec> kestrelSpecList) An iterator to access a list of KestrelServerSpec in a round robin fasion.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KESTREL_MEMCACHED_PORT

public static final int DEFAULT_KESTREL_MEMCACHED_PORT

the default kestrel memcached port

See Also:

Constant Field Values

DEFAULT_KESTREL_THRIFT_PORT

public static final int DEFAULT_KESTREL_THRIFT_PORT

the default kestrel thrift port

See Also:

Constant Field Values

DEFAULT_KESTREL_TEXT_PORT

public static final int DEFAULT_KESTREL_TEXT_PORT

the default kestrel text protocol port

See Also:

Constant Field Values

LOCALHOST

public static final String LOCALHOST

the localhost

See Also:

Constant Field Values

host

public String host

the kestrel host

port

public int port

the kestrel host port

Constructor Detail

KestrelServerSpec

public KestrelServerSpec(String kestrelHost,
                         int port)

A single kestrel host

Parameters:

kestrelHost -

port -

Method Detail

localMemcached

public static KestrelServerSpec localMemcached()

Returns:

a local server spec using memcached

localThrift

public static KestrelServerSpec localThrift()

Returns:

a local server spec using thrift

localText

public static KestrelServerSpec localText()

Returns:

a local server spec using text

parseKestrelAddressList

public static List<KestrelServerSpec> parseKestrelAddressList(List<String> kestrelHosts)

Parse a list of strings in the format: host:port. If either host or port is left blank then the default is used

Parameters:

kestrelHosts -

Returns:

all server specs

kestrelAddressListAsString

public static String kestrelAddressListAsString(List<KestrelServerSpec> kestrelSpecList,
                                                int port)

Construct a string that looks like this: "host1:port1 host2:port2" from the list of KestrelServerSpec

Parameters:

kestrelSpecList -

port -

Returns:

a string that looks like this: "host1:port1 host2:port2"

getValidClient

public KestrelThriftClient getValidClient()
                                   throws org.apache.thrift7.TException

Get a valid Kestrel client, reconnecting if necessary

Returns:

a valid client

Throws:

org.apache.thrift7.TException

thriftClientIterator

public static Iterator<KestrelThriftClient> thriftClientIterator(List<KestrelServerSpec> kestrelSpecList)

An iterator to access a list of KestrelServerSpec in a round robin fasion. This iterator will always return a next as long as there are KestrelServerSpec in the provided list.

Parameters:

kestrelSpecList -

Returns:

the iterator

close

public void close()