SchoonerSockIOPool (Memcached-Java-Client 3.0.2 API)

java.lang.Object
- com.schooner.MemCached.SchoonerSockIOPool

public class SchoonerSockIOPool
extends Object

This class is a connection pool for maintaning a pool of persistent connections
to memcached servers. The pool must be initialized prior to use. This should typically be early on
in the lifecycle of the JVM instance.

An example of initializing using defaults:

 static {
        String[] serverlist = { "cache0.server.com:12345", "cache1.server.com:12345" };
 
        SockIOPool pool = SockIOPool.getInstance();
        pool.setServers(serverlist);
        pool.initialize();
 }

An example of initializing using defaults and providing weights for servers:

 static {
        String[] serverlist = { "cache0.server.com:12345", "cache1.server.com:12345" };
        Integer[] weights = { new Integer(5), new Integer(2) };
 
        SockIOPool pool = SockIOPool.getInstance();
        pool.setServers(serverlist);
        pool.setWeights(weights);
        pool.initialize();
 }

An example of initializing overriding defaults:

 static {
        String[] serverlist = { "cache0.server.com:12345", "cache1.server.com:12345" };
        Integer[] weights = { new Integer(5), new Integer(2) };
        pool.setInitConn(5);
        pool.setMinConn(5);
        pool.setMaxConn(10);
        pool.setMaintSleep(0);
        pool.setNagle(false);
        pool.initialize();
 }

Since:: 2.5.0
Author:: Xingen Wang
See Also:: SchoonerSockIOPool

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SchoonerSockIOPool.TCPSockIO` MemCached Java client, utility class for Socket IO.
`static class`	`SchoonerSockIOPool.UDPSockIO`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONSISTENT_HASH`
`static long`	`MAX_RETRY_DELAY`
`static int`	`NATIVE_HASH`
`static int`	`NEW_COMPAT_HASH`
`static int`	`OLD_COMPAT_HASH`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SchoonerSockIOPool(boolean isTcp)

