MemCachedClient (Memcached-Java-Client 3.0.2 API)

java.lang.Object
- com.whalin.MemCached.MemCachedClient

Direct Known Subclasses:: AscIIClient, AscIIUDPClient, BinaryClient

public class MemCachedClient
extends Object

Schooner light-weight memcached client. It is of higher performance than other java memcached clients. The main modification is done by Xingen Wang.

Instead of the InputStream and OutputStream, we choose the SocketChannel and java.nio package to increase the performance.
Here is an example to use schooner memcached client.

Firstly, we should initialize the SockIOPool, which is a connection pool.

An example of initializing using defaults:

 static {
        String[] serverlist = { "server1.com:port", "server2.com:port" };
 
        SockIOPool pool = SockIOPool.getInstance();
        pool.setServers(serverlist);
        pool.initialize();
 }

Then we can create the client object.

To create cache client object:

 MemCachedClient mc = new MemCachedClient();

To store an object:

 MemCachedClient mc = new MemCachedClient();
 String key = "cacheKey1";
 Object value = SomeClass.getObject();
 mc.set(key, value);

To delete a cache entry:

 MemCachedClient mc = new MemCachedClient();
 String key = "cacheKey1";
 mc.delete(key);

To retrieve an object from the cache:

 MemCachedClient mc = new MemCachedClient();
 String key = "key";
 Object value = mc.get(key);

To retrieve an multiple objects from the cache

 MemCachedClient mc = new MemCachedClient();
 String[] keys = { "key", "key1", "key2" };
 Map<Object> values = mc.getMulti(keys);

To flush all items in server(s)

 MemCachedClient mc = new MemCachedClient();
 mc.flushAll();

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`AUTH_FAILED`
`static byte[]`	`B_DELETED`
`static byte[]`	`B_END`
`static byte[]`	`B_NOTFOUND`
`static byte[]`	`B_RETURN`
`static byte[]`	`B_STORED`
`byte[]`	`BLAND_DATA_SIZE` This is used for set command only. The reason for use this that we have to put the size of the object bytes into the command line.
`protected ClassLoader`	`classLoader`
`static String`	`CLIENT_ERROR`
`static int`	`COMPRESS_THRESH`
`static String`	`DELETED`
`static String`	`END`
`static String`	`ERROR`
`protected ErrorHandler`	`errorHandler`
`static int`	`F_COMPRESSED`
`static int`	`F_SERIALIZED`
`static byte`	`FURTHER_AUTH`
`static String`	`ITEM`
`static org.slf4j.Logger`	`log`
`static byte`	`MAGIC_REQ` The following static constants are used for the binary protocol.
`static byte`	`MAGIC_RESP`
`static int`	`MARKER_BOOLEAN`
`static int`	`MARKER_BYTE` values for cache flags
`static int`	`MARKER_BYTEARR`
`static int`	`MARKER_CHARACTER`
`static int`	`MARKER_DATE`
`static int`	`MARKER_DOUBLE`
`static int`	`MARKER_FLOAT`
`static int`	`MARKER_INTEGER`
`static int`	`MARKER_LONG`
`static int`	`MARKER_OTHERS`
`static int`	`MARKER_SHORT`
`static int`	`MARKER_STRING`
`static int`	`MARKER_STRINGBUFFER`
`static int`	`MARKER_STRINGBUILDER`
`static String`	`NOTFOUND`
`static String`	`OK`
`static byte`	`OPCODE_ADD`
`static byte`	`OPCODE_APPEND`
`static byte`	`OPCODE_AUTH_LIST`
`static byte`	`OPCODE_AUTH_STEPS`
`static byte`	`OPCODE_DECREMENT`
`static byte`	`OPCODE_DELETE`
`static byte`	`OPCODE_FLUSH`
`static byte`	`OPCODE_GET`
`static byte`	`OPCODE_GETK`
`static byte`	`OPCODE_GETKQ`
`static byte`	`OPCODE_GETQ`
`static byte`	`OPCODE_INCREMENT`
`static byte`	`OPCODE_NOOP`
`static byte`	`OPCODE_PREPEND`
`static byte`	`OPCODE_QUIT`
`static byte`	`OPCODE_REPLACE`
`static byte`	`OPCODE_SET`
`static byte`	`OPCODE_START_AUTH`
`static byte`	`OPCODE_STAT`
`static byte`	`OPCODE_VERSION`
`static String`	`SERVER_ERROR`
`static int`	`STAT_INVALID_ARGUMENTS`
`static int`	`STAT_ITEM_NOT_STORED`
`static int`	`STAT_KEY_EXISTS`
`static int`	`STAT_KEY_NOT_FOUND`
`static int`	`STAT_NO_ERROR`
`static int`	`STAT_OUT_OF_MEMORY`
`static int`	`STAT_UNKNOWN_COMMAND`
`static int`	`STAT_VALUE_TOO_BIG`
`static String`	`STATS`
`static String`	`STORED`
`static String`	`SYNCED`
`static String`	`VALUE`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`MemCachedClient()` Creates a new instance of MemCachedClient.
	`MemCachedClient(boolean binaryProtocal)` Creates a new instance of MemCachedClient. Use binary protocol with TCP.
	`MemCachedClient(boolean isTCP, boolean binaryProtocal)` Create default memcached client.
	`MemCachedClient(ClassLoader classLoader)` Deprecated. will be removed in next release. Please use customized transcoder `AbstractTransCoder` to achieve the same objective.
	`MemCachedClient(ClassLoader classLoader, ErrorHandler errorHandler)` Deprecated. will be removed in next release. Please use customized transcoder `AbstractTransCoder` to achieve the same objective.
	`MemCachedClient(ClassLoader classLoader, ErrorHandler errorHandler, String poolName)` Deprecated. will be removed in next release. Please use customized transcoder `AbstractTransCoder` to achieve the same objective.
