net.spy.memcached

Class MemcachedConnection

java.lang.Object

java.lang.Thread

net.spy.memcached.compat.SpyThread

net.spy.memcached.MemcachedConnection

All Implemented Interfaces:

java.lang.Runnable, ClusterConfigurationObserver, ConfigurationObserver

public class MemcachedConnection
extends SpyThread
implements ClusterConfigurationObserver

Connection to a cluster of memcached servers. MemcachedConnection also acts as an observer for cluster configuration changes. In the mode ClientMode.Dynamic, the ConfigurationPoller notifies the observers when there is change in cluster configuration.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MemcachedConnection(int bufSize, ConnectionFactory f, java.util.List<java.net.InetSocketAddress> socketAddressList, java.util.Collection<ConnectionObserver> obs, FailureMode fm, OperationFactory opfactory) Construct a MemcachedConnection.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addObserver(ConnectionObserver obs) Add a connection observer.
void	addOperations(java.util.Map<MemcachedNode,Operation> ops) Enqueue the given list of operations on each handling node.
java.util.concurrent.CountDownLatch	broadcastOperation(BroadcastOpFactory of) Broadcast an operation to all nodes.
java.util.concurrent.CountDownLatch	broadcastOperation(BroadcastOpFactory of, java.util.Collection<MemcachedNode> nodes) Broadcast an operation to a collection of nodes.
java.lang.String	connectionsStatus() Construct a String containing information about all nodes and their state.
void	enqueueOperation(java.net.InetSocketAddress addr, Operation o)
void	enqueueOperation(java.lang.String key, Operation o) Enqueue the given Operation with the used key.
NodeLocator	getLocator() Returns the NodeLocator in use for this connection.
void	handleIO() Handle all IO that flows through the connection.
void	insertOperation(MemcachedNode node, Operation o) Insert an operation on the given node to the beginning of the queue.
boolean	isShutDown() Returns whether the connection is shut down or not.
void	notifyUpdate(ClusterConfiguration clusterConfiguration) The publisher calls all the subscribers through this method.
static void	opSucceeded(Operation op) Reset the timeout counter for the given handling node.
static void	opTimedOut(Operation op) Increase the timeout counter for the given handling node.
void	redistributeOperation(Operation op) Redistribute the given operation to (potentially) other nodes.
void	redistributeOperations(java.util.Collection<Operation> ops) Redistribute the given list of operations to (potentially) other nodes.
boolean	removeObserver(ConnectionObserver obs) Remove a connection observer.
void	retryOperation(Operation op) Add a operation to the retry queue.
void	run() Handle IO as long as the application is running.
void	shutdown() Shut down all connections and do not accept further incoming ops.
java.lang.String	toString()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MemcachedConnection

public MemcachedConnection(int bufSize,
                   ConnectionFactory f,
                   java.util.List<java.net.InetSocketAddress> socketAddressList,
                   java.util.Collection<ConnectionObserver> obs,
                   FailureMode fm,
                   OperationFactory opfactory)
                    throws java.io.IOException

Construct a MemcachedConnection.

Parameters:

bufSize - the size of the buffer used for reading from the server

f - the factory that will provide an operation queue

socketAddressList - the addresses of the servers to connect to

obs - the initial observers to add.

fm - the failure mode to use.

opfactory - the operation factory.

Throws:

java.io.IOException - if a connection attempt fails early

Method Detail

notifyUpdate

public void notifyUpdate(ClusterConfiguration clusterConfiguration)

Description copied from interface: ClusterConfigurationObserver

The publisher calls all the subscribers through this method. This is invoked whenever there is change in cluster configuration data.

Specified by:

notifyUpdate in interface ClusterConfigurationObserver

Parameters:

clusterConfiguration - - The parameter contains the latest information about the cluster.

handleIO

public void handleIO()
              throws java.io.IOException

Handle all IO that flows through the connection. This method is called in an endless loop, listens on NIO selectors and dispatches the underlying read/write calls if needed.

Throws:

java.io.IOException

addObserver

public boolean addObserver(ConnectionObserver obs)

Add a connection observer.

Returns:

whether the observer was successfully added.

removeObserver

public boolean removeObserver(ConnectionObserver obs)

Remove a connection observer.

Returns:

true if the observer existed and now doesn't.

redistributeOperations

public void redistributeOperations(java.util.Collection<Operation> ops)

Redistribute the given list of operations to (potentially) other nodes. Note that operations can only be redistributed if they have not been cancelled already, timed out already or do not have definite targets (a key).

Parameters:

ops - the operations to redistribute.

redistributeOperation

public void redistributeOperation(Operation op)

Redistribute the given operation to (potentially) other nodes. Note that operations can only be redistributed if they have not been cancelled already, timed out already or do not have definite targets (a key).

Parameters:

op - the operation to redistribute.

getLocator

public NodeLocator getLocator()

Returns the NodeLocator in use for this connection.

Returns:

the current NodeLocator.

enqueueOperation

public void enqueueOperation(java.lang.String key,
                    Operation o)

Enqueue the given Operation with the used key.

Parameters:

key - the key to use.

o - the Operation to enqueue.

enqueueOperation

public void enqueueOperation(java.net.InetSocketAddress addr,
                    Operation o)

insertOperation

public void insertOperation(MemcachedNode node,
                   Operation o)

Insert an operation on the given node to the beginning of the queue.

Parameters:

node - the node where to insert the Operation.

o - the operation to insert.

addOperations

public void addOperations(java.util.Map<MemcachedNode,Operation> ops)

Enqueue the given list of operations on each handling node.

Parameters:

ops - the operations for each node.

broadcastOperation

public java.util.concurrent.CountDownLatch broadcastOperation(BroadcastOpFactory of)

Broadcast an operation to all nodes.

Returns:

a CountDownLatch that will be counted down when the operations are complete.

broadcastOperation

public java.util.concurrent.CountDownLatch broadcastOperation(BroadcastOpFactory of,
                                                     java.util.Collection<MemcachedNode> nodes)

Broadcast an operation to a collection of nodes.

Returns:

a CountDownLatch that will be counted down when the operations are complete.

shutdown

public void shutdown()
              throws java.io.IOException

Shut down all connections and do not accept further incoming ops.

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Thread

connectionsStatus

public java.lang.String connectionsStatus()

Construct a String containing information about all nodes and their state.

Returns:

a stringified representation of the connection status.

opTimedOut

public static void opTimedOut(Operation op)

Increase the timeout counter for the given handling node.

Parameters:

op - the operation to grab the node from.

opSucceeded

public static void opSucceeded(Operation op)

Reset the timeout counter for the given handling node.

Parameters:

op - the operation to grab the node from.

run

public void run()

Handle IO as long as the application is running.

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

isShutDown

public boolean isShutDown()

Returns whether the connection is shut down or not.

Returns:

true if the connection is shut down, false otherwise.

retryOperation

public void retryOperation(Operation op)

Add a operation to the retry queue.

Parameters:

op - the operation to retry.