MemcachedClient (xmemcached 2.0.0 API)

所有已知实现类:

XMemcachedClient
```
public interface MemcachedClient
```
The memcached client's interface

作者:

dennis

字段概要

字段
限定符和类型	字段和说明
`static int`	`DEFAULT_CONNECT_TIMEOUT` Default connect timeout,1 minutes
`static int`	`DEFAULT_CONNECTION_POOL_SIZE` With java nio,there is only one connection to a memcached.In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large.
`static long`	`DEFAULT_HEAL_SESSION_INTERVAL` Default heal session interval in milliseconds.
`static int`	`DEFAULT_MAX_QUEUED_NOPS` Default max queued noreply operations number.It is calcuated dynamically based on your jvm maximum memory.
`static int`	`DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD` Maximum number of timeout exception for close connection.
`static long`	`DEFAULT_OP_TIMEOUT` Default operation timeout,if the operation is not returned in 5 second,throw TimeoutException.
`static int`	`DEFAULT_READ_THREAD_COUNT` Default thread number for reading nio's receive buffer and dispatch commands.Recommend users to set it equal or less to the memcached server's number on linux platform,keep default on windows.Default is 0.
`static int`	`DEFAULT_SESSION_IDLE_TIMEOUT` Default session idle timeout,if session is idle,xmemcached will do a heartbeat action to check if connection is alive.
`static int`	`DEFAULT_SESSION_READ_BUFF_SIZE` Default session read buffer size,16k
`static boolean`	`DEFAULT_TCP_KEEPLIVE` Default TCP keeplive option,which is true
`static boolean`	`DEFAULT_TCP_NO_DELAY` Disable nagle algorithm by default
`static int`	`DEFAULT_TCP_RECV_BUFF_SIZE` Default socket's receive buffer size,16k
`static int`	`DEFAULT_TCP_SEND_BUFF_SIZE` Default socket's send buffer size,8k
`static int`	`DYNAMIC_MAX_QUEUED_NOPS`
`static int`	`MAX_QUEUED_NOPS`

方法概要