`protected`	`MemCachedClient(MemCachedClient client)` used when you want to create a ASCIIClient/BinaryClient/UDPASCIIClient instance
	`MemCachedClient(String poolName)` Creates a new instance of MemCachedClient accepting a passed in pool name.
	`MemCachedClient(String poolName, boolean binaryProtocal)` Creates a new instance of MemCachedClient accepting a passed in pool name.
	`MemCachedClient(String poolName, boolean isTcp, boolean binaryProtocal)` Create memcached client.
	`MemCachedClient(String poolName, boolean isTcp, boolean binaryProtocol, ClassLoader cl, ErrorHandler eh)` Deprecated. will be removed in next release. Please use customized transcoder `AbstractTransCoder` to achieve the same objective.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`add(String key, Object value)` Adds data to the server; only the key and the value are specified.
`boolean`	`add(String key, Object value, Date expiry)` Adds data to the server; the key, value, and an expiration time are specified.
`boolean`	`add(String key, Object value, Date expiry, Integer hashCode)` Adds data to the server; the key, value, and an expiration time are specified.
`boolean`	`add(String key, Object value, Integer hashCode)` Adds data to the server; the key, value, and an optional hashcode are passed in.
`long`	`addOrDecr(String key)` Thread safe way to initialize and decrement a counter.
`long`	`addOrDecr(String key, long inc)` Thread safe way to initialize and decrement a counter.
`long`	`addOrDecr(String key, long inc, Integer hashCode)` Thread safe way to initialize and decrement a counter.
`long`	`addOrIncr(String key)` Thread safe way to initialize and increment a counter.
`long`	`addOrIncr(String key, long inc)` Thread safe way to initialize and increment a counter.
`long`	`addOrIncr(String key, long inc, Integer hashCode)` Thread safe way to initialize and increment a counter.
`boolean`	`append(String key, Object value)`
`boolean`	`append(String key, Object value, Integer hashCode)`
`boolean`	`cas(String key, Object value, Date expiry, Integer hashCode, long casUnique)`
`boolean`	`cas(String key, Object value, Date expiry, long casUnique)`
`boolean`	`cas(String key, Object value, Integer hashCode, long casUnique)`
`boolean`	`cas(String key, Object value, long casUnique)`
`long`	`decr(String key)` Decrement the value at the specified key by 1, and then return it. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`long`	`decr(String key, long inc)` Decrement the value at the specified key by passed in value, and then return it. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`long`	`decr(String key, long inc, Integer hashCode)` Decrement the value at the specified key by the specified increment, and then return it. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`boolean`	`delete(String key)` Deletes an object from cache given cache key.
`boolean`	`delete(String key, Date expiry)` Deprecated. not supported in memcached 1.4+
`boolean`	`delete(String key, Integer hashCode, Date expiry)` Deprecated. not supported in memcached 1.4+
`boolean`	`flushAll()` Invalidates the entire cache.
`boolean`	`flushAll(String[] servers)` Invalidates the entire cache.
`Object`	`get(String key)` Retrieve a key from the server, using a specific hash.
`Object`	`get(String key, Integer hashCode)` Retrieve a key from the server, using a specific hash.
`Object`	`get(String key, Integer hashCode, boolean asString)` Retrieve a key from the server, using a specific hash.
`long`	`getCounter(String key)` Returns value in counter at given key as long.
`long`	`getCounter(String key, Integer hashCode)` Returns value in counter at given key as long.
`Map<String,Object>`	`getMulti(String[] keys)` Retrieve multiple objects from the memcache.
`Map<String,Object>`	`getMulti(String[] keys, Integer[] hashCodes)` Retrieve multiple keys from the memcache.
`Map<String,Object>`	`getMulti(String[] keys, Integer[] hashCodes, boolean asString)` Retrieve multiple keys from the memcache.
`Object[]`	`getMultiArray(String[] keys)` Retrieve multiple objects from the memcache.
`Object[]`	`getMultiArray(String[] keys, Integer[] hashCodes)` Retrieve multiple objects from the memcache.
`Object[]`	`getMultiArray(String[] keys, Integer[] hashCodes, boolean asString)` Retrieve multiple objects from the memcache.
`MemcachedItem`	`gets(String key)`
`MemcachedItem`	`gets(String key, Integer hashCode)`
`long`	`incr(String key)` Increment the value at the specified key by 1, and then return it. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`long`	`incr(String key, long inc)` Increment the value at the specified key by passed in val. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`long`	`incr(String key, long inc, Integer hashCode)` Increment the value at the specified key by the specified increment, and then return it. Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
`boolean`	`isUseBinaryProtocol()`
`boolean`	`keyExists(String key)` Checks to see if key exists in cache.
`boolean`	`prepend(String key, Object value)`
`boolean`	`prepend(String key, Object value, Integer hashCode)`
`boolean`	`replace(String key, Object value)` Updates data on the server; only the key and the value are specified.
`boolean`	`replace(String key, Object value, Date expiry)` Updates data on the server; the key, value, and an expiration time are specified.
`boolean`	`replace(String key, Object value, Date expiry, Integer hashCode)` Updates data on the server; the key, value, and an expiration time are specified.
`boolean`	`replace(String key, Object value, Integer hashCode)` Updates data on the server; only the key and the value and an optional hash are specified.
`boolean`	`set(String key, Object value)` Stores data on the server; only the key and the value are specified.
`boolean`	`set(String key, Object value, Date expiry)` Stores data on the server; the key, value, and an expiration time are specified.
`boolean`	`set(String key, Object value, Date expiry, Integer hashCode)` Stores data on the server; the key, value, and an expiration time are specified.
`boolean`	`set(String key, Object value, Integer hashCode)` Stores data on the server; only the key and the value are specified.
`void`	`setClassLoader(ClassLoader classLoader)` Deprecated. will be removed in next release. Please use customized transcoder `AbstractTransCoder` to achieve the same objective.
`void`	`setCompressEnable(boolean compressEnable)` Deprecated. will be removed in next release.
`void`	`setCompressThreshold(long compressThreshold)` Deprecated. will be removed in next release.
`void`	`setDefaultEncoding(String defaultEncoding)` Sets default String encoding when storing primitives as Strings.
`void`	`setErrorHandler(ErrorHandler errorHandler)` Deprecated. will be removed in next release. The purpose of adding this support was to make it compatible with previous releases.
`void`	`setPrimitiveAsString(boolean primitiveAsString)` Enables storing primitive types as their String values.
`void`	`setSanitizeKeys(boolean sanitizeKeys)` Enables/disables sanitizing keys by URLEncoding.
`void`	`setTransCoder(TransCoder transCoder)`
`Map<String,Map<String,String>>`	`stats()` Retrieves stats for all servers.
`Map<String,Map<String,String>>`	`stats(String[] servers)` Retrieves stats for passed in servers (or all servers).
`Map<String,Map<String,String>>`	`statsCacheDump(int slabNumber, int limit)` Retrieves items cachedump for all servers.
`Map<String,Map<String,String>>`	`statsCacheDump(String[] servers, int slabNumber, int limit)` Retrieves stats for passed in servers (or all servers).
`Map<String,Map<String,String>>`	`statsItems()` Retrieves stats items for all servers.
`Map<String,Map<String,String>>`	`statsItems(String[] servers)` Retrieves stats for passed in servers (or all servers).
`Map<String,Map<String,String>>`	`statsSlabs()` Retrieves stats items for all servers.
`Map<String,Map<String,String>>`	`statsSlabs(String[] servers)` Retrieves stats for passed in servers (or all servers).
`boolean`	`storeCounter(String key, Long counter)` Store a counter to memcached given a key
`boolean`	`storeCounter(String key, Long counter, Date date)` Store a counter to memcached given a key
`boolean`	`storeCounter(String key, Long counter, Date date, Integer hashCode)` Store a counter to memcached given a key
`boolean`	`storeCounter(String key, Long counter, Integer hashCode)` Store a counter to memcached given a key
`boolean`	`sync(String key)`
`boolean`	`sync(String key, Integer hashCode)`
`boolean`	`syncAll()`
`boolean`	`syncAll(String[] servers)`

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