Constructors
Modifier	Constructor and Description
`protected`	`SchoonerSockIOPool(boolean isTcp)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`clearHostFromPool(String host)` Closes and removes all sockets from specified pool for host.
`protected void`	`closeSocketPool()` Closes all sockets in the passed in pool.
`boolean`	`getAliveCheck()` Returns the current status of the aliveCheck flag.
`int`	`getBufferSize()`
`SchoonerSockIO`	`getConnection(String host)` Returns a SockIO object from the pool for the passed in host.
`boolean`	`getFailback()` Returns current state of failover flag.
`boolean`	`getFailover()` Returns current state of failover flag.
`int`	`getHashingAlg()` Returns current status of customHash flag
`String`	`getHost(String key)` Gets the host that a particular key / hashcode resides on.
`String`	`getHost(String key, Integer hashcode)` Gets the host that a particular key / hashcode resides on.
`int`	`getInitConn()` Returns the current setting for the initial number of connections per server in the available pool.
`static SchoonerSockIOPool`	`getInstance()` Single argument version of factory used for back compat.
`static SchoonerSockIOPool`	`getInstance(AuthInfo authInfo)`
`static SchoonerSockIOPool`	`getInstance(boolean isTcp)`
`static SchoonerSockIOPool`	`getInstance(String poolName)` Factory to create/retrieve new pools given a unique poolName.
`static SchoonerSockIOPool`	`getInstance(String poolName, AuthInfo authInfo)`
`static SchoonerSockIOPool`	`getInstance(String poolName, boolean isTcp)`
`boolean`	`getLifo()`
`long`	`getMaintSleep()` Returns the current maint thread sleep time.
`long`	`getMaxBusy()` Returns the current max busy setting.
`int`	`getMaxConn()`
`int`	`getMaxIdle()` Returns the current max idle setting.
`long`	`getMaxWait()`
`int`	`getMinConn()`
`long`	`getMinEvictableIdleTimeMillis()`
`int`	`getMinIdle()`
`boolean`	`getNagle()` Returns current status of nagle flag
`int`	`getNumTestsPerEvictionRun()`
`String[]`	`getServers()` Returns the current list of all cache servers.
`SchoonerSockIO`	`getSock(String key)` Returns appropriate SockIO object given string cache key.
`SchoonerSockIO`	`getSock(String key, Integer hashCode)` Returns appropriate SockIO object given string cache key and optional hashcode.
`int`	`getSocketConnectTO()` Returns the socket timeout for connect.
`int`	`getSocketTO()` Returns the socket timeout for reads.
`long`	`getSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)`
`boolean`	`getTestOnBorrow()`
`boolean`	`getTestOnReturn()`
`boolean`	`getTestWhileIdle()`
`long`	`getTimeBetweenEvictionRunsMillis()`
`Integer[]`	`getWeights()` Returns the current list of weights.
`void`	`initialize()` Initializes the pool.
`boolean`	`isInitialized()` Returns state of pool.
`boolean`	`isTcp()`
`void`	`setAliveCheck(boolean aliveCheck)` Sets the aliveCheck flag for the pool.
`void`	`setBufferSize(int bufferSize)`
`void`	`setFailback(boolean failback)` Sets the failback flag for the pool.
`void`	`setFailover(boolean failover)` Sets the failover flag for the pool.
`void`	`setHashingAlg(int alg)` Sets the hashing algorithm we will use.
`void`	`setInitConn(int initConn)` Sets the initial number of connections per server in the available pool.
`void`	`setLifo(boolean lifo)`
`void`	`setMaintSleep(long maintSleep)` Set the sleep time between runs of the pool maintenance thread.
`void`	`setMaxBusyTime(long maxBusyTime)` Sets the max busy time for threads in the busy pool.
`void`	`setMaxConn(int maxConn)`
`void`	`setMaxIdle(int maxIdle)` Sets the max idle time for threads in the available pool.
`void`	`setMaxWait(long maxWait)`
`void`	`setMinConn(int minConn)`
`void`	`setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)`
`void`	`setMinIdle(int minIdle)`
`void`	`setNagle(boolean nagle)` Sets the Nagle alg flag for the pool.
`void`	`setNumTestsPerEvictionRun(int numTestsPerEvictionRun)`
`void`	`setServers(String[] servers)` Sets the list of all cache servers.
`void`	`setSocketConnectTO(int socketConnectTO)` Sets the socket timeout for connect.
`void`	`setSocketTO(int socketTO)` Sets the socket timeout for reads.
`void`	`setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)`
`void`	`setTestOnBorrow(boolean testOnBorrow)`
`void`	`setTestOnReturn(boolean testOnReturn)`
`void`	`setTestWhileIdle(boolean testWhileIdle)`
`void`	`setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)`
`void`	`setWeights(Integer[] weights)` Sets the list of weights to apply to the server list.
`void`	`shutDown()` Shuts down the pool.

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

- Field Detail
  - NATIVE_HASH
```
public static final int NATIVE_HASH
```
    See Also:
    Constant Field Values
  - OLD_COMPAT_HASH
```
public static final int OLD_COMPAT_HASH
```
    See Also:
    Constant Field Values
  - NEW_COMPAT_HASH
```
public static final int NEW_COMPAT_HASH
```
    See Also:
    Constant Field Values
  - CONSISTENT_HASH
```
public static final int CONSISTENT_HASH
```
    See Also:
    Constant Field Values
  - MAX_RETRY_DELAY
```
public static final long MAX_RETRY_DELAY
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SchoonerSockIOPool
```
protected SchoonerSockIOPool(boolean isTcp)
```
- Method Detail
  - getInstance
```
public static SchoonerSockIOPool getInstance(String poolName)
```
    Factory to create/retrieve new pools given a unique poolName.
    
    Parameters:
    poolName - unique name of the pool
    
    Returns:
    instance of SockIOPool
  - getInstance