方法
限定符和类型	方法和说明
`boolean`	`add(String key, int exp, Object value)`
`boolean`	`add(String key, int exp, Object value, long timeout)`
`<T> boolean`	`add(String key, int exp, T value, Transcoder<T> transcoder)`
`<T> boolean`	`add(String key, int exp, T value, Transcoder<T> transcoder, long timeout)` Add key-value item to memcached, success only when the key is not exists in memcached.
`void`	`addServer(InetSocketAddress inetSocketAddress)` Add a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)
`void`	`addServer(InetSocketAddress inetSocketAddress, int weight)`
`void`	`addServer(String hostList)` Add many memcached servers.You can call this method through JMX or program
`void`	`addServer(String server, int port)` Aadd a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)
`void`	`addServer(String server, int port, int weight)` add a memcached server to MemcachedClient
`void`	`addStateListener(MemcachedClientStateListener listener)` Add a memcached client listener
`void`	`addWithNoReply(String key, int exp, Object value)` Add key-value item to memcached, success only when the key is not exists in memcached.This method doesn't wait for reply.
`<T> void`	`addWithNoReply(String key, int exp, T value, Transcoder<T> transcoder)`
`boolean`	`append(String key, Object value)`
`boolean`	`append(String key, Object value, long timeout)` Append value to key's data item,this method will wait for reply
`void`	`appendWithNoReply(String key, Object value)` Append value to key's data item,this method doesn't wait for reply.
`void`	`beginWithNamespace(String ns)` set current namespace for following operations with memcached client.It must be ended with `endWithNamespace()` method.For example: memcachedClient.beginWithNamespace(userId); try{ memcachedClient.set("username",0,username); memcachedClient.set("email",0,email); }finally{ memcachedClient.endWithNamespace(); }
`<T> boolean`	`cas(String key, CASOperation<T> operation)`
`<T> boolean`	`cas(String key, GetsResponse<T> getsResponse, CASOperation<T> operation)`
`<T> boolean`	`cas(String key, int exp, CASOperation<T> operation)`
`<T> boolean`	`cas(String key, int exp, CASOperation<T> operation, Transcoder<T> transcoder)` Cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."
`<T> boolean`	`cas(String key, int exp, GetsResponse<T> getsReponse, CASOperation<T> operation)`
`<T> boolean`	`cas(String key, int exp, GetsResponse<T> getsReponse, CASOperation<T> operation, Transcoder<T> transcoder)` cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."
`boolean`	`cas(String key, int exp, Object value, long cas)`
`boolean`	`cas(String key, int exp, Object value, long timeout, long cas)`
`<T> boolean`	`cas(String key, int exp, T value, Transcoder<T> transcoder, long cas)`
`<T> boolean`	`cas(String key, int exp, T value, Transcoder<T> transcoder, long timeout, long cas)` Cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."
`<T> void`	`casWithNoReply(String key, CASOperation<T> operation)`
`<T> void`	`casWithNoReply(String key, GetsResponse<T> getsResponse, CASOperation<T> operation)`
`<T> void`	`casWithNoReply(String key, int exp, CASOperation<T> operation)`
`<T> void`	`casWithNoReply(String key, int exp, GetsResponse<T> getsReponse, CASOperation<T> operation)` cas noreply
`long`	`decr(String key, long delta)` "decr" are used to change data for some item in-place, decrementing it.
`long`	`decr(String key, long delta, long initValue)`
`long`	`decr(String key, long delta, long initValue, long timeout)` "decr" are used to change data for some item in-place, decrementing it.
`long`	`decr(String key, long delta, long initValue, long timeout, int exp)` "incr" are used to change data for some item in-place, incrementing it.
`void`	`decrWithNoReply(String key, long delta)` "decr" are used to change data for some item in-place, decrementing it.
`boolean`	`delete(String key)`
`boolean`	`delete(String key, int time)` 已过时。
`boolean`	`delete(String key, long opTimeout)` Delete key's date item from memcached
`boolean`	`delete(String key, long cas, long opTimeout)` Delete key's date item from memcached only if its cas value is the same as what was read.
`void`	`deleteWithNoReply(String key)`
`void`	`deleteWithNoReply(String key, int time)` 已过时。
`void`	`endWithNamespace()` Remove current namespace set for this memcached client.It must begin with `beginWithNamespace(String)` method.
`void`	`flushAll()` Make All connected memcached's data item invalid
`void`	`flushAll(InetSocketAddress address)` Invalidate all existing items immediately
`void`	`flushAll(InetSocketAddress address, long timeout)`
`void`	`flushAll(InetSocketAddress address, long timeout, int exptime)`
`void`	`flushAll(int exptime, long timeout)`
`void`	`flushAll(long timeout)` Make All connected memcached's data item invalid
`void`	`flushAll(String host)` 已过时。
`void`	`flushAllWithNoReply()`
`void`	`flushAllWithNoReply(InetSocketAddress address)`
`void`	`flushAllWithNoReply(InetSocketAddress address, int exptime)`
`void`	`flushAllWithNoReply(int exptime)`
`<T> Map<String,T>`	`get(Collection<String> keyCollections)`
`<T> Map<String,T>`	`get(Collection<String> keyCollections, long timeout)`
`<T> Map<String,T>`	`get(Collection<String> keyCollections, long opTimeout, Transcoder<T> transcoder)` Bulk get items
`<T> Map<String,T>`	`get(Collection<String> keyCollections, Transcoder<T> transcoder)`
`<T> T`	`get(String key)`
`<T> T`	`get(String key, long timeout)`
`<T> T`	`get(String key, long timeout, Transcoder<T> transcoder)` Get value by key
`<T> T`	`get(String key, Transcoder<T> transcoder)`
`<T> T`	`getAndTouch(String key, int newExp)` Get item and set a new expiration time for it,using default opTimeout
`<T> T`	`getAndTouch(String key, int newExp, long opTimeout)` Get item and set a new expiration time for it
`Map<InetSocketAddress,AuthInfo>`	`getAuthInfoMap()` return current all auth info
`Collection<InetSocketAddress>`	`getAvailableServers()` Returns available memcached servers list.
`Collection<InetSocketAddress>`	`getAvaliableServers()` 已过时。
`Connector`	`getConnector()` return the session manager
`long`	`getConnectTimeout()` Get the connect timeout
`Counter`	`getCounter(String key)` Get counter for key,and if the key's value is not set,then set it with 0.
`Counter`	`getCounter(String key, long initialValue)` Get counter for key,and if the key's value is not set,then set it with initial value.
`long`	`getHealSessionInterval()` Return the default heal session interval in milliseconds
`KeyIterator`	`getKeyIterator(InetSocketAddress address)` 已过时。 memcached 1.6.x will remove cachedump stats command,so this method will be removed in the future
`String`	`getName()` Return the cache instance name
`long`	`getOpTimeout()` get operation timeout setting
`Protocol`	`getProtocol()`
`Queue<ReconnectRequest>`	`getReconnectRequestQueue()` Returns reconnecting task queue,the queue is thread-safe and 'weakly consistent',but maybe you should not modify it at all.
`<T> Map<String,GetsResponse<T>>`	`gets(Collection<String> keyCollections)`
`<T> Map<String,GetsResponse<T>>`	`gets(Collection<String> keyCollections, long timeout)`
`<T> Map<String,GetsResponse<T>>`	`gets(Collection<String> keyCollections, long opTime, Transcoder<T> transcoder)` Bulk gets items
`<T> Map<String,GetsResponse<T>>`	`gets(Collection<String> keyCollections, Transcoder<T> transcoder)`
`<T> GetsResponse<T>`	`gets(String key)`
`<T> GetsResponse<T>`	`gets(String key, long timeout)`
`<T> GetsResponse<T>`	`gets(String key, long timeout, Transcoder<T> transcoder)` Just like get,But it return a GetsResponse,include cas value for cas update.
`<T> GetsResponse<T>`	`gets(String key, Transcoder transcoder)`
`List<String>`	`getServersDescription()` Get current server list.You can call this method through JMX or program
`Collection<MemcachedClientStateListener>`	`getStateListeners()` Get all current state listeners
`Map<InetSocketAddress,Map<String,String>>`	`getStats()`
`Map<InetSocketAddress,Map<String,String>>`	`getStats(long timeout)` Get stats from all memcached servers
`Map<InetSocketAddress,Map<String,String>>`	`getStatsByItem(String itemName)` Get special item stats.
`Map<InetSocketAddress,Map<String,String>>`	`getStatsByItem(String itemName, long timeout)`
`int`	`getTimeoutExceptionThreshold()` Returns maximum number of timeout exception for closing connection.
`Transcoder`	`getTranscoder()` return default transcoder,default is SerializingTranscoder
`Map<InetSocketAddress,String>`	`getVersions()` Get all connected memcached servers's version.
`Map<InetSocketAddress,String>`	`getVersions(long timeout)`
`long`	`incr(String key, long delta)` "incr" are used to change data for some item in-place, incrementing it.
`long`	`incr(String key, long delta, long initValue)`
`long`	`incr(String key, long delta, long initValue, long timeout)` "incr" are used to change data for some item in-place, incrementing it.
`long`	`incr(String key, long delta, long initValue, long timeout, int exp)` "incr" are used to change data for some item in-place, incrementing it.
`void`	`incrWithNoReply(String key, long delta)` "incr" are used to change data for some item in-place, incrementing it.
`void`	`invalidateNamespace(String ns)` Invalidate all namespace under the namespace using the default operation timeout.
`void`	`invalidateNamespace(String ns, long opTimeout)` Invalidate all items under the namespace.
`boolean`	`isFailureMode()` Returns if client is in failure mode.
`boolean`	`isSanitizeKeys()`
`boolean`	`isShutdown()`
`boolean`	`prepend(String key, Object value)`
`boolean`	`prepend(String key, Object value, long timeout)` Prepend value to key's data item in memcached.This method doesn't wait for reply.
`void`	`prependWithNoReply(String key, Object value)` Prepend value to key's data item in memcached.This method doesn't wait for reply.
`void`	`removeServer(String hostList)` Remove many memcached server
`void`	`removeStateListener(MemcachedClientStateListener listener)` Remove a memcached client listener
`boolean`	`replace(String key, int exp, Object value)`
`boolean`	`replace(String key, int exp, Object value, long timeout)`
`<T> boolean`	`replace(String key, int exp, T value, Transcoder<T> transcoder)`
`<T> boolean`	`replace(String key, int exp, T value, Transcoder<T> transcoder, long timeout)` Replace the key's data item in memcached,success only when the key's data item is exists in memcached.This method will wait for reply from server.
`void`	`replaceWithNoReply(String key, int exp, Object value)` Replace the key's data item in memcached,success only when the key's data item is exists in memcached.This method doesn't wait for reply from server.
`<T> void`	`replaceWithNoReply(String key, int exp, T value, Transcoder<T> transcoder)`
`boolean`	`set(String key, int exp, Object value)`
`boolean`	`set(String key, int exp, Object value, long timeout)`
`<T> boolean`	`set(String key, int exp, T value, Transcoder<T> transcoder)`
`<T> boolean`	`set(String key, int exp, T value, Transcoder<T> transcoder, long timeout)` Store key-value item to memcached
`void`	`setAuthInfoMap(Map<InetSocketAddress,AuthInfo> map)` Configure auth info
`void`	`setBufferAllocator(BufferAllocator bufferAllocator)` 已过时。
`void`	`setConnectionPoolSize(int poolSize)` In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large.
`void`	`setConnectTimeout(long connectTimeout)` Set the connect timeout,default is 1 minutes
`void`	`setEnableHealSession(boolean enableHealSession)` If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.You can disable this behaviour by using this method: `client.setEnableHealSession(false);` The default value is true.
`void`	`setEnableHeartBeat(boolean enableHeartBeat)` Whether to enable heart beat
`void`	`setFailureMode(boolean failureMode)` Configure wheather to set client in failure mode.If set it to true,that means you want to configure client in failure mode.
`void`	`setHealSessionInterval(long healConnectionInterval)` If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.The interval between reconnections is 2 seconds by default.
`void`	`setKeyProvider(KeyProvider keyProvider)` Set a key provider for pre-processing keys before sending them to memcached.
`void`	`setLoggingLevelVerbosity(InetSocketAddress address, int level)` Set the verbosity level of the memcached's logging output.This method will wait for reply.
`void`	`setLoggingLevelVerbosityWithNoReply(InetSocketAddress address, int level)` Set the verbosity level of the memcached's logging output.This method doesn't wait for reply from server
`void`	`setMergeFactor(int mergeFactor)` Set the merge factor,this factor determins how many 'get' commands would be merge to one multi-get command.default is 150
`void`	`setName(String name)` Set cache instance name
`void`	`setOpTimeout(long opTimeout)` set operation timeout,default is one second.
`void`	`setOptimizeGet(boolean optimizeGet)` Enable/Disable merge many get commands to one multi-get command.true is to enable it,false is to disable it.Default is true.Recommend users to enable it.
`void`	`setOptimizeMergeBuffer(boolean optimizeMergeBuffer)` Enable/Disable merge many command's buffers to one big buffer fit socket's send buffer size.Default is true.Recommend true.
`void`	`setPrimitiveAsString(boolean primitiveAsString)` Store all primitive type as string,defualt is false.
`void`	`setSanitizeKeys(boolean sanitizeKey)` Enables/disables sanitizing keys by URLEncoding.
`void`	`setTimeoutExceptionThreshold(int timeoutExceptionThreshold)` Set maximum number of timeout exception for closing connection.You can set it to be a large value to disable this feature.
`void`	`setTranscoder(Transcoder transcoder)` set transcoder
`void`	`setWithNoReply(String key, int exp, Object value)` Store key-value item to memcached,doesn't wait for reply
`<T> void`	`setWithNoReply(String key, int exp, T value, Transcoder<T> transcoder)`
`void`	`shutdown()`
`Map<String,String>`	`stats(InetSocketAddress address)`
`Map<String,String>`	`stats(InetSocketAddress address, long timeout)` �ョ��瑰��emcached server缁��淇℃�
`boolean`	`touch(String key, int exp)` Set a new expiration time for an existing item,using default opTimeout second.
`boolean`	`touch(String key, int exp, long opTimeout)` Set a new expiration time for an existing item
`<T> T`	`withNamespace(String ns, MemcachedClientCallable<T> callable)` With the namespae to do something with current memcached client.All operations with memcached client done in callable will be under the namespace.