- Field Detail
  - classLoader
```
protected ClassLoader classLoader
```
  - errorHandler
```
protected ErrorHandler errorHandler
```
  - log
```
public static org.slf4j.Logger log
```
  - VALUE
```
public static final String VALUE
```
    See Also:
    Constant Field Values
  - STATS
```
public static final String STATS
```
    See Also:
    Constant Field Values
  - ITEM
```
public static final String ITEM
```
    See Also:
    Constant Field Values
  - DELETED
```
public static final String DELETED
```
    See Also:
    Constant Field Values
  - SYNCED
```
public static final String SYNCED
```
    See Also:
    Constant Field Values
  - NOTFOUND
```
public static final String NOTFOUND
```
    See Also:
    Constant Field Values
  - STORED
```
public static final String STORED
```
    See Also:
    Constant Field Values
  - OK
```
public static final String OK
```
    See Also:
    Constant Field Values
  - END
```
public static final String END
```
    See Also:
    Constant Field Values
  - ERROR
```
public static final String ERROR
```
    See Also:
    Constant Field Values
  - CLIENT_ERROR
```
public static final String CLIENT_ERROR
```
    See Also:
    Constant Field Values
  - COMPRESS_THRESH
```
public static final int COMPRESS_THRESH
```
    See Also:
    Constant Field Values
  - SERVER_ERROR
```
public static final String SERVER_ERROR
```
    See Also:
    Constant Field Values
  - B_RETURN
```
public static final byte[] B_RETURN
```
  - B_END
```
public static final byte[] B_END
```
  - B_NOTFOUND
```
public static final byte[] B_NOTFOUND
```
  - B_DELETED
```
public static final byte[] B_DELETED
```
  - B_STORED
```
public static final byte[] B_STORED
```
  - MAGIC_REQ
```
public static final byte MAGIC_REQ
```
    The following static constants are used for the binary protocol.
    
    See Also:
    Constant Field Values
  - MAGIC_RESP
```
public static final byte MAGIC_RESP
```
    See Also:
    Constant Field Values
  - F_COMPRESSED
```
public static final int F_COMPRESSED
```
    See Also:
    Constant Field Values
  - F_SERIALIZED
```
public static final int F_SERIALIZED
```
    See Also:
    Constant Field Values
  - STAT_NO_ERROR
```
public static final int STAT_NO_ERROR
```
    See Also:
    Constant Field Values
  - STAT_KEY_NOT_FOUND
```
public static final int STAT_KEY_NOT_FOUND
```
    See Also:
    Constant Field Values
  - STAT_KEY_EXISTS
```
public static final int STAT_KEY_EXISTS
```
    See Also:
    Constant Field Values
  - STAT_VALUE_TOO_BIG
