DefaultConnectionFactory

java.lang.Object
- net.spy.memcached.compat.SpyObject
- - net.spy.memcached.DefaultConnectionFactory

All Implemented Interfaces:

ConnectionFactory

Direct Known Subclasses:

BinaryConnectionFactory, KetamaConnectionFactory
```
public class DefaultConnectionFactory
extends SpyObject
implements ConnectionFactory
```
Default implementation of ConnectionFactory.
This implementation creates connections where the operation queue is an ArrayBlockingQueue and the read and write queues are unbounded LinkedBlockingQueues. The Redistribute FailureMode is always used. If other FailureModes are needed, look at the ConnectionFactoryBuilder.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_AUTH_WAIT_TIME` The time to wait for the authentication to complete when a operation is written in milliseconds.
`static ClientMode`	`DEFAULT_CLIENT_MODE` Default client mode.
`static FailureMode`	`DEFAULT_FAILURE_MODE` Default failure mode.
`static HashAlgorithm`	`DEFAULT_HASH` Default hash algorithm.
`static long`	`DEFAULT_MAX_RECONNECT_DELAY` Maximum amount of time (in seconds) to wait between reconnect attempts.
`static int`	`DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD` Maximum number + 2 of timeout exception for shutdown connection.
`static MetricType`	`DEFAULT_METRIC_TYPE` Turn off metric collection by default.
`static int`	`DEFAULT_OP_QUEUE_LEN` Maximum length of the operation queue returned by this connection factory.
`static long`	`DEFAULT_OP_QUEUE_MAX_BLOCK_TIME` The maximum time to block waiting for op queue operations to complete, in milliseconds.
`static long`	`DEFAULT_OPERATION_TIMEOUT` Default operation timeout in milliseconds.
`static int`	`DEFAULT_READ_BUFFER_SIZE` The read buffer size for each server connection from this factory.

Constructor Summary

Constructors
Constructor and Description
`DefaultConnectionFactory()`
`DefaultConnectionFactory(ClientMode clientMode)` Create a DefaultConnectionFactory with the default parameters.
`DefaultConnectionFactory(ClientMode clientMode, int qLen, int bufSize)` Create a DefaultConnectionFactory with the given maximum operation queue length, and the given read buffer size.
`DefaultConnectionFactory(ClientMode clientMode, int qLen, int bufSize, HashAlgorithm hash)` Construct a DefaultConnectionFactory with the given parameters.
`DefaultConnectionFactory(int qLen, int bufSize)` Create a DefaultConnectionFactory with the given maximum operation queue length, and the given read buffer size.

Method Summary

Methods
Modifier and Type	Method and Description
`MemcachedConnection`	`createConnection(java.util.List<java.net.InetSocketAddress> addrs)` Create a MemcachedConnection for the given SocketAddresses.
`NodeLocator`	`createLocator(java.util.List<MemcachedNode> nodes)` Create a NodeLocator instance for the given list of nodes.
`MemcachedNode`	`createMemcachedNode(java.net.SocketAddress sa, java.nio.channels.SocketChannel c, int bufSize)` Create a new memcached node.
`java.util.concurrent.BlockingQueue<Operation>`	`createOperationQueue()` Create a BlockingQueue for operations for a connection.
`java.util.concurrent.BlockingQueue<Operation>`	`createReadOperationQueue()` Create a BlockingQueue for the operations currently expecting to read responses from memcached.
`java.util.concurrent.BlockingQueue<Operation>`	`createWriteOperationQueue()` Create a BlockingQueue for the operations currently expecting to write requests to memcached.
`MetricType`	`enableMetrics()` If true, metric collections are enabled.
`AuthDescriptor`	`getAuthDescriptor()` Authenticate connections using the given auth descriptor.
`long`	`getAuthWaitTime()` The time to wait until authentication completes when an operation is inserted.
`ClientMode`	`getClientMode()` The mode in which the client is operating.
`Transcoder<java.lang.Object>`	`getDefaultTranscoder()` Get the default transcoder to be used in connections created by this factory.
`long`	`getDynamicModePollingInterval()` The interval used for periodic polling of configuration.
`FailureMode`	`getFailureMode()` Get the default failure mode for the underlying connection.
`HashAlgorithm`	`getHashAlg()` Get the hash algorithm to be used.
`java.util.Collection<ConnectionObserver>`	`getInitialObservers()` Observers that should be established at the time of connection instantiation.
`java.util.concurrent.ExecutorService`	`getListenerExecutorService()` Returns the stored `ExecutorService` for listeners.
`long`	`getMaxReconnectDelay()` Maximum number of milliseconds to wait between reconnect attempts.
`MetricCollector`	`getMetricCollector()` The currently active `MetricCollector`.
`OperationFactory`	`getOperationFactory()` Get the operation factory for connections built by this connection factory.
`long`	`getOperationTimeout()` Get the operation timeout used by this connection.
`int`	`getOpQueueLen()` Get the op queue length set at construct time.
`long`	`getOpQueueMaxBlockTime()` Get the maximum amount of time (in milliseconds) a client is willing to wait to add a new item to a queue.
`int`	`getReadBufSize()`
`int`	`getTimeoutExceptionThreshold()` Maximum number of timeout exception for shutdown connection.
`boolean`	`isDaemon()` If true, the IO thread should be a daemon thread.
`boolean`	`isDefaultExecutorService()` Returns true if the default provided `ExecutorService` has not been overriden through the builder.
`boolean`	`shouldOptimize()` If true, low-level optimization is in effect.
`java.lang.String`	`toString()`
`boolean`	`useNagleAlgorithm()` If true, the nagle algorithm will be used on connected sockets.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_CLIENT_MODE
```
public static final ClientMode DEFAULT_CLIENT_MODE
```
    Default client mode.
  - DEFAULT_FAILURE_MODE
```
public static final FailureMode DEFAULT_FAILURE_MODE
```
    Default failure mode.
  - DEFAULT_HASH
```
public static final HashAlgorithm DEFAULT_HASH
```
    Default hash algorithm.
  - DEFAULT_OP_QUEUE_LEN
```
public static final int DEFAULT_OP_QUEUE_LEN
```
    Maximum length of the operation queue returned by this connection factory.
    
    See Also:
    Constant Field Values
  - DEFAULT_OP_QUEUE_MAX_BLOCK_TIME
```
public static final long DEFAULT_OP_QUEUE_MAX_BLOCK_TIME
```
    The maximum time to block waiting for op queue operations to complete, in milliseconds. The default has been set with the expectation that most requests are interactive and waiting for more than a few seconds is thus more undesirable than failing the request.
  - DEFAULT_READ_BUFFER_SIZE
```
public static final int DEFAULT_READ_BUFFER_SIZE
```
    The read buffer size for each server connection from this factory.
    
    See Also:
    Constant Field Values
  - DEFAULT_OPERATION_TIMEOUT
```
public static final long DEFAULT_OPERATION_TIMEOUT
```
    Default operation timeout in milliseconds.
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_RECONNECT_DELAY
```
public static final long DEFAULT_MAX_RECONNECT_DELAY
```
    Maximum amount of time (in seconds) to wait between reconnect attempts.
    
    See Also:
    Constant Field Values
  - DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD
```
public static final int DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD
```
    Maximum number + 2 of timeout exception for shutdown connection.
    
    See Also:
    Constant Field Values
  - DEFAULT_METRIC_TYPE
```
public static final MetricType DEFAULT_METRIC_TYPE
```
    Turn off metric collection by default.
  - DEFAULT_AUTH_WAIT_TIME
```
public static final long DEFAULT_AUTH_WAIT_TIME
```
    The time to wait for the authentication to complete when a operation is written in milliseconds.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DefaultConnectionFactory
```
public DefaultConnectionFactory(ClientMode clientMode,
                        int qLen,
                        int bufSize,
                        HashAlgorithm hash)