字段详细资料
- DEFAULT_READ_THREAD_COUNT
```
static final int DEFAULT_READ_THREAD_COUNT
```
  Default thread number for reading nio's receive buffer and dispatch commands.Recommend users to set it equal or less to the memcached server's number on linux platform,keep default on windows.Default is 0.
  
  另请参阅:
  常量字段值
- DEFAULT_TCP_KEEPLIVE
```
static final boolean DEFAULT_TCP_KEEPLIVE
```
  Default TCP keeplive option,which is true
  
  另请参阅:
  常量字段值
- DEFAULT_CONNECT_TIMEOUT
```
static final int DEFAULT_CONNECT_TIMEOUT
```
  Default connect timeout,1 minutes
  
  另请参阅:
  常量字段值
- DEFAULT_TCP_SEND_BUFF_SIZE
```
static final int DEFAULT_TCP_SEND_BUFF_SIZE
```
  Default socket's send buffer size,8k
  
  另请参阅:
  常量字段值
- DEFAULT_TCP_NO_DELAY
```
static final boolean DEFAULT_TCP_NO_DELAY
```
  Disable nagle algorithm by default
  
  另请参阅:
  常量字段值
- DEFAULT_SESSION_READ_BUFF_SIZE
```
static final int DEFAULT_SESSION_READ_BUFF_SIZE
```
  Default session read buffer size,16k
  
  另请参阅:
  常量字段值
- DEFAULT_TCP_RECV_BUFF_SIZE
```
static final int DEFAULT_TCP_RECV_BUFF_SIZE
```
  Default socket's receive buffer size,16k
  
  另请参阅:
  常量字段值
- DEFAULT_OP_TIMEOUT
```
static final long DEFAULT_OP_TIMEOUT
```
  Default operation timeout,if the operation is not returned in 5 second,throw TimeoutException.
  
  另请参阅:
  常量字段值
- DEFAULT_CONNECTION_POOL_SIZE
```
static final int DEFAULT_CONNECTION_POOL_SIZE
```
  With java nio,there is only one connection to a memcached.In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large. Xmemcached supports connection pool instreadof client pool.you can create more connections to one or more memcached servers,and these connections share the same reactor and thread pools,it will reduce the cost of system.Default pool size is 1.
  
  另请参阅:
  常量字段值
- DEFAULT_SESSION_IDLE_TIMEOUT
```
static final int DEFAULT_SESSION_IDLE_TIMEOUT
```
  Default session idle timeout,if session is idle,xmemcached will do a heartbeat action to check if connection is alive.
  
  另请参阅:
  常量字段值
- DEFAULT_HEAL_SESSION_INTERVAL
```
static final long DEFAULT_HEAL_SESSION_INTERVAL
```
  Default heal session interval in milliseconds.
  
  另请参阅:
  常量字段值
- MAX_QUEUED_NOPS
```
static final int MAX_QUEUED_NOPS
```
  另请参阅:
  常量字段值
- DYNAMIC_MAX_QUEUED_NOPS
```
static final int DYNAMIC_MAX_QUEUED_NOPS
```
- DEFAULT_MAX_QUEUED_NOPS
```
static final int DEFAULT_MAX_QUEUED_NOPS
```
  Default max queued noreply operations number.It is calcuated dynamically based on your jvm maximum memory.
  
  从以下版本开始:
  
  1.3.8
- DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD
```
static final int DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD
```
  Maximum number of timeout exception for close connection.
  
  从以下版本开始:
  
  1.4.0
  
  另请参阅:
  常量字段值

方法详细资料

setMergeFactor
```
void setMergeFactor(int mergeFactor)
```
Set the merge factor,this factor determins how many 'get' commands would be merge to one multi-get command.default is 150

参数:
mergeFactor -

getConnectTimeout
```
long getConnectTimeout()
```
Get the connect timeout

setConnectTimeout
```
void setConnectTimeout(long connectTimeout)
```
Set the connect timeout,default is 1 minutes

参数:
connectTimeout -

getConnector
```
Connector getConnector()
```
return the session manager

返回:

setOptimizeGet
```
void setOptimizeGet(boolean optimizeGet)
```
Enable/Disable merge many get commands to one multi-get command.true is to enable it,false is to disable it.Default is true.Recommend users to enable it.

参数:
optimizeGet -

setOptimizeMergeBuffer
```
void setOptimizeMergeBuffer(boolean optimizeMergeBuffer)
```
Enable/Disable merge many command's buffers to one big buffer fit socket's send buffer size.Default is true.Recommend true.

参数:
optimizeMergeBuffer -

isShutdown
```
boolean isShutdown()
```
返回:

addServer
```
void addServer(String server,
             int port)
               throws IOException
```
Aadd a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)

参数:
server - host string
port - port number

抛出:

IOException

addServer
```
void addServer(InetSocketAddress inetSocketAddress)
               throws IOException
```
Add a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)

参数:
inetSocketAddress - memcached server's socket address

抛出:

IOException

addServer
```
void addServer(String hostList)
               throws IOException
```
Add many memcached servers.You can call this method through JMX or program

参数:
host - String like [host1]:[port1] [host2]:[port2] ...

抛出:

IOException

getServersDescription
```
List<String> getServersDescription()
```
Get current server list.You can call this method through JMX or program

removeServer
```
void removeServer(String hostList)
```
Remove many memcached server

参数:
host - String like [host1]:[port1] [host2]:[port2] ...

setBufferAllocator
```
@Deprecated
void setBufferAllocator(BufferAllocator bufferAllocator)
```
已过时。

Set the nio's ByteBuffer Allocator,use SimpleBufferAllocator by default.

参数:
bufferAllocator -

get
```
<T> T get(String key,
        long timeout,
        Transcoder<T> transcoder)
      throws TimeoutException,
             InterruptedException,
             MemcachedException
```
Get value by key

类型参数:
T -
参数:
key - Key
timeout - Operation timeout,if the method is not returned in this time,throw TimeoutException
transcoder - The value's transcoder

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

get

<T> T get(String key,
        long timeout)
      throws TimeoutException,
             InterruptedException,
             MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

get

<T> T get(String key,
        Transcoder<T> transcoder)
      throws TimeoutException,
             InterruptedException,
             MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

get

<T> T get(String key)
      throws TimeoutException,
             InterruptedException,
             MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

gets

<T> GetsResponse<T> gets(String key,
                       long timeout,
                       Transcoder<T> transcoder)
                     throws TimeoutException,
                            InterruptedException,
                            MemcachedException

Just like get,But it return a GetsResponse,include cas value for cas update.

类型参数:: T -
参数:: key - key; timeout - operation timeout; transcoder -
返回:: GetsResponse
抛出:: TimeoutException; InterruptedException; MemcachedException

gets

<T> GetsResponse<T> gets(String key)
                     throws TimeoutException,
                            InterruptedException,
                            MemcachedException

类型参数:: T -
参数:: key -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(String, long, Transcoder)

gets

<T> GetsResponse<T> gets(String key,
                       long timeout)
                     throws TimeoutException,
                            InterruptedException,
                            MemcachedException

类型参数:: T -
参数:: key -; timeout -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(String, long, Transcoder)

gets

<T> GetsResponse<T> gets(String key,
                       Transcoder transcoder)
                     throws TimeoutException,
                            InterruptedException,
                            MemcachedException

类型参数:: T -
参数:: key -; transcoder -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(String, long, Transcoder)

get

<T> Map<String,T> get(Collection<String> keyCollections,
                    long opTimeout,
                    Transcoder<T> transcoder)
                  throws TimeoutException,
                         InterruptedException,
                         MemcachedException

Bulk get items

类型参数:: T -
参数:: keyCollections - key collection; opTimeout - opTimeout; transcoder - Value transcoder
返回:: Exists items map
抛出:: TimeoutException; InterruptedException; MemcachedException

get

<T> Map<String,T> get(Collection<String> keyCollections,
                    Transcoder<T> transcoder)
                  throws TimeoutException,
                         InterruptedException,
                         MemcachedException

类型参数:: T -
参数:: keyCollections -; transcoder -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: get(Collection, long, Transcoder)

get

<T> Map<String,T> get(Collection<String> keyCollections)
                  throws TimeoutException,
                         InterruptedException,
                         MemcachedException

类型参数:: T -
参数:: keyCollections -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: get(Collection, long, Transcoder)

get

<T> Map<String,T> get(Collection<String> keyCollections,
                    long timeout)
                  throws TimeoutException,
                         InterruptedException,
                         MemcachedException

类型参数:: T -
参数:: keyCollections -; timeout -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: get(Collection, long, Transcoder)

gets

<T> Map<String,GetsResponse<T>> gets(Collection<String> keyCollections,
                                   long opTime,
                                   Transcoder<T> transcoder)
                                 throws TimeoutException,
                                        InterruptedException,
                                        MemcachedException

Bulk gets items

类型参数:: T -
参数:: keyCollections - key collection; opTime - Operation timeout; transcoder - Value transcoder
返回:: Exists GetsResponse map
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: GetsResponse

gets

<T> Map<String,GetsResponse<T>> gets(Collection<String> keyCollections)
                                 throws TimeoutException,
                                        InterruptedException,
                                        MemcachedException

类型参数:: T -
参数:: keyCollections -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(Collection, long, Transcoder)

gets

<T> Map<String,GetsResponse<T>> gets(Collection<String> keyCollections,
                                   long timeout)
                                 throws TimeoutException,
                                        InterruptedException,
                                        MemcachedException

类型参数:: T -
参数:: keyCollections -; timeout -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(Collection, long, Transcoder)

gets

<T> Map<String,GetsResponse<T>> gets(Collection<String> keyCollections,
                                   Transcoder<T> transcoder)
                                 throws TimeoutException,
                                        InterruptedException,
                                        MemcachedException

类型参数:: T -
参数:: keyCollections -; transcoder -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: gets(Collection, long, Transcoder)

set
```
<T> boolean set(String key,
              int exp,
              T value,
              Transcoder<T> transcoder,
              long timeout)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException
```
Store key-value item to memcached

类型参数:
T -
参数:
key - stored key
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value - stored data
transcoder - transocder
timeout - operation timeout,in milliseconds

返回:
boolean result

抛出:

TimeoutException

InterruptedException

MemcachedException

set

boolean set(String key,
          int exp,
          Object value)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: set(String, int, Object, Transcoder, long)

set

boolean set(String key,
          int exp,
          Object value,
          long timeout)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: set(String, int, Object, Transcoder, long)

set

<T> boolean set(String key,
              int exp,
              T value,
              Transcoder<T> transcoder)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: set(String, int, Object, Transcoder, long)

setWithNoReply
```
void setWithNoReply(String key,
                  int exp,
                  Object value)
                    throws InterruptedException,
                           MemcachedException
```
Store key-value item to memcached,doesn't wait for reply

类型参数:
T -
参数:
key - stored key
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value - stored data
transcoder - transocder

抛出:

TimeoutException

InterruptedException

MemcachedException

setWithNoReply

<T> void setWithNoReply(String key,
                      int exp,
                      T value,
                      Transcoder<T> transcoder)
                    throws InterruptedException,
                           MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -
抛出:: InterruptedException; MemcachedException
另请参阅:: setWithNoReply(String, int, Object, Transcoder)

add
```
<T> boolean add(String key,
              int exp,
              T value,
              Transcoder<T> transcoder,
              long timeout)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException
```
Add key-value item to memcached, success only when the key is not exists in memcached.

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value -
transcoder -
timeout -

返回:
boolean result

抛出:

TimeoutException

InterruptedException

MemcachedException

add

boolean add(String key,
          int exp,
          Object value)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

参数:: key -; exp -; value -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: add(String, int, Object, Transcoder, long)

add

boolean add(String key,
          int exp,
          Object value,
          long timeout)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

参数:: key -; exp -; value -; timeout -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: add(String, int, Object, Transcoder, long)

add

<T> boolean add(String key,
              int exp,
              T value,
              Transcoder<T> transcoder)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: add(String, int, Object, Transcoder, long)

addWithNoReply
```
void addWithNoReply(String key,
                  int exp,
                  Object value)
                    throws InterruptedException,
                           MemcachedException
```
Add key-value item to memcached, success only when the key is not exists in memcached.This method doesn't wait for reply.

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value -
transcoder -

抛出:

TimeoutException

InterruptedException

MemcachedException

addWithNoReply

<T> void addWithNoReply(String key,
                      int exp,
                      T value,
                      Transcoder<T> transcoder)
                    throws InterruptedException,
                           MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -
抛出:: InterruptedException; MemcachedException
另请参阅:: addWithNoReply(String, int, Object, Transcoder)

replace
```
<T> boolean replace(String key,
                  int exp,
                  T value,
                  Transcoder<T> transcoder,
                  long timeout)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException
```
Replace the key's data item in memcached,success only when the key's data item is exists in memcached.This method will wait for reply from server.

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value -
transcoder -
timeout -

返回:
boolean result

抛出:

TimeoutException

InterruptedException

MemcachedException

replace

boolean replace(String key,
              int exp,
              Object value)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException

参数:: key -; exp -; value -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: replace(String, int, Object, Transcoder, long)

replace

boolean replace(String key,
              int exp,
              Object value,
              long timeout)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException

参数:: key -; exp -; value -; timeout -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: replace(String, int, Object, Transcoder, long)

replace

<T> boolean replace(String key,
                  int exp,
                  T value,
                  Transcoder<T> transcoder)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: replace(String, int, Object, Transcoder, long)

replaceWithNoReply
```
void replaceWithNoReply(String key,
                      int exp,
                      Object value)
                        throws InterruptedException,
                               MemcachedException
```
Replace the key's data item in memcached,success only when the key's data item is exists in memcached.This method doesn't wait for reply from server.

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value -
transcoder -

抛出:

TimeoutException

InterruptedException

MemcachedException

replaceWithNoReply

<T> void replaceWithNoReply(String key,
                          int exp,
                          T value,
                          Transcoder<T> transcoder)
                        throws InterruptedException,
                               MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -
抛出:: InterruptedException; MemcachedException
另请参阅:: replaceWithNoReply(String, int, Object, Transcoder)

append

boolean append(String key,
             Object value)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException

参数:: key -; value -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: append(String, Object, long)

append

boolean append(String key,
             Object value,
             long timeout)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException

Append value to key's data item,this method will wait for reply

参数:: key -; value -; timeout -
返回:: boolean result
抛出:: TimeoutException; InterruptedException; MemcachedException

appendWithNoReply

void appendWithNoReply(String key,
                     Object value)
                       throws InterruptedException,
                              MemcachedException

Append value to key's data item,this method doesn't wait for reply.

参数:: key -; value -
抛出:: TimeoutException; InterruptedException; MemcachedException

prepend

boolean prepend(String key,
              Object value)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException

参数:: key -; value -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: prepend(String, Object, long)

prepend

boolean prepend(String key,
              Object value,
              long timeout)
                throws TimeoutException,
                       InterruptedException,
                       MemcachedException

Prepend value to key's data item in memcached.This method doesn't wait for reply.

参数:: key -; value -
返回:: boolean result
抛出:: TimeoutException; InterruptedException; MemcachedException

prependWithNoReply

void prependWithNoReply(String key,
                      Object value)
                        throws InterruptedException,
                               MemcachedException

Prepend value to key's data item in memcached.This method doesn't wait for reply.

参数:: key -; value -
抛出:: TimeoutException; InterruptedException; MemcachedException

cas

boolean cas(String key,
          int exp,
          Object value,
          long cas)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

参数:: key -; exp -; value -; cas -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, Object, Transcoder, long, long)

cas
```
<T> boolean cas(String key,
              int exp,
              T value,
              Transcoder<T> transcoder,
              long timeout,
              long cas)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException
```
Cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
value -
transcoder -
timeout -
cas -

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

cas

boolean cas(String key,
          int exp,
          Object value,
          long timeout,
          long cas)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

参数:: key -; exp -; value -; timeout -; cas -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, Object, Transcoder, long, long)

cas

<T> boolean cas(String key,
              int exp,
              T value,
              Transcoder<T> transcoder,
              long cas)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; exp -; value -; transcoder -; cas -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, Object, Transcoder, long, long)

cas
```
<T> boolean cas(String key,
              int exp,
              CASOperation<T> operation,
              Transcoder<T> transcoder)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException
```
Cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
operation - CASOperation
transcoder - object transcoder

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

cas
```
<T> boolean cas(String key,
              int exp,
              GetsResponse<T> getsReponse,
              CASOperation<T> operation,
              Transcoder<T> transcoder)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException
```
cas is a check and set operation which means "store this data but only if no one else has updated since I last fetched it."

类型参数:
T -
参数:
key -
exp - An expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
getsReponse - gets method's result
operation - CASOperation
transcoder -

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

cas

<T> boolean cas(String key,
              int exp,
              GetsResponse<T> getsReponse,
              CASOperation<T> operation)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; exp -; getsReponse -; operation -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, GetsResponse, CASOperation, Transcoder)

cas

<T> boolean cas(String key,
              GetsResponse<T> getsResponse,
              CASOperation<T> operation)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; getsResponse -; operation -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, GetsResponse, CASOperation, Transcoder)

cas

<T> boolean cas(String key,
              int exp,
              CASOperation<T> operation)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; exp -; operation -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, GetsResponse, CASOperation, Transcoder)

cas

<T> boolean cas(String key,
              CASOperation<T> operation)
            throws TimeoutException,
                   InterruptedException,
                   MemcachedException

类型参数:: T -
参数:: key -; operation -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: cas(String, int, GetsResponse, CASOperation, Transcoder)

casWithNoReply

<T> void casWithNoReply(String key,
                      GetsResponse<T> getsResponse,
                      CASOperation<T> operation)
                    throws TimeoutException,
                           InterruptedException,
                           MemcachedException

类型参数:: T -
参数:: key -; getsResponse -; operation -
抛出:: TimeoutException; InterruptedException; MemcachedException

casWithNoReply

<T> void casWithNoReply(String key,
                      int exp,
                      GetsResponse<T> getsReponse,
                      CASOperation<T> operation)
                    throws TimeoutException,
                           InterruptedException,
                           MemcachedException

cas noreply

类型参数:: T -
参数:: key -; exp -; getsReponse -; operation -
抛出:: TimeoutException; InterruptedException; MemcachedException

casWithNoReply