```
public static SchoonerSockIOPool getInstance(String poolName,
                             AuthInfo authInfo)
```
  - getInstance
```
public static SchoonerSockIOPool getInstance(String poolName,
                             boolean isTcp)
```
  - getInstance
```
public static SchoonerSockIOPool getInstance()
```
    Single argument version of factory used for back compat. Simply creates a pool named "default".
    
    Returns:
    instance of SockIOPool
  - getInstance
```
public static SchoonerSockIOPool getInstance(AuthInfo authInfo)
```
  - getInstance
```
public static SchoonerSockIOPool getInstance(boolean isTcp)
```
  - initialize
```
public void initialize()
```
    Initializes the pool.
  - isTcp
```
public boolean isTcp()
```
  - clearHostFromPool
```
protected void clearHostFromPool(String host)
```
    Closes and removes all sockets from specified pool for host. THIS METHOD IS NOT THREADSAFE, SO BE CAREFUL WHEN USING! Internal utility method.
    
    Parameters:
    pool - pool to clear
    host - host to clear
  - getHost
```
public final String getHost(String key)
```
    Gets the host that a particular key / hashcode resides on.
    
    Parameters:
    key -
    
    Returns:
  - getHost
```
public final String getHost(String key,
             Integer hashcode)
```
    Gets the host that a particular key / hashcode resides on.
    
    Parameters:
    key -
    hashcode -
    
    Returns:
  - getSock
```
public final SchoonerSockIO getSock(String key)
```
    Returns appropriate SockIO object given string cache key.
    
    Parameters:
    key - hashcode for cache key
    
    Returns:
    SockIO obj connected to server
  - getSock
```
public final SchoonerSockIO getSock(String key,
                     Integer hashCode)
```
    Returns appropriate SockIO object given string cache key and optional hashcode. Trys to get SockIO from pool. Fails over to additional pools in event of server failure.
    
    Parameters:
    key - hashcode for cache key
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    SockIO obj connected to server
  - getConnection
```
public final SchoonerSockIO getConnection(String host)
```
    Returns a SockIO object from the pool for the passed in host. Meant to be called from a more intelligent method
    which handles choosing appropriate server
    and failover.
    
    Parameters:
    host - host from which to retrieve object
    
    Returns:
    SockIO object or null if fail to retrieve one
  - closeSocketPool
```
protected final void closeSocketPool()
```
    Closes all sockets in the passed in pool. Internal utility method.
    
    Parameters:
    pool - pool to close
  - shutDown
```
public void shutDown()
```
    Shuts down the pool. Cleanly closes all sockets.
    Stops the maint thread.
    Nulls out all internal maps
  - isInitialized
```
public final boolean isInitialized()
```
    Returns state of pool.
    
    Returns:
    true if initialized.
  - setServers
```
public final void setServers(String[] servers)
```
    Sets the list of all cache servers.
    
    Parameters:
    servers - String array of servers [host:port]
  - getServers
```
public final String[] getServers()
```
    Returns the current list of all cache servers.
    
    Returns:
    String array of servers [host:port]
  - setWeights
```
public final void setWeights(Integer[] weights)
```
    Sets the list of weights to apply to the server list. This is an int array with each element corresponding to an element
    in the same position in the server String array.
    
    Parameters:
    weights - Integer array of weights
  - getWeights
```
public final Integer[] getWeights()
```
    Returns the current list of weights.
    
    Returns:
    int array of weights
  - setInitConn
```
public final void setInitConn(int initConn)
```
    Sets the initial number of connections per server in the available pool.
    
    Parameters:
    initConn - int number of connections
  - getInitConn
```
public final int getInitConn()
```
    Returns the current setting for the initial number of connections per server in the available pool.
    
    Returns:
    number of connections
  - setMaxBusyTime
```
public final void setMaxBusyTime(long maxBusyTime)
```
    Sets the max busy time for threads in the busy pool.
    
    Parameters:
    maxBusyTime - idle time in ms
  - getMaxBusy