```
public static final int STAT_VALUE_TOO_BIG
```
    See Also:
    Constant Field Values
  - STAT_INVALID_ARGUMENTS
```
public static final int STAT_INVALID_ARGUMENTS
```
    See Also:
    Constant Field Values
  - STAT_ITEM_NOT_STORED
```
public static final int STAT_ITEM_NOT_STORED
```
    See Also:
    Constant Field Values
  - STAT_UNKNOWN_COMMAND
```
public static final int STAT_UNKNOWN_COMMAND
```
    See Also:
    Constant Field Values
  - STAT_OUT_OF_MEMORY
```
public static final int STAT_OUT_OF_MEMORY
```
    See Also:
    Constant Field Values
  - OPCODE_GET
```
public static final byte OPCODE_GET
```
    See Also:
    Constant Field Values
  - OPCODE_SET
```
public static final byte OPCODE_SET
```
    See Also:
    Constant Field Values
  - OPCODE_ADD
```
public static final byte OPCODE_ADD
```
    See Also:
    Constant Field Values
  - OPCODE_REPLACE
```
public static final byte OPCODE_REPLACE
```
    See Also:
    Constant Field Values
  - OPCODE_DELETE
```
public static final byte OPCODE_DELETE
```
    See Also:
    Constant Field Values
  - OPCODE_INCREMENT
```
public static final byte OPCODE_INCREMENT
```
    See Also:
    Constant Field Values
  - OPCODE_DECREMENT
```
public static final byte OPCODE_DECREMENT
```
    See Also:
    Constant Field Values
  - OPCODE_QUIT
```
public static final byte OPCODE_QUIT
```
    See Also:
    Constant Field Values
  - OPCODE_FLUSH
```
public static final byte OPCODE_FLUSH
```
    See Also:
    Constant Field Values
  - OPCODE_GETQ
```
public static final byte OPCODE_GETQ
```
    See Also:
    Constant Field Values
  - OPCODE_NOOP
```
public static final byte OPCODE_NOOP
```
    See Also:
    Constant Field Values
  - OPCODE_VERSION
```
public static final byte OPCODE_VERSION
```
    See Also:
    Constant Field Values
  - OPCODE_GETK
```
public static final byte OPCODE_GETK
```
    See Also:
    Constant Field Values
  - OPCODE_GETKQ
```
public static final byte OPCODE_GETKQ
```
    See Also:
    Constant Field Values
  - OPCODE_APPEND
```
public static final byte OPCODE_APPEND
```
    See Also:
    Constant Field Values
  - OPCODE_PREPEND
```
public static final byte OPCODE_PREPEND
```
    See Also:
    Constant Field Values
  - OPCODE_STAT
```
public static final byte OPCODE_STAT
```
    See Also:
    Constant Field Values
  - OPCODE_AUTH_LIST
```
public static final byte OPCODE_AUTH_LIST
```
    See Also:
    Constant Field Values
  - OPCODE_START_AUTH
```
public static final byte OPCODE_START_AUTH
```
    See Also:
    Constant Field Values
  - OPCODE_AUTH_STEPS
```
public static final byte OPCODE_AUTH_STEPS
```
    See Also:
    Constant Field Values
  - AUTH_FAILED
```
public static final byte AUTH_FAILED
```
    See Also:
    Constant Field Values
  - FURTHER_AUTH
```
public static final byte FURTHER_AUTH
```
    See Also:
    Constant Field Values
  - BLAND_DATA_SIZE
```
public final byte[] BLAND_DATA_SIZE
```
    This is used for set command only.
    The reason for use this that we have to put the size of the object bytes into the command line. While as a matter of fact, we can't get the real size before we completed the serialization.
    In order to solve this problem, we add this blank area to the size position in the command line. When we complete the full serialization and get the bytes size, we will replace this blank are with real bytes size.
    This definitely help us decrease the GC of JVM.
  - MARKER_BYTE
```
public static final int MARKER_BYTE
```
    values for cache flags
    
    See Also:
    Constant Field Values
  - MARKER_BOOLEAN
```
public static final int MARKER_BOOLEAN
```
    See Also:
    Constant Field Values
  - MARKER_INTEGER
```
public static final int MARKER_INTEGER
```
    See Also:
    Constant Field Values
  - MARKER_LONG
```
public static final int MARKER_LONG
```
    See Also:
    Constant Field Values
  - MARKER_CHARACTER
```
public static final int MARKER_CHARACTER
```
    See Also:
    Constant Field Values
  - MARKER_STRING
```
public static final int MARKER_STRING
```
    See Also:
    Constant Field Values
  - MARKER_STRINGBUFFER
```
public static final int MARKER_STRINGBUFFER
```
    See Also:
    Constant Field Values
  - MARKER_FLOAT
```
public static final int MARKER_FLOAT
```
    See Also:
    Constant Field Values
  - MARKER_SHORT
```
public static final int MARKER_SHORT
```
    See Also:
    Constant Field Values
  - MARKER_DOUBLE
```
public static final int MARKER_DOUBLE
```
    See Also:
    Constant Field Values
  - MARKER_DATE
```
public static final int MARKER_DATE
```
    See Also:
    Constant Field Values
  - MARKER_STRINGBUILDER
```
public static final int MARKER_STRINGBUILDER
```
    See Also:
    Constant Field Values
  - MARKER_BYTEARR
```
public static final int MARKER_BYTEARR
```
    See Also:
    Constant Field Values
  - MARKER_OTHERS
```
public static final int MARKER_OTHERS
```
    See Also:
    Constant Field Values
- Constructor Detail
  - MemCachedClient