<T> void casWithNoReply(String key,
                      int exp,
                      CASOperation<T> operation)
                    throws TimeoutException,
                           InterruptedException,
                           MemcachedException

类型参数:: T -
参数:: key -; exp -; operation -
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: casWithNoReply(String, int, GetsResponse, CASOperation)

casWithNoReply

<T> void casWithNoReply(String key,
                      CASOperation<T> operation)
                    throws TimeoutException,
                           InterruptedException,
                           MemcachedException

类型参数:: T -
参数:: key -; operation -
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: casWithNoReply(String, int, GetsResponse, CASOperation)

delete
```
@Deprecated
boolean delete(String key,
                        int time)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException
```
已过时。

Delete key's data item from memcached.It it is not exists,return false.
time is the amount of time in seconds (or Unix time until
which) the client wishes the server to refuse "add" and "replace"
commands with this key. For this amount of item, the item is put into a
delete queue, which means that it won't possible to retrieve it by the
"get" command, but "add" and "replace" command with this key will also
fail (the "set" command will succeed, however). After the time passes,
the item is finally deleted from server memory.
Note: This method is deprecated,because memcached 1.4.0 remove the optional argument "time".You can still use this method on old version,but is not recommended.

参数:
key -
time -

抛出:

InterruptedException

MemcachedException

TimeoutException

delete

boolean delete(String key,
             long opTimeout)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException

Delete key's date item from memcached

参数:: key -; opTimeout - Operation timeout
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
从以下版本开始:: 1.3.2

delete

boolean delete(String key,
             long cas,
             long opTimeout)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException

Delete key's date item from memcached only if its cas value is the same as what was read.

参数:: key -; opTimeout - Operation timeout
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
从以下版本开始:: 1.3.2

touch
```
boolean touch(String key,
            int exp,
            long opTimeout)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException
```
Set a new expiration time for an existing item

参数:
key - item's key
exp - New expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
opTimeout - operation timeout

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

touch
```
boolean touch(String key,
            int exp)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException
```
Set a new expiration time for an existing item,using default opTimeout second.

参数:
key - item's key
exp - New expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

getAndTouch
```
<T> T getAndTouch(String key,
                int newExp,
                long opTimeout)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException
```
Get item and set a new expiration time for it

类型参数:
T -
参数:
key - item's key
newExp - New expiration time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.
opTimeout - operation timeout

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

getAndTouch

<T> T getAndTouch(String key,
                int newExp)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException

Get item and set a new expiration time for it,using default opTimeout

类型参数:: T -
参数:: key -; newExp -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException

getVersions

Map<InetSocketAddress,String> getVersions()
                                          throws TimeoutException,
                                                 InterruptedException,
                                                 MemcachedException

Get all connected memcached servers's version.

返回:
抛出:: TimeoutException; InterruptedException; MemcachedException

incr
```
long incr(String key,
        long delta)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"incr" are used to change data for some item in-place, incrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for incr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key -
num -

返回:
the new value of the item's data, after the increment operation was carried out.

抛出:

InterruptedException

MemcachedException

TimeoutException

incr

long incr(String key,
        long delta,
        long initValue)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

incr
```
long incr(String key,
        long delta,
        long initValue,
        long timeout)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"incr" are used to change data for some item in-place, incrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for incr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key - key
num - increment
initValue - initValue if the data is not exists.
timeout - operation timeout

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

decr
```
long decr(String key,
        long delta)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"decr" are used to change data for some item in-place, decrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for decr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key -
num -

返回:
the new value of the item's data, after the decrement operation was carried out.

抛出:

InterruptedException

MemcachedException

TimeoutException

decr

long decr(String key,
        long delta,
        long initValue)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException

参数:: key -; num -; initValue -
返回:
抛出:: TimeoutException; InterruptedException; MemcachedException
另请参阅:: decr

decr
```
long decr(String key,
        long delta,
        long initValue,
        long timeout)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"decr" are used to change data for some item in-place, decrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for decr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key - The key
num - The increment
initValue - The initial value if the data is not exists.
timeout - Operation timeout

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

flushAll

void flushAll()
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException

Make All connected memcached's data item invalid

抛出:: TimeoutException; InterruptedException; MemcachedException

flushAllWithNoReply

void flushAllWithNoReply()
                         throws InterruptedException,
                                MemcachedException

抛出:: InterruptedException; MemcachedException

flushAll

void flushAll(long timeout)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException

Make All connected memcached's data item invalid

参数:: timeout - operation timeout
抛出:: TimeoutException; InterruptedException; MemcachedException

flushAll

void flushAll(InetSocketAddress address)
              throws MemcachedException,
                     InterruptedException,
                     TimeoutException

Invalidate all existing items immediately

参数:: address - Target memcached server; timeout - operation timeout
抛出:: TimeoutException; InterruptedException; MemcachedException

flushAllWithNoReply

void flushAllWithNoReply(InetSocketAddress address)
                         throws MemcachedException,
                                InterruptedException

抛出:: MemcachedException; InterruptedException

flushAll

void flushAll(InetSocketAddress address,
            long timeout)
              throws MemcachedException,
                     InterruptedException,
                     TimeoutException

抛出:: MemcachedException; InterruptedException; TimeoutException

flushAll

@Deprecated
void flushAll(String host)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException

已过时。

This method is deprecated,please use flushAll(InetSocketAddress) instead.

参数:: host -
抛出:: TimeoutException; InterruptedException; MemcachedException

stats

Map<String,String> stats(InetSocketAddress address)
                         throws MemcachedException,
                                InterruptedException,
                                TimeoutException

抛出:: MemcachedException; InterruptedException; TimeoutException

stats

Map<String,String> stats(InetSocketAddress address,
                       long timeout)
                         throws MemcachedException,
                                InterruptedException,
                                TimeoutException

�ョ��瑰��emcached server缁��淇℃�

参数:: address - ��板�; timeout - ��瓒��
返回:
抛出:: MemcachedException; InterruptedException; TimeoutException

getStats

Map<InetSocketAddress,Map<String,String>> getStats(long timeout)
                                                   throws MemcachedException,
                                                          InterruptedException,
                                                          TimeoutException

Get stats from all memcached servers

参数:: timeout -
返回:: server->item->value map
抛出:: MemcachedException; InterruptedException; TimeoutException

getStats

Map<InetSocketAddress,Map<String,String>> getStats()
                                                   throws MemcachedException,
                                                          InterruptedException,
                                                          TimeoutException

抛出:: MemcachedException; InterruptedException; TimeoutException

getStatsByItem

Map<InetSocketAddress,Map<String,String>> getStatsByItem(String itemName)
                                                         throws MemcachedException,
                                                                InterruptedException,
                                                                TimeoutException

Get special item stats. "stats items" for example

参数:: item -
返回:
抛出:: MemcachedException; InterruptedException; TimeoutException

shutdown

void shutdown()
              throws IOException

抛出:: IOException

delete

boolean delete(String key)
               throws TimeoutException,
                      InterruptedException,
                      MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