```
public final long getMaxBusy()
```
    Returns the current max busy setting.
    
    Returns:
    max busy setting in ms
  - setMaintSleep
```
public void setMaintSleep(long maintSleep)
```
    Set the sleep time between runs of the pool maintenance thread. If set to 0, then the maint thread will not be started.
    
    Parameters:
    maintSleep - sleep time in ms
  - getMaintSleep
```
public long getMaintSleep()
```
    Returns the current maint thread sleep time.
    
    Returns:
    sleep time in ms
  - setSocketTO
```
public final void setSocketTO(int socketTO)
```
    Sets the socket timeout for reads.
    
    Parameters:
    socketTO - timeout in ms
  - getSocketTO
```
public final int getSocketTO()
```
    Returns the socket timeout for reads.
    
    Returns:
    timeout in ms
  - setSocketConnectTO
```
public final void setSocketConnectTO(int socketConnectTO)
```
    Sets the socket timeout for connect.
    
    Parameters:
    socketConnectTO - timeout in ms
  - getSocketConnectTO
```
public final int getSocketConnectTO()
```
    Returns the socket timeout for connect.
    
    Returns:
    timeout in ms
  - setMaxIdle
```
public void setMaxIdle(int maxIdle)
```
    Sets the max idle time for threads in the available pool.
    
    Parameters:
    maxIdle - idle time in ms
  - getMaxIdle
```
public int getMaxIdle()
```
    Returns the current max idle setting.
    
    Returns:
    max idle setting in ms
  - getMaxWait
```
public final long getMaxWait()
```
  - setMaxWait
```
public final void setMaxWait(long maxWait)
```
  - getMinIdle
```
public final int getMinIdle()
```
  - setMinIdle
```
public final void setMinIdle(int minIdle)
```
  - getTestOnBorrow
```
public final boolean getTestOnBorrow()
```
  - setTestOnBorrow
```
public final void setTestOnBorrow(boolean testOnBorrow)
```
  - getTestOnReturn
```
public final boolean getTestOnReturn()
```
  - setTestOnReturn
```
public final void setTestOnReturn(boolean testOnReturn)
```
  - getTimeBetweenEvictionRunsMillis
```
public final long getTimeBetweenEvictionRunsMillis()
```
  - setTimeBetweenEvictionRunsMillis
```
public final void setTimeBetweenEvictionRunsMillis(long timeBetweenEvictionRunsMillis)
```
  - getNumTestsPerEvictionRun
```
public final int getNumTestsPerEvictionRun()
```
  - setNumTestsPerEvictionRun
```
public final void setNumTestsPerEvictionRun(int numTestsPerEvictionRun)
```
  - getMinEvictableIdleTimeMillis
```
public final long getMinEvictableIdleTimeMillis()
```
  - setMinEvictableIdleTimeMillis
```
public final void setMinEvictableIdleTimeMillis(long minEvictableIdleTimeMillis)
```
  - getTestWhileIdle
```
public final boolean getTestWhileIdle()
```
  - setTestWhileIdle
```
public final void setTestWhileIdle(boolean testWhileIdle)
```
  - getSoftMinEvictableIdleTimeMillis
```
public final long getSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
```
  - setSoftMinEvictableIdleTimeMillis
```
public final void setSoftMinEvictableIdleTimeMillis(long softMinEvictableIdleTimeMillis)
```
  - getLifo
```
public final boolean getLifo()
```
  - setLifo
```
public final void setLifo(boolean lifo)
```
  - setFailover
```
public final void setFailover(boolean failover)
```
    Sets the failover flag for the pool. If this flag is set to true, and a socket fails to connect,
    the pool will attempt to return a socket from another server
    if one exists. If set to false, then getting a socket
    will return null if it fails to connect to the requested server.
    
    Parameters:
    failover - true/false
  - getFailover
```
public final boolean getFailover()
```
    Returns current state of failover flag.
    
    Returns:
    true/false
  - setFailback