```
    Construct a DefaultConnectionFactory with the given parameters.
    
    Parameters:
    qLen - the queue length.
    bufSize - the buffer size
    hash - the algorithm to use for hashing
  - DefaultConnectionFactory
```
public DefaultConnectionFactory(ClientMode clientMode,
                        int qLen,
                        int bufSize)
```
    Create a DefaultConnectionFactory with the given maximum operation queue length, and the given read buffer size.
  - DefaultConnectionFactory
```
public DefaultConnectionFactory(int qLen,
                        int bufSize)
```
    Create a DefaultConnectionFactory with the given maximum operation queue length, and the given read buffer size.
  - DefaultConnectionFactory
```
public DefaultConnectionFactory(ClientMode clientMode)
```
    Create a DefaultConnectionFactory with the default parameters.
  - DefaultConnectionFactory
```
public DefaultConnectionFactory()
```
- Method Detail
  - getClientMode
```
public ClientMode getClientMode()
```
    Description copied from interface: ConnectionFactory
    
    The mode in which the client is operating.
    
    Specified by:
    
    getClientMode in interface ConnectionFactory
    
    Returns:
    the clientMode.
  - getDynamicModePollingInterval
```
public long getDynamicModePollingInterval()
```
    Description copied from interface: ConnectionFactory
    
    The interval used for periodic polling of configuration.
    
    Specified by:
    
    getDynamicModePollingInterval in interface ConnectionFactory
    
    Returns:
    the interval in milliseconds
  - createMemcachedNode
```
public MemcachedNode createMemcachedNode(java.net.SocketAddress sa,
                                java.nio.channels.SocketChannel c,
                                int bufSize)