```
protected MemCachedClient(MemCachedClient client)
```
    used when you want to create a ASCIIClient/BinaryClient/UDPASCIIClient instance
  - MemCachedClient
```
public MemCachedClient()
```
    Creates a new instance of MemCachedClient.
  - MemCachedClient
```
public MemCachedClient(boolean binaryProtocal)
```
    Creates a new instance of MemCachedClient.
    Use binary protocol with TCP.
    
    Parameters:
    binaryProtocal - whether use binary protocol.
  - MemCachedClient
```
public MemCachedClient(String poolName)
```
    Creates a new instance of MemCachedClient accepting a passed in pool name.
    
    Parameters:
    poolName - name of SockIOPool
  - MemCachedClient
```
public MemCachedClient(String poolName,
               boolean binaryProtocal)
```
    Creates a new instance of MemCachedClient accepting a passed in pool name.
    
    Parameters:
    poolName - name of SockIOPool
    binaryProtocal - whether use binary protocol.
  - MemCachedClient
```
public MemCachedClient(boolean isTCP,
               boolean binaryProtocal)
```
    Create default memcached client.
    
    Parameters:
    isTCP - true - use tcp protocol
    false - use udp protocol
    binaryProtocal - use binary protocol.
  - MemCachedClient
```
public MemCachedClient(String poolName,
               boolean isTcp,
               boolean binaryProtocal)
```
    Create memcached client.
    
    Parameters:
    poolName - name of SockIOPool
    isTCP - use tcp protocol
    binaryProtocal - use binary protocol.
  - MemCachedClient
```
public MemCachedClient(String poolName,
               boolean isTcp,
               boolean binaryProtocol,
               ClassLoader cl,
               ErrorHandler eh)
```
    Deprecated. will be removed in next release.
    Please use customized transcoder AbstractTransCoder to achieve the same objective.
    
    create memcached client.
    
    Parameters:
    poolName - pool name
    isTcp - is tcp protocol?
    binaryProtocol - is binary protocol?
    cl - classloader.
    eh - errorhandler.
  - MemCachedClient
```
public MemCachedClient(ClassLoader classLoader)
```
    Deprecated. will be removed in next release.
    Please use customized transcoder AbstractTransCoder to achieve the same objective.
    
    Creates a new instance of MemCacheClient but acceptes a passed in ClassLoader.
    
    Parameters:
    classLoader - ClassLoader object.
  - MemCachedClient
```
public MemCachedClient(ClassLoader classLoader,
               ErrorHandler errorHandler)
```
    Deprecated. will be removed in next release.
    Please use customized transcoder AbstractTransCoder to achieve the same objective.
    
    Creates a new instance of MemCacheClient but acceptes a passed in ClassLoader and a passed in ErrorHandler.
    
    Parameters:
    classLoader - ClassLoader object.
    errorHandler - ErrorHandler object.
  - MemCachedClient
```
public MemCachedClient(ClassLoader classLoader,
               ErrorHandler errorHandler,
               String poolName)
```
    Deprecated. will be removed in next release.
    Please use customized transcoder AbstractTransCoder to achieve the same objective.
    
    Creates a new instance of MemCacheClient but acceptes a passed in ClassLoader, ErrorHandler, and SockIOPool name.
    
    Parameters:
    classLoader - ClassLoader object.
    errorHandler - ErrorHandler object.
    poolName - SockIOPool name
- Method Detail
  - isUseBinaryProtocol
```
public boolean isUseBinaryProtocol()
```
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Deprecated. will be removed in next release.
    Please use customized transcoder AbstractTransCoder to achieve the same objective.
    
    Sets an optional ClassLoader to be used for serialization.
    
    Parameters:
    classLoader -
  - setErrorHandler
```
public void setErrorHandler(ErrorHandler errorHandler)
```
    Deprecated. will be removed in next release. The purpose of adding this support was to make it compatible with previous releases.
    
    Sets an optional ErrorHandler.
    
    Parameters:
    errorHandler -
  - setCompressEnable
```
public void setCompressEnable(boolean compressEnable)
```
    Deprecated. will be removed in next release.
    
    Enable storing compressed data, provided it meets the threshold requirements. If enabled, data will be stored in compressed form if it is
    longer than the threshold length set with setCompressThreshold(int)
    
    The default is that compression is enabled.
    
    Even if compression is disabled, compressed data will be automatically
    decompressed.
    
    Parameters:
    compressEnable - true to enable compression, false to disable compression
  - setCompressThreshold
```
public void setCompressThreshold(long compressThreshold)
```
    Deprecated. will be removed in next release.
    
    Sets the required length for data to be considered for compression. If the length of the data to be stored is not equal or larger than this value, it will not be compressed. This defaults to 15 KB.
    
    Parameters:
    compressThreshold - required length of data to consider compression
  - setDefaultEncoding
```
public void setDefaultEncoding(String defaultEncoding)
```
    Sets default String encoding when storing primitives as Strings. Default is UTF-8.
    
    Parameters:
    defaultEncoding -
  - setPrimitiveAsString
```
public void setPrimitiveAsString(boolean primitiveAsString)
```
    Enables storing primitive types as their String values.
    
    Parameters:
    primitiveAsString - if true, then store all primitives as their string value.
  - setSanitizeKeys
```
public void setSanitizeKeys(boolean sanitizeKeys)
```
    Enables/disables sanitizing keys by URLEncoding.
    
    Parameters:
    sanitizeKeys - if true, then URLEncode all keys
  - keyExists
```
public boolean keyExists(String key)
```
    Checks to see if key exists in cache.
    
    Parameters:
    key - the key to look for
    
    Returns:
    true if key found in cache, false if not (or if cache is down)
  - delete