getTranscoder
```
Transcoder getTranscoder()
```
return default transcoder,default is SerializingTranscoder

返回:

setTranscoder

void setTranscoder(Transcoder transcoder)

set transcoder

参数:: transcoder -

getStatsByItem

Map<InetSocketAddress,Map<String,String>> getStatsByItem(String itemName,
                                                       long timeout)
                                                         throws MemcachedException,
                                                                InterruptedException,
                                                                TimeoutException

抛出:: MemcachedException; InterruptedException; TimeoutException

getOpTimeout
```
long getOpTimeout()
```
get operation timeout setting

返回:

setOpTimeout
```
void setOpTimeout(long opTimeout)
```
set operation timeout,default is one second.

参数:
opTimeout -

getVersions

Map<InetSocketAddress,String> getVersions(long timeout)
                                          throws TimeoutException,
                                                 InterruptedException,
                                                 MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

getAvaliableServers
```
@Deprecated
Collection<InetSocketAddress> getAvaliableServers()
```
已过时。

Returns available memcached servers list.This method is drepcated,please use getAvailableServers instead.

返回:
另请参阅:
getAvailableServers()

getAvailableServers
```
Collection<InetSocketAddress> getAvailableServers()
```
Returns available memcached servers list.

返回:
A available server collection

addServer

void addServer(String server,
             int port,
             int weight)
               throws IOException

add a memcached server to MemcachedClient

参数:: server -; port -; weight -
抛出:: IOException

addServer

void addServer(InetSocketAddress inetSocketAddress,
             int weight)
               throws IOException

抛出:: IOException

deleteWithNoReply
```
@Deprecated
void deleteWithNoReply(String key,
                                int time)
                       throws InterruptedException,
                              MemcachedException
```
已过时。

Delete key's data item from memcached.This method doesn't wait for reply. This method does not work on memcached 1.3 or later version.See i s s u e 3
Note: This method is deprecated,because memcached 1.4.0 remove the optional argument "time".You can still use this method on old version,but is not recommended.

参数:
key -
time -

抛出:

InterruptedException

MemcachedException

deleteWithNoReply

void deleteWithNoReply(String key)
                       throws InterruptedException,
                              MemcachedException

抛出:: InterruptedException; MemcachedException

incrWithNoReply
```
void incrWithNoReply(String key,
                   long delta)
                     throws InterruptedException,
                            MemcachedException
```
"incr" are used to change data for some item in-place, incrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for incr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key -
num -

抛出:

InterruptedException

MemcachedException

decrWithNoReply
```
void decrWithNoReply(String key,
                   long delta)
                     throws InterruptedException,
                            MemcachedException
```
"decr" are used to change data for some item in-place, decrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for decr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key -
num -

抛出:

InterruptedException

MemcachedException

setLoggingLevelVerbosity

void setLoggingLevelVerbosity(InetSocketAddress address,
                            int level)
                              throws TimeoutException,
                                     InterruptedException,
                                     MemcachedException

Set the verbosity level of the memcached's logging output.This method will wait for reply.

参数:: address -; level - logging level
抛出:: TimeoutException; InterruptedException; MemcachedException

setLoggingLevelVerbosityWithNoReply

void setLoggingLevelVerbosityWithNoReply(InetSocketAddress address,
                                       int level)
                                         throws InterruptedException,
                                                MemcachedException

Set the verbosity level of the memcached's logging output.This method doesn't wait for reply from server

参数:: address - memcached server address; level - logging level
抛出:: InterruptedException; MemcachedException

addStateListener

void addStateListener(MemcachedClientStateListener listener)

Add a memcached client listener

参数:: listener -

removeStateListener
```
void removeStateListener(MemcachedClientStateListener listener)
```
Remove a memcached client listener

参数:
listener -

getStateListeners

Collection<MemcachedClientStateListener> getStateListeners()

Get all current state listeners

返回:

flushAllWithNoReply

void flushAllWithNoReply(int exptime)
                         throws InterruptedException,
                                MemcachedException

抛出:: InterruptedException; MemcachedException

flushAll

void flushAll(int exptime,
            long timeout)
              throws TimeoutException,
                     InterruptedException,
                     MemcachedException

抛出:: TimeoutException; InterruptedException; MemcachedException

flushAllWithNoReply

void flushAllWithNoReply(InetSocketAddress address,
                       int exptime)
                         throws MemcachedException,
                                InterruptedException

抛出:: MemcachedException; InterruptedException

flushAll

void flushAll(InetSocketAddress address,
            long timeout,
            int exptime)
              throws MemcachedException,
                     InterruptedException,
                     TimeoutException

抛出:: MemcachedException; InterruptedException; TimeoutException

setHealSessionInterval
```
void setHealSessionInterval(long healConnectionInterval)
```
If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.The interval between reconnections is 2 seconds by default. You can change that value by this method.

参数:
healConnectionInterval - MILLISECONDS

setEnableHealSession
```
void setEnableHealSession(boolean enableHealSession)
```
If the memcached dump or network error cause connection closed,xmemcached would try to heal the connection.You can disable this behaviour by using this method:
client.setEnableHealSession(false);
The default value is true.

参数:
enableHealSession -
从以下版本开始:

1.3.9

getHealSessionInterval
```
long getHealSessionInterval()
```
Return the default heal session interval in milliseconds

返回:

getProtocol
```
Protocol getProtocol()
```

setPrimitiveAsString
```
void setPrimitiveAsString(boolean primitiveAsString)
```
Store all primitive type as string,defualt is false.

setConnectionPoolSize
```
void setConnectionPoolSize(int poolSize)
```
In a high concurrent enviroment,you may want to pool memcached clients.But a xmemcached client has to start a reactor thread and some thread pools,if you create too many clients,the cost is very large. Xmemcached supports connection pool instreadof client pool.you can create more connections to one or more memcached servers,and these connections share the same reactor and thread pools,it will reduce the cost of system.

参数:
poolSize - pool size,default is one,every memcached has only one connection.

setEnableHeartBeat
```
void setEnableHeartBeat(boolean enableHeartBeat)
```
Whether to enable heart beat

参数:
enableHeartBeat - if true,then enable heartbeat,true by default

setSanitizeKeys
```
void setSanitizeKeys(boolean sanitizeKey)
```
Enables/disables sanitizing keys by URLEncoding.

参数:
sanitizeKey - if true, then URLEncode all keys

isSanitizeKeys
```
boolean isSanitizeKeys()
```

getCounter
```
Counter getCounter(String key)
```
Get counter for key,and if the key's value is not set,then set it with 0.

参数:
key -

返回:

getCounter
```
Counter getCounter(String key,
                 long initialValue)
```
Get counter for key,and if the key's value is not set,then set it with initial value.

参数:
key -
initialValue -

返回:

getKeyIterator
```
@Deprecated
KeyIterator getKeyIterator(InetSocketAddress address)
                           throws MemcachedException,
                                  InterruptedException,
                                  TimeoutException
```
已过时。 memcached 1.6.x will remove cachedump stats command,so this method will be removed in the future