```
    Description copied from interface: ConnectionFactory
    
    Create a new memcached node.
    
    Specified by:
    
    createMemcachedNode in interface ConnectionFactory
  - createConnection
```
public MemcachedConnection createConnection(java.util.List<java.net.InetSocketAddress> addrs)
                                     throws java.io.IOException
```
    Description copied from interface: ConnectionFactory
    
    Create a MemcachedConnection for the given SocketAddresses.
    
    Specified by:
    
    createConnection in interface ConnectionFactory
    
    Parameters:
    addrs - the addresses of the memcached servers
    
    Returns:
    a new MemcachedConnection connected to those addresses
    
    Throws:
    
    java.io.IOException - for problems initializing the memcached connections
  - getFailureMode
```
public FailureMode getFailureMode()
```
    Description copied from interface: ConnectionFactory
    
    Get the default failure mode for the underlying connection.
    
    Specified by:
    
    getFailureMode in interface ConnectionFactory
  - createOperationQueue
```
public java.util.concurrent.BlockingQueue<Operation> createOperationQueue()
```
    Description copied from interface: ConnectionFactory
    
    Create a BlockingQueue for operations for a connection.
    
    Specified by:
    
    createOperationQueue in interface ConnectionFactory
  - createReadOperationQueue
```
public java.util.concurrent.BlockingQueue<Operation> createReadOperationQueue()
```
    Description copied from interface: ConnectionFactory
    
    Create a BlockingQueue for the operations currently expecting to read responses from memcached.
    
    Specified by:
    
    createReadOperationQueue in interface ConnectionFactory
  - createWriteOperationQueue
```
public java.util.concurrent.BlockingQueue<Operation> createWriteOperationQueue()
```
    Description copied from interface: ConnectionFactory
    
    Create a BlockingQueue for the operations currently expecting to write requests to memcached.
    
    Specified by:
    
    createWriteOperationQueue in interface ConnectionFactory
  - createLocator
```
public NodeLocator createLocator(java.util.List<MemcachedNode> nodes)
```
    Description copied from interface: ConnectionFactory
    
    Create a NodeLocator instance for the given list of nodes.
    
    Specified by:
    
    createLocator in interface ConnectionFactory
  - getOpQueueLen
```
public int getOpQueueLen()
```
    Get the op queue length set at construct time.
  - getOpQueueMaxBlockTime
```
public long getOpQueueMaxBlockTime()
```
    Description copied from interface: ConnectionFactory
    
    Get the maximum amount of time (in milliseconds) a client is willing to wait to add a new item to a queue.
    
    Specified by:
    
    getOpQueueMaxBlockTime in interface ConnectionFactory
    
    Returns:
    the maximum time to block waiting for op queue operations to complete, in milliseconds, or null for no waiting.
  - getAuthWaitTime
```
public long getAuthWaitTime()
```
    Description copied from interface: ConnectionFactory
    
    The time to wait until authentication completes when an operation is inserted.
    
    Specified by:
    
    getAuthWaitTime in interface ConnectionFactory
    
    Returns:
    the time to wait for the authentication to complete when a operation is written in milliseconds.
  - getListenerExecutorService
```
public java.util.concurrent.ExecutorService getListenerExecutorService()
```
    Returns the stored ExecutorService for listeners. By default, a ThreadPoolExecutor is used that acts exactly like a default cachedThreadPool, but defines the upper limit of Threads to be created as the number of available processors to prevent resource exhaustion.
    
    Specified by:
    
    getListenerExecutorService in interface ConnectionFactory
    
    Returns:
    the stored ExecutorService.
  - isDefaultExecutorService
```
public boolean isDefaultExecutorService()
```
    Description copied from interface: ConnectionFactory
    
    Returns true if the default provided ExecutorService has not been overriden through the builder.
    
    Specified by:
    
    isDefaultExecutorService in interface ConnectionFactory
  - getReadBufSize
```
public int getReadBufSize()
```
    Specified by:
    
    getReadBufSize in interface ConnectionFactory
  - getHashAlg
```
public HashAlgorithm getHashAlg()
```
    Description copied from interface: ConnectionFactory
    
    Get the hash algorithm to be used.
    
    Specified by:
    
    getHashAlg in interface ConnectionFactory
  - getOperationFactory
```
public OperationFactory getOperationFactory()
```
    Description copied from interface: ConnectionFactory
    
    Get the operation factory for connections built by this connection factory.
    
    Specified by:
    
    getOperationFactory in interface ConnectionFactory
  - getOperationTimeout
```
public long getOperationTimeout()
```
    Description copied from interface: ConnectionFactory
    
    Get the operation timeout used by this connection.
    
    Specified by:
    
    getOperationTimeout in interface ConnectionFactory
  - isDaemon
```
public boolean isDaemon()
```
    Description copied from interface: ConnectionFactory
    
    If true, the IO thread should be a daemon thread.
    
    Specified by:
    
    isDaemon in interface ConnectionFactory
  - getInitialObservers
```
public java.util.Collection<ConnectionObserver> getInitialObservers()
```
    Description copied from interface: ConnectionFactory
    
    Observers that should be established at the time of connection instantiation. These observers will see the first connection established.
    
    Specified by:
    
    getInitialObservers in interface ConnectionFactory
  - getDefaultTranscoder
```
public Transcoder<java.lang.Object> getDefaultTranscoder()
```
    Description copied from interface: ConnectionFactory
    
    Get the default transcoder to be used in connections created by this factory.
    
    Specified by:
    
    getDefaultTranscoder in interface ConnectionFactory
  - useNagleAlgorithm
```
public boolean useNagleAlgorithm()
```
    Description copied from interface: ConnectionFactory
    
    If true, the nagle algorithm will be used on connected sockets.
    See Socket.setTcpNoDelay(boolean) for more information.
    
    Specified by:
    
    useNagleAlgorithm in interface ConnectionFactory
  - shouldOptimize
```
public boolean shouldOptimize()
```
    Description copied from interface: ConnectionFactory
    
    If true, low-level optimization is in effect.
    
    Specified by:
    
    shouldOptimize in interface ConnectionFactory
  - getMaxReconnectDelay
```
public long getMaxReconnectDelay()
```
    Description copied from interface: ConnectionFactory
    
    Maximum number of milliseconds to wait between reconnect attempts.
    
    Specified by:
    
    getMaxReconnectDelay in interface ConnectionFactory
  - getAuthDescriptor
```
public AuthDescriptor getAuthDescriptor()
```
    Description copied from interface: ConnectionFactory
    
    Authenticate connections using the given auth descriptor.
    
    Specified by:
    
    getAuthDescriptor in interface ConnectionFactory
    
    Returns:
    null if no authentication should take place
  - getTimeoutExceptionThreshold
```
public int getTimeoutExceptionThreshold()
```
    Description copied from interface: ConnectionFactory
    
    Maximum number of timeout exception for shutdown connection.
    
    Specified by:
    
    getTimeoutExceptionThreshold in interface ConnectionFactory
  - enableMetrics
```
public MetricType enableMetrics()
```
    Description copied from interface: ConnectionFactory
    
    If true, metric collections are enabled.
    
    Specified by:
    
    enableMetrics in interface ConnectionFactory
  - getMetricCollector
```
public MetricCollector getMetricCollector()
```
    Description copied from interface: ConnectionFactory
    
    The currently active MetricCollector.
    
    Specified by:
    
    getMetricCollector in interface ConnectionFactory
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DefaultConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CLIENT_MODE

DEFAULT_FAILURE_MODE

DEFAULT_HASH

DEFAULT_OP_QUEUE_LEN

DEFAULT_OP_QUEUE_MAX_BLOCK_TIME

DEFAULT_READ_BUFFER_SIZE

DEFAULT_OPERATION_TIMEOUT

DEFAULT_MAX_RECONNECT_DELAY

DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD

DEFAULT_METRIC_TYPE

DEFAULT_AUTH_WAIT_TIME

Constructor Detail

DefaultConnectionFactory

DefaultConnectionFactory

DefaultConnectionFactory

DefaultConnectionFactory

DefaultConnectionFactory

Method Detail

getClientMode

getDynamicModePollingInterval

createMemcachedNode

createConnection

getFailureMode

createOperationQueue

createReadOperationQueue

createWriteOperationQueue

createLocator

getOpQueueLen

getOpQueueMaxBlockTime

getAuthWaitTime

getListenerExecutorService

isDefaultExecutorService

getReadBufSize

getHashAlg

getOperationFactory

getOperationTimeout

isDaemon

getInitialObservers

getDefaultTranscoder

useNagleAlgorithm

shouldOptimize

getMaxReconnectDelay

getAuthDescriptor

getTimeoutExceptionThreshold

enableMetrics

getMetricCollector

toString