```
public boolean delete(String key)
```
    Deletes an object from cache given cache key.
    
    Parameters:
    key - the key to be removed
    
    Returns:
    true, if the data was deleted successfully
  - delete
```
public boolean delete(String key,
             Date expiry)
```
    Deprecated. not supported in memcached 1.4+
    
    Deletes an object from cache given cache key and expiration date.
    
    Parameters:
    key - the key to be removed
    expiry - when to expire the record.
    
    Returns:
    true, if the data was deleted successfully
  - delete
```
public boolean delete(String key,
             Integer hashCode,
             Date expiry)
```
    Deprecated. not supported in memcached 1.4+
    
    Deletes an object from cache given cache key, a delete time, and an optional hashcode. The item is immediately made non retrievable.
    Keep in mind add and replace
    will fail when used with the same key will fail, until the server reaches the
    specified time. However, set will succeed,
    and the new value will not be deleted.
    
    Parameters:
    key - the key to be removed
    hashCode - if not null, then the int hashcode to use
    expiry - when to expire the record.
    
    Returns:
    true, if the data was deleted successfully
  - set
```
public boolean set(String key,
          Object value)
```
    Stores data on the server; only the key and the value are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    
    Returns:
    true, if the data was successfully stored
  - set
```
public boolean set(String key,
          Object value,
          Integer hashCode)
```
    Stores data on the server; only the key and the value are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - set
```
public boolean set(String key,
          Object value,
          Date expiry)
```
    Stores data on the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    
    Returns:
    true, if the data was successfully stored
  - set
```
public boolean set(String key,
          Object value,
          Date expiry,
          Integer hashCode)
```
    Stores data on the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - add
```
public boolean add(String key,
          Object value)
```
    Adds data to the server; only the key and the value are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    
    Returns:
    true, if the data was successfully stored
  - add
```
public boolean add(String key,
          Object value,
          Integer hashCode)
```
    Adds data to the server; the key, value, and an optional hashcode are passed in.
    
    Parameters:
    key - key to store data under
    value - value to store
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - add
```
public boolean add(String key,
          Object value,
          Date expiry)
```
    Adds data to the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    
    Returns:
    true, if the data was successfully stored
  - add
```
public boolean add(String key,
          Object value,
          Date expiry,
          Integer hashCode)
```
    Adds data to the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - replace
```
public boolean replace(String key,
              Object value)
```
    Updates data on the server; only the key and the value are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    
    Returns:
    true, if the data was successfully stored
  - replace
```
public boolean replace(String key,
              Object value,
              Integer hashCode)
```
    Updates data on the server; only the key and the value and an optional hash are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - replace
```
public boolean replace(String key,
              Object value,
              Date expiry)
```
    Updates data on the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    
    Returns:
    true, if the data was successfully stored
  - replace
```
public boolean replace(String key,
              Object value,
              Date expiry,
              Integer hashCode)
```
    Updates data on the server; the key, value, and an expiration time are specified.
    
    Parameters:
    key - key to store data under
    value - value to store
    expiry - when to expire the record
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true, if the data was successfully stored
  - storeCounter
```
public boolean storeCounter(String key,
                   Long counter)
```
    Store a counter to memcached given a key
    
    Parameters:
    key - cache key
    counter - number to store
    
    Returns:
    true/false indicating success
  - storeCounter
```
public boolean storeCounter(String key,
                   Long counter,
                   Date date)
```
    Store a counter to memcached given a key
    
    Parameters:
    key - cache key
    counter - number to store
    date - when to expire the record
    
    Returns:
    true/false indicating success
  - storeCounter
```
public boolean storeCounter(String key,
                   Long counter,
                   Date date,
                   Integer hashCode)
```
    Store a counter to memcached given a key
    
    Parameters:
    key - cache key
    counter - number to store
    date - when to expire the record
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true/false indicating success
  - storeCounter
```
public boolean storeCounter(String key,
                   Long counter,
                   Integer hashCode)
```
    Store a counter to memcached given a key
    
    Parameters:
    key - cache key
    counter - number to store
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    true/false indicating success
  - getCounter
```
public long getCounter(String key)
```
    Returns value in counter at given key as long.
    
    Parameters:
    key - cache ket
    
    Returns:
    counter value or -1 if not found
  - getCounter
```
public long getCounter(String key,
              Integer hashCode)
```
    Returns value in counter at given key as long.
    
    Parameters:
    key - cache ket
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    counter value or -1 if not found
  - addOrIncr
```
public long addOrIncr(String key)
```
    Thread safe way to initialize and increment a counter.
    
    Parameters:
    key - key where the data is stored
    
    Returns:
    value of incrementer
  - addOrIncr
```
public long addOrIncr(String key,
             long inc)
```
    Thread safe way to initialize and increment a counter.
    
    Parameters:
    key - key where the data is stored
    inc - value to set or increment by
    
    Returns:
    value of incrementer
  - addOrIncr
```
public long addOrIncr(String key,
             long inc,
             Integer hashCode)
```
    Thread safe way to initialize and increment a counter.
    
    Parameters:
    key - key where the data is stored
    inc - value to set or increment by
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    value of incrementer
  - addOrDecr
```
public long addOrDecr(String key)
```
    Thread safe way to initialize and decrement a counter.
    
    Parameters:
    key - key where the data is stored
    
    Returns:
    value of incrementer
  - addOrDecr
```
public long addOrDecr(String key,
             long inc)
```
    Thread safe way to initialize and decrement a counter.
    
    Parameters:
    key - key where the data is stored
    inc - value to set or increment by
    
    Returns:
    value of incrementer
  - addOrDecr
