org.jredis.connector

Interface ConnectionSpec

All Known Implementing Classes:

ConnectionSpec.RefImpl, DefaultConnectionSpec

public interface ConnectionSpec

ConnectionSpec specifies the parameters used in the creation and runtime operation of JRedis connections.

Author:

joubin (alphazero@sensesay.net)

See Also:

Factory#newConnection(ConnectionSpec), java.resource.cci.ConnectionSpec

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConnectionSpec.RefImpl Reference implementation of ConnectionSpec.

Method Summary

Modifier and Type	Method and Description
InetAddress	getAddress()
boolean	getConnectionFlag(Connection.Flag flag)
Object	getConnectionProperty(Connection.Property prop)
byte[]	getCredentials()
int	getDatabase()
int	getHeartbeat()
int	getMaxConnectWait()
Connection.Modality	getModality()
int	getPort()
int	getReconnectCnt()
boolean	getSocketFlag(Connection.Socket.Flag flag) Get the SocketFlag for the ConnectionSpec
Integer	getSocketProperty(Connection.Socket.Property property) Get the Connection.Socket.Property for the ConnectionSpec
ConnectionSpec	setAddress(InetAddress address)
ConnectionSpec	setConnectionFlag(Connection.Flag flag, Boolean value) Sets the specified Connection.Flag
ConnectionSpec	setConnectionProperty(Connection.Property prop, Object value)
ConnectionSpec	setCredentials(byte[] credentials) Set the Connection's credentials, presented to Redis on (re)connects.
ConnectionSpec	setCredentials(String credentials) Convenience method
ConnectionSpec	setDatabase(int database)
ConnectionSpec	setHeartbeat(int seconds)
ConnectionSpec	setMaxConnectWait(int cnt)
ConnectionSpec	setModality(Connection.Modality modality)
ConnectionSpec	setPort(int port)
ConnectionSpec	setReconnectCnt(int cnt)
ConnectionSpec	setSocketFlag(Connection.Socket.Flag flag, Boolean value) Set the Connection.Socket.Flag for the ConnectionSpec
ConnectionSpec	setSocketProperty(Connection.Socket.Property property, Integer value) Set the SocketProperty for the ConnectionSpec

Method Detail

getAddress

InetAddress getAddress()

Returns:

setAddress

ConnectionSpec setAddress(InetAddress address)

Parameters:

address -

Returns:

the ConnectionSpec

getPort

int getPort()

Returns:

the port number for the connection

setPort

ConnectionSpec setPort(int port)

Parameters:

port -

Returns:

the ConnectionSpec

getCredentials

byte[] getCredentials()

Returns:

the password (if any) for the connection. Used on (re-)connect to authenticate the client after connectivity has been established

See Also:

Command#AUTH

setCredentials

ConnectionSpec setCredentials(byte[] credentials)

Set the Connection's credentials, presented to Redis on (re)connects.

Parameters:

credentials -

Returns:

the ConnectionSpec

See Also:

setCredentials(String)

setCredentials

ConnectionSpec setCredentials(String credentials)

Convenience method

Parameters:

credentials -

Returns:

the ConnectionSpec

See Also:

setCredentials(byte[])

getDatabase

int getDatabase()

Returns:

the database selected for the connection. Used on (re-)connect to select the db after network connectivity has been established.

See Also:

Command#SELECT

setDatabase

ConnectionSpec setDatabase(int database)

Parameters:

database -

Returns:

the ConnectionSpec

getModality

Connection.Modality getModality()

Returns:

the Connection.Modality of this protocol handler.

setModality

ConnectionSpec setModality(Connection.Modality modality)

Parameters:

modality -

Returns:

the the ConnectionSpec

getSocketFlag

boolean getSocketFlag(Connection.Socket.Flag flag)

Get the SocketFlag for the ConnectionSpec

Parameters:

flag -

Returns:

the specified TCP socket flag used for the connection.

See Also:

SocketFlag

setSocketFlag

ConnectionSpec setSocketFlag(Connection.Socket.Flag flag,
                             Boolean value)

Set the Connection.Socket.Flag for the ConnectionSpec

Parameters:

flag -

value -

Returns:

ConnectionSpec this

getSocketProperty

Integer getSocketProperty(Connection.Socket.Property property)

Get the Connection.Socket.Property for the ConnectionSpec

Parameters:

property -

Returns:

the specified socket property used for the connection.

See Also:

SocketFlag

setSocketProperty

ConnectionSpec setSocketProperty(Connection.Socket.Property property,
                                 Integer value)

Set the SocketProperty for the ConnectionSpec

Parameters:

property -

value -

Returns:

the previous value (if any). Null if none existed, per Map.put(Object, Object) semantics.

getConnectionFlag

boolean getConnectionFlag(Connection.Flag flag)

Parameters:

flag -

Returns:

the Connection.Flag

See Also:

SocketFlag

setConnectionFlag

ConnectionSpec setConnectionFlag(Connection.Flag flag,
                                 Boolean value)

Sets the specified Connection.Flag

Parameters:

flag -

value -

Returns:

the referenced ConnectionSpec

getConnectionProperty

Object getConnectionProperty(Connection.Property prop)

Type Parameters:

T -

Parameters:

proptype -

Returns:

setConnectionProperty

ConnectionSpec setConnectionProperty(Connection.Property prop,
                                     Object value)

Type Parameters:

T -

Parameters:

property -

value -

Returns:

getReconnectCnt

int getReconnectCnt()

Returns:

setReconnectCnt

ConnectionSpec setReconnectCnt(int cnt)

Parameters:

cnt -

Returns:

the ConnectionSpec

getMaxConnectWait

int getMaxConnectWait()

Returns:

setMaxConnectWait

ConnectionSpec setMaxConnectWait(int cnt)

Parameters:

cnt -

Returns:

the ConnectionSpec

getHeartbeat

int getHeartbeat()

Returns:

the heartbeat period in seconds

setHeartbeat

ConnectionSpec setHeartbeat(int seconds)

Parameters:

seconds - heartbeat period

Returns:

the ConnectionSpec