Get key iterator for special memcached server.You must known that the iterator is a snapshot for memcached all keys,it is not real-time.The 'stats cachedump" has length limitation,so iterator could not visit all keys if you have many keys.Your application should not be dependent on this feature.

参数:
address -

返回:

抛出:

MemcachedException

InterruptedException

TimeoutException

setAuthInfoMap
```
void setAuthInfoMap(Map<InetSocketAddress,AuthInfo> map)
```
Configure auth info

参数:
map - Auth info map,key is memcached server address,and value is the auth info for the key.

getAuthInfoMap
```
Map<InetSocketAddress,AuthInfo> getAuthInfoMap()
```
return current all auth info

返回:
Auth info map,key is memcached server address,and value is the auth info for the key.

decr
```
long decr(String key,
        long delta,
        long initValue,
        long timeout,
        int exp)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"incr" are used to change data for some item in-place, incrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for incr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key -
delta -
initValue - the initial value to be added when value is not found
timeout -
exp - the initial vlaue expire time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

incr
```
long incr(String key,
        long delta,
        long initValue,
        long timeout,
        int exp)
          throws TimeoutException,
                 InterruptedException,
                 MemcachedException
```
"incr" are used to change data for some item in-place, incrementing it. The data for the item is treated as decimal representation of a 64-bit unsigned integer. If the current data value does not conform to such a representation, the commands behave as if the value were 0. Also, the item must already exist for incr to work; these commands won't pretend that a non-existent key exists with value 0; instead, it will fail.This method doesn't wait for reply.

参数:
key - key
delta - increment delta
initValue - the initial value to be added when value is not found
timeout - operation timeout
exp - the initial vlaue expire time, in seconds. Can be up to 30 days. After 30 days, is treated as a unix timestamp of an exact date.

返回:

抛出:

TimeoutException

InterruptedException

MemcachedException

getName
```
String getName()
```
Return the cache instance name

返回:

setName
```
void setName(String name)
```
Set cache instance name

参数:
name -

getReconnectRequestQueue
```
Queue<ReconnectRequest> getReconnectRequestQueue()
```
Returns reconnecting task queue,the queue is thread-safe and 'weakly consistent',but maybe you should not modify it at all.

返回:
The reconnecting task queue,if the client has not been started,returns null.

setFailureMode
```
void setFailureMode(boolean failureMode)
```
Configure wheather to set client in failure mode.If set it to true,that means you want to configure client in failure mode. Failure mode is that when a memcached server is down,it would not taken from the server list but marked as unavailable,and then further requests to this server will be transformed to standby node if configured or throw an exception until it comes back up.

参数:
failureMode - true is to configure client in failure mode.

isFailureMode
```
boolean isFailureMode()
```
Returns if client is in failure mode.

返回:

setKeyProvider
```
void setKeyProvider(KeyProvider keyProvider)
```
Set a key provider for pre-processing keys before sending them to memcached.

参数:
keyProvider -
从以下版本开始:

1.3.8

getTimeoutExceptionThreshold
```
int getTimeoutExceptionThreshold()
```
Returns maximum number of timeout exception for closing connection.

返回:

setTimeoutExceptionThreshold
```
void setTimeoutExceptionThreshold(int timeoutExceptionThreshold)
```
Set maximum number of timeout exception for closing connection.You can set it to be a large value to disable this feature.

参数:
timeoutExceptionThreshold -
另请参阅:
DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD

invalidateNamespace

void invalidateNamespace(String ns)
                         throws MemcachedException,
                                InterruptedException,
                                TimeoutException

Invalidate all namespace under the namespace using the default operation timeout.

参数:: ns - the namespace
抛出:: MemcachedException; InterruptedException; TimeoutException
从以下版本开始:: 1.4.2

invalidateNamespace

void invalidateNamespace(String ns,
                       long opTimeout)
                         throws MemcachedException,
                                InterruptedException,
                                TimeoutException

Invalidate all items under the namespace.

参数:: ns - the namespace; opTimeout - operation timeout in milliseconds.
抛出:: MemcachedException; InterruptedException; TimeoutException
从以下版本开始:: 1.4.2

endWithNamespace
```
void endWithNamespace()
```
Remove current namespace set for this memcached client.It must begin with beginWithNamespace(String) method.

另请参阅:
beginWithNamespace(String)

beginWithNamespace

void beginWithNamespace(String ns)

set current namespace for following operations with memcached client.It must be ended with endWithNamespace() method.For example:

    memcachedClient.beginWithNamespace(userId);
    try{
      memcachedClient.set("username",0,username);
      memcachedClient.set("email",0,email);
    }finally{
      memcachedClient.endWithNamespace();
    }

参数:: ns -
另请参阅:: endWithNamespace(), withNamespace(String, MemcachedClientCallable)

withNamespace

<T> T withNamespace(String ns,
                  MemcachedClientCallable<T> callable)
                throws MemcachedException,
                       InterruptedException,
                       TimeoutException

With the namespae to do something with current memcached client.All operations with memcached client done in callable will be under the namespace. beginWithNamespace(String) and endWithNamespace() will called around automatically. For example:

   memcachedClient.withNamespace(userId,new MemcachedClientCallable{
     public Void call(MemcachedClient client) throws MemcachedException,
                        InterruptedException, TimeoutException{
      client.set("username",0,username);
      client.set("email",0,email);
      return null;
     }
   });
   //invalidate all items under the namespace.
   memcachedClient.invalidateNamespace(userId);

参数:: ns -; callable -
返回:
抛出:: MemcachedException; InterruptedException; TimeoutException
从以下版本开始:: 1.4.2
另请参阅:: beginWithNamespace(String), endWithNamespace()

接口 MemcachedClient

字段概要

方法概要

字段详细资料

DEFAULT_READ_THREAD_COUNT

DEFAULT_TCP_KEEPLIVE

DEFAULT_CONNECT_TIMEOUT

DEFAULT_TCP_SEND_BUFF_SIZE

DEFAULT_TCP_NO_DELAY

DEFAULT_SESSION_READ_BUFF_SIZE

DEFAULT_TCP_RECV_BUFF_SIZE

DEFAULT_OP_TIMEOUT

DEFAULT_CONNECTION_POOL_SIZE

DEFAULT_SESSION_IDLE_TIMEOUT

DEFAULT_HEAL_SESSION_INTERVAL

MAX_QUEUED_NOPS

DYNAMIC_MAX_QUEUED_NOPS

DEFAULT_MAX_QUEUED_NOPS

DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD

方法详细资料

setMergeFactor

getConnectTimeout

setConnectTimeout

getConnector

setOptimizeGet

setOptimizeMergeBuffer

isShutdown

addServer

addServer

addServer

getServersDescription

removeServer

setBufferAllocator

get

get

get

get

gets

gets

gets

gets

get

get

get

get

gets

gets

gets

gets

set

set

set

set

setWithNoReply

setWithNoReply

add

add

add

add

addWithNoReply

addWithNoReply

replace

replace

replace

replace

replaceWithNoReply

replaceWithNoReply

append

append

appendWithNoReply

prepend

prepend

prependWithNoReply

cas

cas

cas

cas

cas

cas

cas