```
public long addOrDecr(String key,
             long inc,
             Integer hashCode)
```
    Thread safe way to initialize and decrement a counter.
    
    Parameters:
    key - key where the data is stored
    inc - value to set or increment by
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    value of incrementer
  - incr
```
public long incr(String key)
```
    Increment the value at the specified key by 1, and then return it.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - incr
```
public long incr(String key,
        long inc)
```
    Increment the value at the specified key by passed in val.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    inc - how much to increment by
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - incr
```
public long incr(String key,
        long inc,
        Integer hashCode)
```
    Increment the value at the specified key by the specified increment, and then return it.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    inc - how much to increment by
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - decr
```
public long decr(String key)
```
    Decrement the value at the specified key by 1, and then return it.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - decr
```
public long decr(String key,
        long inc)
```
    Decrement the value at the specified key by passed in value, and then return it.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    inc - how much to increment by
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - decr
```
public long decr(String key,
        long inc,
        Integer hashCode)
```
    Decrement the value at the specified key by the specified increment, and then return it.
    Please make sure setPrimitiveAsString=true if the key/value pair is stored with set command.
    
    Parameters:
    key - key where the data is stored
    inc - how much to increment by
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    -1, if the key is not found, the value after incrementing otherwise
  - get
```
public Object get(String key)
```
    Retrieve a key from the server, using a specific hash. If the data was compressed or serialized when compressed, it will automatically
    be decompressed or serialized, as appropriate. (Inclusive or)
    
    Non-serialized data will be returned as a string, so explicit conversion to
    numeric types will be necessary, if desired
    
    Parameters:
    key - key where data is stored
    
    Returns:
    the object that was previously stored, or null if it was not previously stored
  - get
```
public Object get(String key,
         Integer hashCode)
```
    Retrieve a key from the server, using a specific hash. If the data was compressed or serialized when compressed, it will automatically
    be decompressed or serialized, as appropriate. (Inclusive or)
    
    Non-serialized data will be returned as a string, so explicit conversion to
    numeric types will be necessary, if desired
    
    Parameters:
    key - key where data is stored
    hashCode - if not null, then the int hashcode to use
    
    Returns:
    the object that was previously stored, or null if it was not previously stored
  - gets
```
public MemcachedItem gets(String key)
```
  - gets
```
public MemcachedItem gets(String key,
                 Integer hashCode)
```
  - setTransCoder
```
public void setTransCoder(TransCoder transCoder)
```
  - get
```
public Object get(String key,
         Integer hashCode,
         boolean asString)
```
    Retrieve a key from the server, using a specific hash. If the data was compressed or serialized when compressed, it will automatically
    be decompressed or serialized, as appropriate. (Inclusive or)
    
    Non-serialized data will be returned as a string, so explicit conversion to
    numeric types will be necessary, if desired
    
    Parameters:
    key - key where data is stored
    hashCode - if not null, then the int hashcode to use
    asString - if true, then return string val
    
    Returns:
    the object that was previously stored, or null if it was not previously stored
  - getMultiArray
```
public Object[] getMultiArray(String[] keys)
```
    Retrieve multiple objects from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - String array of keys to retrieve
    
    Returns:
    Object array ordered in same order as key array containing results
  - getMultiArray
```
public Object[] getMultiArray(String[] keys,
                     Integer[] hashCodes)
```
    Retrieve multiple objects from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - String array of keys to retrieve
    hashCodes - if not null, then the Integer array of hashCodes
    
    Returns:
    Object array ordered in same order as key array containing results
  - getMultiArray
```
public Object[] getMultiArray(String[] keys,
                     Integer[] hashCodes,
                     boolean asString)
```
    Retrieve multiple objects from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - String array of keys to retrieve
    hashCodes - if not null, then the Integer array of hashCodes
    asString - if true, retrieve string vals
    
    Returns:
    Object array ordered in same order as key array containing results
  - getMulti
```
public Map<String,Object> getMulti(String[] keys)
```
    Retrieve multiple objects from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - String array of keys to retrieve
    
    Returns:
    a hashmap with entries for each key is found by the server, keys that are not found are not entered into the hashmap, but attempting to retrieve them from the hashmap gives you null.
  - getMulti
```
public Map<String,Object> getMulti(String[] keys,
                          Integer[] hashCodes)
```
    Retrieve multiple keys from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - keys to retrieve
    hashCodes - if not null, then the Integer array of hashCodes
    
    Returns:
    a hashmap with entries for each key is found by the server, keys that are not found are not entered into the hashmap, but attempting to retrieve them from the hashmap gives you null.
  - getMulti
```
public Map<String,Object> getMulti(String[] keys,
                          Integer[] hashCodes,
                          boolean asString)
```
    Retrieve multiple keys from the memcache. This is recommended over repeated calls to get(), since it
    is more efficient.
    
    Parameters:
    keys - keys to retrieve
    hashCodes - if not null, then the Integer array of hashCodes
    asString - if true then retrieve using String val
    
    Returns:
    a hashmap with entries for each key is found by the server, keys that are not found are not entered into the hashmap, but attempting to retrieve them from the hashmap gives you null.
  - flushAll
```
public boolean flushAll()
```
    Invalidates the entire cache. Will return true only if succeeds in clearing all servers.
    
    Returns:
    success true/false
  - flushAll
```
public boolean flushAll(String[] servers)
```
    Invalidates the entire cache. Will return true only if succeeds in clearing all servers. If pass in null, then will try to flush all servers.
    
    Parameters:
    servers - optional array of host(s) to flush (host:port)
    
    Returns:
    success true/false
  - stats