```
public void setFailback(boolean failback)
```
    Sets the failback flag for the pool. If this is true and we have marked a host as dead, will try to bring it back. If it is false, we will never try to resurrect a dead host.
    
    Parameters:
    failback - true/false
  - getFailback
```
public boolean getFailback()
```
    Returns current state of failover flag.
    
    Returns:
    true/false
  - setAliveCheck
```
public final void setAliveCheck(boolean aliveCheck)
```
    Sets the aliveCheck flag for the pool. When true, this will attempt to talk to the server on every connection checkout to make sure the connection is still valid. This adds extra network chatter and thus is defaulted off. May be useful if you want to ensure you do not have any problems talking to the server on a dead connection.
    
    Parameters:
    aliveCheck - true/false
  - getAliveCheck
```
public final boolean getAliveCheck()
```
    Returns the current status of the aliveCheck flag.
    
    Returns:
    true / false
  - setNagle
```
public final void setNagle(boolean nagle)
```
    Sets the Nagle alg flag for the pool. If false, will turn off Nagle's algorithm on all sockets created.
    
    Parameters:
    nagle - true/false
  - getNagle
```
public final boolean getNagle()
```
    Returns current status of nagle flag
    
    Returns:
    true/false
  - setHashingAlg
```
public final void setHashingAlg(int alg)
```
    Sets the hashing algorithm we will use. The types are as follows. SockIOPool.NATIVE_HASH (0) - native String.hashCode() - fast (cached) but not compatible with other clients SockIOPool.OLD_COMPAT_HASH (1) - original compatibility hashing alg (works with other clients) SockIOPool.NEW_COMPAT_HASH (2) - new CRC32 based compatibility hashing algorithm (fast and works with other clients)
    
    Parameters:
    alg - int value representing hashing algorithm
  - getHashingAlg
```
public final int getHashingAlg()
```
    Returns current status of customHash flag
    
    Returns:
    true/false
  - setMaxConn
```
public void setMaxConn(int maxConn)
```
  - getMaxConn
```
public int getMaxConn()
```
  - setMinConn
```
public void setMinConn(int minConn)
```
  - getMinConn
```
public int getMinConn()
```
  - setBufferSize
```
public void setBufferSize(int bufferSize)
```
  - getBufferSize
```
public int getBufferSize()
```

Class SchoonerSockIOPool

An example of initializing using defaults:

An example of initializing using defaults and providing weights for servers:

An example of initializing overriding defaults:

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NATIVE_HASH

OLD_COMPAT_HASH

NEW_COMPAT_HASH

CONSISTENT_HASH

MAX_RETRY_DELAY

Constructor Detail

SchoonerSockIOPool

Method Detail

getInstance

getInstance

getInstance

getInstance

getInstance

getInstance

initialize

isTcp

clearHostFromPool

getHost

getHost

getSock

getSock

getConnection

closeSocketPool

shutDown

isInitialized

setServers

getServers

setWeights

getWeights

setInitConn

getInitConn

setMaxBusyTime

getMaxBusy

setMaintSleep

getMaintSleep

setSocketTO

getSocketTO

setSocketConnectTO

getSocketConnectTO

setMaxIdle

getMaxIdle

getMaxWait

setMaxWait

getMinIdle

setMinIdle

getTestOnBorrow

setTestOnBorrow

getTestOnReturn

setTestOnReturn

getTimeBetweenEvictionRunsMillis

setTimeBetweenEvictionRunsMillis

getNumTestsPerEvictionRun

setNumTestsPerEvictionRun

getMinEvictableIdleTimeMillis

setMinEvictableIdleTimeMillis

getTestWhileIdle

setTestWhileIdle

getSoftMinEvictableIdleTimeMillis

setSoftMinEvictableIdleTimeMillis

getLifo

setLifo

setFailover

getFailover

setFailback

getFailback

setAliveCheck

getAliveCheck

setNagle

getNagle

setHashingAlg