```
public Map<String,Map<String,String>> stats()
```
    Retrieves stats for all servers. Returns a map keyed on the servername. The value is another map which contains stats with stat name as key and value as value.
    
    Returns:
    Stats map
  - stats
```
public Map<String,Map<String,String>> stats(String[] servers)
```
    Retrieves stats for passed in servers (or all servers). Returns a map keyed on the servername. The value is another map which contains stats with stat name as key and value as value.
    
    Parameters:
    servers - string array of servers to retrieve stats from, or all if this is null
    
    Returns:
    Stats map
  - statsItems
```
public Map<String,Map<String,String>> statsItems()
```
    Retrieves stats items for all servers. Returns a map keyed on the servername. The value is another map which contains item stats with itemname:number:field as key and value as value.
    
    Returns:
    Stats map
  - statsItems
```
public Map<String,Map<String,String>> statsItems(String[] servers)
```
    Retrieves stats for passed in servers (or all servers). Returns a map keyed on the servername. The value is another map which contains item stats with itemname:number:field as key and value as value.
    
    Parameters:
    servers - string array of servers to retrieve stats from, or all if this is null
    
    Returns:
    Stats map
  - statsSlabs
```
public Map<String,Map<String,String>> statsSlabs()
```
    Retrieves stats items for all servers. Returns a map keyed on the servername. The value is another map which contains slabs stats with slabnumber:field as key and value as value.
    
    Returns:
    Stats map
  - statsSlabs
```
public Map<String,Map<String,String>> statsSlabs(String[] servers)
```
    Retrieves stats for passed in servers (or all servers). Returns a map keyed on the servername. The value is another map which contains slabs stats with slabnumber:field as key and value as value.
    
    Parameters:
    servers - string array of servers to retrieve stats from, or all if this is null
    
    Returns:
    Stats map
  - statsCacheDump
```
public Map<String,Map<String,String>> statsCacheDump(int slabNumber,
                                            int limit)
```
    Retrieves items cachedump for all servers. Returns a map keyed on the servername. The value is another map which contains cachedump stats with the cachekey as key and byte size and unix timestamp as value.
    
    Parameters:
    slabNumber - the item number of the cache dump
    
    Returns:
    Stats map
  - statsCacheDump
```
public Map<String,Map<String,String>> statsCacheDump(String[] servers,
                                            int slabNumber,
                                            int limit)
```
    Retrieves stats for passed in servers (or all servers). Returns a map keyed on the servername. The value is another map which contains cachedump stats with the cachekey as key and byte size and unix timestamp as value.
    
    Parameters:
    servers - string array of servers to retrieve stats from, or all if this is null
    slabNumber - the item number of the cache dump
    
    Returns:
    Stats map
  - sync
```
public boolean sync(String key,
           Integer hashCode)
```
  - sync
```
public boolean sync(String key)
```
  - syncAll
```
public boolean syncAll()
```
  - syncAll
```
public boolean syncAll(String[] servers)
```
  - append
```
public boolean append(String key,
             Object value,
             Integer hashCode)
```
  - append
```
public boolean append(String key,
             Object value)
```
  - cas
```
public boolean cas(String key,
          Object value,
          Integer hashCode,
          long casUnique)
```
  - cas
```
public boolean cas(String key,
          Object value,
          Date expiry,
          long casUnique)
```
  - cas
```
public boolean cas(String key,
          Object value,
          Date expiry,
          Integer hashCode,
          long casUnique)
```
  - cas
```
public boolean cas(String key,
          Object value,
          long casUnique)
```
  - prepend
```
public boolean prepend(String key,
              Object value,
              Integer hashCode)
```
  - prepend
```
public boolean prepend(String key,
              Object value)
```

Class MemCachedClient

An example of initializing using defaults:

To create cache client object:

To store an object:

To delete a cache entry:

To retrieve an object from the cache:

To retrieve an multiple objects from the cache

To flush all items in server(s)

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

classLoader

errorHandler

log

VALUE

STATS

ITEM

DELETED

SYNCED

NOTFOUND

STORED

OK

END

ERROR

CLIENT_ERROR

COMPRESS_THRESH

SERVER_ERROR

B_RETURN

B_END

B_NOTFOUND

B_DELETED

B_STORED

MAGIC_REQ

MAGIC_RESP

F_COMPRESSED

F_SERIALIZED

STAT_NO_ERROR

STAT_KEY_NOT_FOUND

STAT_KEY_EXISTS

STAT_VALUE_TOO_BIG

STAT_INVALID_ARGUMENTS

STAT_ITEM_NOT_STORED

STAT_UNKNOWN_COMMAND

STAT_OUT_OF_MEMORY

OPCODE_GET

OPCODE_SET

OPCODE_ADD

OPCODE_REPLACE

OPCODE_DELETE

OPCODE_INCREMENT

OPCODE_DECREMENT

OPCODE_QUIT

OPCODE_FLUSH

OPCODE_GETQ

OPCODE_NOOP

OPCODE_VERSION

OPCODE_GETK

OPCODE_GETKQ

OPCODE_APPEND

OPCODE_PREPEND

OPCODE_STAT

OPCODE_AUTH_LIST

OPCODE_START_AUTH

OPCODE_AUTH_STEPS

AUTH_FAILED

FURTHER_AUTH

BLAND_DATA_SIZE

MARKER_BYTE

MARKER_BOOLEAN

MARKER_INTEGER

MARKER_LONG

MARKER_CHARACTER

MARKER_STRING

MARKER_STRINGBUFFER

MARKER_FLOAT

MARKER_SHORT

MARKER_DOUBLE

MARKER_DATE