Class XMemcachedClient

java.lang.Object

net.rubyeye.xmemcached.XMemcachedClient

All Implemented Interfaces:

MemcachedClient, XMemcachedClientMBean

Direct Known Subclasses:

AWSElasticCacheClient

public class XMemcachedClient
extends Object
implements XMemcachedClientMBean, MemcachedClient

Memcached Client for connecting to memcached server and do operations.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<InetSocketAddress, AuthInfo>	authInfoMap
private Map<String,AuthInfo>	authInfoStringMap
protected CommandFactory	commandFactory
protected int	connectionPoolSize
protected MemcachedConnector	connector
private long	connectTimeout
private static final String	CONTINUOUS_TIMEOUT_COUNTER
private boolean	failureMode
private boolean	isHutdownHookCalled
private KeyProvider	keyProvider
private static final org.slf4j.Logger	log
protected int	maxQueuedNoReplyOperations
private MemcachedHandler	memcachedHandler
private String	name
static final ThreadLocal<String>	NAMESPACE_LOCAL	namespace thread local.
protected long	opTimeout
protected boolean	resolveInetAddresses
private boolean	sanitizeKeys
protected final AtomicInteger	serverOrderCount
protected MemcachedSessionComparator	sessionComparator
protected MemcachedSessionLocator	sessionLocator
private boolean	shutdown
private Thread	shutdownHookThread
private final CopyOnWriteArrayList<MemcachedClientStateListenerAdapter>	stateListenerAdapters
private int	timeoutExceptionThreshold
private Transcoder	transcoder

Fields inherited from interface MemcachedClient

DEFAULT_CONNECT_TIMEOUT, DEFAULT_CONNECTION_POOL_SIZE, DEFAULT_HEAL_SESSION_INTERVAL, DEFAULT_MAX_QUEUED_NOPS, DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD, DEFAULT_OP_TIMEOUT, DEFAULT_READ_THREAD_COUNT, DEFAULT_SESSION_IDLE_TIMEOUT, DEFAULT_SESSION_READ_BUFF_SIZE, DEFAULT_TCP_KEEPLIVE, DEFAULT_TCP_NO_DELAY, DEFAULT_TCP_RECV_BUFF_SIZE, DEFAULT_TCP_SEND_BUFF_SIZE, DYNAMIC_MAX_QUEUED_NOPS, MAX_QUEUED_NOPS

Constructor Summary

Constructors

Constructor	Description
XMemcachedClient()
XMemcachedClient(String server, int port)	XMemcached constructor,default weight is 1
XMemcachedClient(String host, int port, int weight)	XMemcached constructor
XMemcachedClient(InetSocketAddress inetSocketAddress)
XMemcachedClient(InetSocketAddress inetSocketAddress, int weight)
XMemcachedClient(InetSocketAddress inetSocketAddress, int weight, CommandFactory cmdFactory)	XMemcached Constructor.
XMemcachedClient(List<InetSocketAddress> addressList)	XMemcached Constructor.Every server's weight is one by default.
XMemcachedClient(List<InetSocketAddress> addressList, CommandFactory cmdFactory)	XMemcached Constructor.Every server's weight is one by default.
XMemcachedClient(MemcachedSessionLocator locator, MemcachedSessionComparator comparator, BufferAllocator allocator, Configuration conf, Map<SocketOption, Object> socketOptions, CommandFactory commandFactory, Transcoder transcoder, Map<InetSocketAddress, InetSocketAddress> addressMap, int[] weights, List<MemcachedClientStateListener> stateListeners, Map<InetSocketAddress, AuthInfo> infoMap, int poolSize, long connectTimeout, String name, boolean failureMode, boolean resolveInetAddresses)	XMemcachedClient constructor.
XMemcachedClient(MemcachedSessionLocator locator, MemcachedSessionComparator comparator, BufferAllocator allocator, Configuration conf, Map<SocketOption, Object> socketOptions, CommandFactory commandFactory, Transcoder transcoder, Map<InetSocketAddress, InetSocketAddress> addressMap, List<MemcachedClientStateListener> stateListeners, Map<InetSocketAddress, AuthInfo> map, int poolSize, long connectTimeout, String name, boolean failureMode, boolean resolveInetAddresses)	XMemcachedClient constructor.Every server's weight is one by default.

Method Summary

Modifier and Type	Method	Description
final boolean	add(String key, int exp, Object value)
final boolean	add(String key, int exp, Object value, long timeout)
final <T> boolean	add(String key, int exp, T value, Transcoder<T> transcoder)
final <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.
private <T> boolean	add0(String key, int exp, T value, Transcoder<T> transcoder, long timeout)
void	addOneServerWithWeight(String server, int weight)	Add a memcached server
final void	addServer(String hostList)	Add memcached servers
final 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)
final void	addServer(String server, int port, int weight)	add a memcached server to MemcachedClient
final void	addServer(InetSocketAddress inetSocketAddress)	Add a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)
final void	addServer(InetSocketAddress inetSocketAddress, int weight)
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)
final boolean	append(String key, Object value)
final 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 MemcachedClient.endWithNamespace() method.For example:
private void	buildConnector(MemcachedSessionLocator locator, MemcachedSessionComparator comparator, BufferAllocator bufferAllocator, Configuration configuration, Map<SocketOption, Object> socketOptions, CommandFactory commandFactory, Transcoder transcoder)
final boolean	cas(String key, int exp, Object value, long cas)
final boolean	cas(String key, int exp, Object value, long timeout, long cas)
final <T> boolean	cas(String key, int exp, CASOperation<T> operation)
final <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."
final <T> boolean	cas(String key, int exp, GetsResponse<T> getsReponse, CASOperation<T> operation)
final <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."
final <T> boolean	cas(String key, int exp, T value, Transcoder<T> transcoder, long cas)
final <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."
final <T> boolean	cas(String key, CASOperation<T> operation)
final <T> boolean	cas(String key, GetsResponse<T> getsReponse, CASOperation<T> operation)
private final <T> boolean	cas0(String key, int exp, GetsResponse<T> getsResponse, CASOperation<T> operation, Transcoder<T> transcoder, byte[] keyBytes, boolean noreply)
<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
<T> void	casWithNoReply(String key, CASOperation<T> operation)
<T> void	casWithNoReply(String key, GetsResponse<T> getsResponse, CASOperation<T> operation)
private final Collection<List<String>>	catalogKeys(Collection<String> keyCollections)	Hash key to servers
protected void	checkException(Command command)
private void	checkServerPort(String server, int port)
private final <T> byte[]	checkStoreArguments(String key, int exp, T value)
protected void	connect(InetSocketAddressWrapper inetSocketAddressWrapper)
private String	decodeKey(String key)
final 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.
final void	decrWithNoReply(String key, long delta)	"decr" are used to change data for some item in-place, decrementing it.
final boolean	delete(String key)
final boolean	delete(String key, int time)	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.
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.
private boolean	delete0(String key, int time, long cas, boolean noreply, long opTimeout)
final void	deleteWithNoReply(String key)
final void	deleteWithNoReply(String key, int time)	Delete key's data item from memcached.This method doesn't wait for reply
void	endWithNamespace()	Remove current namespace set for this memcached client.It must begin with MemcachedClient.beginWithNamespace(String) method.
private final <T> Object	fetch0(String key, byte[] keyBytes, CommandType cmdType, long timeout, Transcoder<T> transcoder)
final void	flushAll()	Make All connected memcached's data item invalid
final void	flushAll(int exptime, long timeout)
final void	flushAll(long timeout)	Make All connected memcached's data item invalid
final void	flushAll(String host)	This method is deprecated,please use flushAll(InetSocketAddress) instead.
final void	flushAll(InetSocketAddress address)	Invalidate all existing items immediately
final void	flushAll(InetSocketAddress address, long timeout)
final void	flushAll(InetSocketAddress address, long timeout, int exptime)
private void	flushAllMemcachedServers(long timeout, boolean noreply, int exptime)
void	flushAllWithNoReply()
void	flushAllWithNoReply(int exptime)
void	flushAllWithNoReply(InetSocketAddress address)
void	flushAllWithNoReply(InetSocketAddress address, int exptime)
private void	flushSpecialMemcachedServer(InetSocketAddress address, long timeout, boolean noreply, int exptime)
final <T> T	get(String key)
final <T> T	get(String key, long timeout)
final <T> T	get(String key, long timeout, Transcoder<T> transcoder)	Get value by key
final <T> T	get(String key, Transcoder<T> transcoder)
final <T> Map<String,T>	get(Collection<String> keyCollections)
final <T> Map<String,T>	get(Collection<String> keyCollections, long timeout)
final <T> Map<String,T>	get(Collection<String> keyCollections, long timeout, Transcoder<T> transcoder)	Bulk get items
final <T> Map<String,T>	get(Collection<String> keyCollections, Transcoder<T> transcoder)
private <T> Object	get0(String key, long timeout, CommandType cmdType, 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
Map<String,AuthInfo>	getAuthInfoStringMap()	Retruns the AuthInfo for all server strings (hostname:port)
Collection<InetSocketAddress>	getAvailableServers()	Returns available memcached servers list.
final Collection<InetSocketAddress>	getAvaliableServers()	Deprecated.
final CommandFactory	getCommandFactory()
final int	getConnectionSizeBySocketAddress(InetSocketAddress address)
final Connector	getConnector()	return the session manager
long	getConnectTimeout()	Get the connect timeout
private AtomicInteger	getContinuousTimeoutCounter(Session session)
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)	Deprecated. memcached 1.6.x will remove cachedump stats command,so this method will be removed in the future
KeyProvider	getKeyProvider()
private final <T> Map<String,T>	getMulti0(Collection<String> keys, long timeout, CommandType cmdType, Transcoder<T> transcoder)
String	getName()	Return the cache instance name
String	getNamespace(String ns)	Returns the real namespace of ns.
private String	getNSKey(String ns)
final 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.
final <T> GetsResponse<T>	gets(String key)
final <T> GetsResponse<T>	gets(String key, long timeout)
final <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.
final <T> GetsResponse<T>	gets(String key, Transcoder transcoder)
final <T> Map<String, GetsResponse<T>>	gets(Collection<String> keyCollections)
final <T> Map<String, GetsResponse<T>>	gets(Collection<String> keyCollections, long timeout)
final <T> Map<String, GetsResponse<T>>	gets(Collection<String> keyCollections, long timeout, Transcoder<T> transcoder)	Bulk gets items
final <T> Map<String, GetsResponse<T>>	gets(Collection<String> keyCollections, Transcoder<T> transcoder)
private final <T> GetsResponse<T>	gets0(String key, byte[] keyBytes, Transcoder<T> transcoder)
final List<String>	getServersDescription()	Get all connected memcached servers
final MemcachedSessionComparator	getSessionComparator()
final MemcachedSessionLocator	getSessionLocator()
Collection<MemcachedClientStateListener>	getStateListeners()	Get all current state listeners
final Map<InetSocketAddress, Map<String,String>>	getStats()
Map<InetSocketAddress, Map<String,String>>	getStats(long timeout)	Get stats from all memcached servers
final Map<InetSocketAddress, Map<String,String>>	getStatsByItem(String itemName)	Get special item stats.
final Map<InetSocketAddress, Map<String,String>>	getStatsByItem(String itemName, long timeout)
int	getTimeoutExceptionThreshold()	Returns maximum number of timeout exception for closing connection.
final Transcoder	getTranscoder()	return default transcoder,default is SerializingTranscoder
final Map<InetSocketAddress, String>	getVersions()	Get all connected memcached servers's version.
final Map<InetSocketAddress, String>	getVersions(long timeout)
final 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.
final 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()
final boolean	isShutdown()
private final boolean	isWindowsPlatform()
protected void	latchWait(Command cmd, long timeout, Session session)
protected MemcachedConnector	newConnector(BufferAllocator bufferAllocator, Configuration configuration, MemcachedSessionLocator memcachedSessionLocator, MemcachedSessionComparator memcachedSessionComparator, CommandFactory commandFactory, int poolSize, int maxQueuedNoReplyOperations)
protected InetSocketAddress	newSocketAddress(String server, int port)
private final void	optimiezeSetReadThreadCount(Configuration conf, int addressCount)
final boolean	prepend(String key, Object value)
final 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.
private String	preProcessKey(String key)
private <T> Map<String,T>	reduceResult(CommandType cmdType, Transcoder<T> transcoder, List<Command> commands)
private final void	registerMBean()
final void	removeServer(String hostList)	Remove memcached servers
void	removeServer(InetSocketAddress address)	Remove memcached server with the exact given address.
void	removeStateListener(MemcachedClientStateListener listener)	Remove a memcached client listener
final boolean	replace(String key, int exp, Object value)
final boolean	replace(String key, int exp, Object value, long timeout)
final <T> boolean	replace(String key, int exp, T value, Transcoder<T> transcoder)
final <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)
protected final Session	sendCommand(Command cmd)
private final <T> Command	sendGetMultiCommand(Collection<String> keys, CountDownLatch latch, CommandType cmdType, Transcoder<T> transcoder)
private long	sendIncrOrDecrCommand(String key, long delta, long initValue, CommandType cmdType, boolean noreply, long operationTimeout, int exp)
private final <T> boolean	sendStoreCommand(Command command, long timeout)
final boolean	set(String key, int exp, Object value)
final boolean	set(String key, int exp, Object value, long timeout)
final <T> boolean	set(String key, int exp, T value, Transcoder<T> transcoder)
final <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
final void	setBufferAllocator(BufferAllocator bufferAllocator)	Set the nio's ByteBuffer Allocator,use SimpleBufferAllocator by default.
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
(package private) void	setMaxQueuedNoReplyOperations(int maxQueuedNoReplyOperations)	Set max queued noreply operations number
private void	setMemcachedLoggingLevel(InetSocketAddress address, int level, boolean noreply)
final 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
final 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.
final 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 sanitizeKeys)	Enables/disables sanitizing keys by URLEncoding.
final void	setServerWeight(String server, int weight)	Set a memcached server's weight
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.
final 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)
final void	shutdown()
protected void	shutdown0()	For subclass override.
private final void	start0()
private final void	startConnector()
final Map<String,String>	stats(InetSocketAddress address)
final 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.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

private static final org.slf4j.Logger log

sessionLocator

protected MemcachedSessionLocator sessionLocator

sessionComparator

protected MemcachedSessionComparator sessionComparator

shutdown

private volatile boolean shutdown

connector

protected MemcachedConnector connector

transcoder

private Transcoder transcoder

sanitizeKeys

private boolean sanitizeKeys

memcachedHandler

private MemcachedHandler memcachedHandler

commandFactory

protected CommandFactory commandFactory

opTimeout

protected long opTimeout

connectTimeout

private long connectTimeout

connectionPoolSize

protected int connectionPoolSize

maxQueuedNoReplyOperations

protected int maxQueuedNoReplyOperations

resolveInetAddresses

protected boolean resolveInetAddresses

serverOrderCount

protected final AtomicInteger serverOrderCount

authInfoMap

private Map<InetSocketAddress, AuthInfo> authInfoMap

authInfoStringMap

private Map<String,AuthInfo> authInfoStringMap

name

private String name

failureMode

private boolean failureMode

timeoutExceptionThreshold

private int timeoutExceptionThreshold

stateListenerAdapters

private final CopyOnWriteArrayList<MemcachedClientStateListenerAdapter> stateListenerAdapters

shutdownHookThread

private Thread shutdownHookThread

isHutdownHookCalled

private volatile boolean isHutdownHookCalled

keyProvider

private KeyProvider keyProvider

NAMESPACE_LOCAL

public static final ThreadLocal<String> NAMESPACE_LOCAL

namespace thread local.

CONTINUOUS_TIMEOUT_COUNTER

private static final String CONTINUOUS_TIMEOUT_COUNTER

See Also:

• Constant Field Values

Constructor Details

XMemcachedClient

public XMemcachedClient(String server,
 int port)
                 throws IOException

XMemcached constructor,default weight is 1

Parameters:

server - �����P

port - ����ㄧ���

Throws:

IOException

XMemcachedClient

public XMemcachedClient(String host,
 int port,
 int weight)
                 throws IOException

XMemcached constructor

Parameters:

host - server host

port - server port

weight - server weight

Throws:

IOException

XMemcachedClient

public XMemcachedClient(InetSocketAddress inetSocketAddress,
 int weight,
 CommandFactory cmdFactory)
                 throws IOException

XMemcached Constructor.

Parameters:

inetSocketAddress -

weight -

Throws:

IOException

XMemcachedClient

public XMemcachedClient(InetSocketAddress inetSocketAddress,
 int weight)
                 throws IOException

Throws:

IOException

XMemcachedClient

public XMemcachedClient(InetSocketAddress inetSocketAddress)
                 throws IOException

Throws:

IOException

XMemcachedClient

public XMemcachedClient()
                 throws IOException

Throws:

IOException

XMemcachedClient

public XMemcachedClient(MemcachedSessionLocator locator,
 MemcachedSessionComparator comparator,
 BufferAllocator allocator,
 Configuration conf,
 Map<SocketOption, Object> socketOptions,
 CommandFactory commandFactory,
 Transcoder transcoder,
 Map<InetSocketAddress, InetSocketAddress> addressMap,
 List<MemcachedClientStateListener> stateListeners,
 Map<InetSocketAddress, AuthInfo> map,
 int poolSize,
 long connectTimeout,
 String name,
 boolean failureMode,
 boolean resolveInetAddresses)
                 throws IOException

XMemcachedClient constructor.Every server's weight is one by default. You should not new client instance by this method, use MemcachedClientBuilder instead.

Parameters:

locator -

comparator -

allocator -

conf -

commandFactory -

transcoder -

stateListeners -

addressList -

Throws:

IOException

XMemcachedClient

XMemcachedClient(MemcachedSessionLocator locator,
 MemcachedSessionComparator comparator,
 BufferAllocator allocator,
 Configuration conf,
 Map<SocketOption, Object> socketOptions,
 CommandFactory commandFactory,
 Transcoder transcoder,
 Map<InetSocketAddress, InetSocketAddress> addressMap,
 int[] weights,
 List<MemcachedClientStateListener> stateListeners,
 Map<InetSocketAddress, AuthInfo> infoMap,
 int poolSize,
 long connectTimeout,
 String name,
 boolean failureMode,
 boolean resolveInetAddresses)
          throws IOException

XMemcachedClient constructor.

Parameters:

locator -

comparator -

allocator -

conf -

commandFactory -

transcoder -

weights -

stateListeners - weight array for address list

addressList -

Throws:

IOException

XMemcachedClient

public XMemcachedClient(List<InetSocketAddress> addressList)
                 throws IOException

XMemcached Constructor.Every server's weight is one by default.

Parameters:

addressList -

Throws:

IOException

XMemcachedClient

public XMemcachedClient(List<InetSocketAddress> addressList,
 CommandFactory cmdFactory)
                 throws IOException

XMemcached Constructor.Every server's weight is one by default.

Parameters:

addressList - memcached server socket address list.

cmdFactory - command factory

Throws:

IOException

Method Details

setMergeFactor

public final void setMergeFactor(int mergeFactor)

Description copied from interface: MemcachedClient

Set the merge factor,this factor determins how many 'get' commands would be merge to one multi-get command.default is 150

Specified by:

setMergeFactor in interface MemcachedClient

Parameters:

mergeFactor -

getTimeoutExceptionThreshold

public int getTimeoutExceptionThreshold()

Description copied from interface: MemcachedClient

Returns maximum number of timeout exception for closing connection.

Specified by:

getTimeoutExceptionThreshold in interface MemcachedClient

Returns:

setTimeoutExceptionThreshold

public void setTimeoutExceptionThreshold(int timeoutExceptionThreshold)

Description copied from interface: MemcachedClient

Set maximum number of timeout exception for closing connection.You can set it to be a large value to disable this feature.

Specified by:

setTimeoutExceptionThreshold in interface MemcachedClient

Parameters:

timeoutExceptionThreshold -

See Also:

• MemcachedClient.DEFAULT_MAX_TIMEOUTEXCEPTION_THRESHOLD

withNamespace

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

Description copied from interface: MemcachedClient

With the namespae to do something with current memcached client.All operations with memcached client done in callable will be under the namespace. MemcachedClient.beginWithNamespace(String) and MemcachedClient.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);

Specified by:

withNamespace in interface MemcachedClient

Parameters:

ns -

callable -

Returns:

Throws:

MemcachedException

InterruptedException

TimeoutException

See Also:

• MemcachedClient.beginWithNamespace(String)
• MemcachedClient.endWithNamespace()

endWithNamespace

public void endWithNamespace()

Description copied from interface: MemcachedClient

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

Specified by:

endWithNamespace in interface MemcachedClient

See Also:

• MemcachedClient.beginWithNamespace(String)

beginWithNamespace

public void beginWithNamespace(String ns)

Description copied from interface: MemcachedClient

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

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

Specified by:

beginWithNamespace in interface MemcachedClient

Parameters:

ns -

See Also:

• MemcachedClient.endWithNamespace()
• MemcachedClient.withNamespace(String, MemcachedClientCallable)

getKeyProvider

public KeyProvider getKeyProvider()

setKeyProvider

public void setKeyProvider(KeyProvider keyProvider)

Description copied from interface: MemcachedClient

Set a key provider for pre-processing keys before sending them to memcached.

Specified by:

setKeyProvider in interface MemcachedClient

Parameters:

keyProvider -

getSessionLocator

public final MemcachedSessionLocator getSessionLocator()

getSessionComparator

public final MemcachedSessionComparator getSessionComparator()

getCommandFactory

public final CommandFactory getCommandFactory()

getName

public String getName()

Description copied from interface: XMemcachedClientMBean

Return the cache instance name

Specified by:

getName in interface MemcachedClient

Specified by:

getName in interface XMemcachedClientMBean

Returns:

setName

public void setName(String name)

Description copied from interface: MemcachedClient

Set cache instance name

Specified by:

setName in interface MemcachedClient

Parameters:

name -

getConnectTimeout

public long getConnectTimeout()

Description copied from interface: MemcachedClient

Get the connect timeout

Specified by:

getConnectTimeout in interface MemcachedClient

setConnectTimeout

public void setConnectTimeout(long connectTimeout)

Description copied from interface: MemcachedClient

Set the connect timeout,default is 1 minutes

Specified by:

setConnectTimeout in interface MemcachedClient

Parameters:

connectTimeout -

setEnableHeartBeat

public void setEnableHeartBeat(boolean enableHeartBeat)

Description copied from interface: MemcachedClient

Whether to enable heart beat

Specified by:

setEnableHeartBeat in interface MemcachedClient

Parameters:

enableHeartBeat - if true,then enable heartbeat,true by default

getOpTimeout

public final long getOpTimeout()

get operation timeout setting

Specified by:

getOpTimeout in interface MemcachedClient

Returns:

setOpTimeout

public final void setOpTimeout(long opTimeout)

set operation timeout,default is one second.

Specified by:

setOpTimeout in interface MemcachedClient

Parameters:

opTimeout -

setHealSessionInterval

public void setHealSessionInterval(long healConnectionInterval)

Description copied from interface: MemcachedClient

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.

Specified by:

setHealSessionInterval in interface MemcachedClient

Parameters:

healConnectionInterval - MILLISECONDS

getHealSessionInterval

public long getHealSessionInterval()

Description copied from interface: MemcachedClient

Return the default heal session interval in milliseconds

Specified by:

getHealSessionInterval in interface MemcachedClient

Returns:

getAuthInfoMap

public Map<InetSocketAddress, AuthInfo> getAuthInfoMap()

Description copied from interface: MemcachedClient

return current all auth info

Specified by:

getAuthInfoMap in interface MemcachedClient

Returns:

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

setAuthInfoMap

public void setAuthInfoMap(Map<InetSocketAddress, AuthInfo> map)

Description copied from interface: MemcachedClient

Configure auth info

Specified by:

setAuthInfoMap in interface MemcachedClient

Parameters:

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

getAuthInfoStringMap

public Map<String,AuthInfo> getAuthInfoStringMap()

Description copied from interface: MemcachedClient

Retruns the AuthInfo for all server strings (hostname:port)

Specified by:

getAuthInfoStringMap in interface MemcachedClient

Returns:

A map of AuthInfos for server strings (hostname:port)

getConnector

public final Connector getConnector()

Description copied from interface: MemcachedClient

return the session manager

Specified by:

getConnector in interface MemcachedClient

Returns:

setOptimizeMergeBuffer

public final void setOptimizeMergeBuffer(boolean optimizeMergeBuffer)

Description copied from interface: MemcachedClient

Enable/Disable merge many command's buffers to one big buffer fit socket's send buffer size.Default is true.Recommend true.

Specified by:

setOptimizeMergeBuffer in interface MemcachedClient

Parameters:

optimizeMergeBuffer -

isShutdown

public final boolean isShutdown()

Specified by:

isShutdown in interface MemcachedClient

Returns:

gets0

private final <T> GetsResponse<T> gets0(String key,
 byte[] keyBytes,
 Transcoder<T> transcoder)
                                 throws MemcachedException,
TimeoutException,
InterruptedException

Throws:

MemcachedException

TimeoutException

InterruptedException

sendCommand

protected final Session sendCommand(Command cmd)
                             throws MemcachedException

Throws:

MemcachedException

newSocketAddress

protected InetSocketAddress newSocketAddress(String server,
 int port)

checkServerPort

private void checkServerPort(String server,
 int port)

addServer

public final void addServer(String server,
 int port)
                     throws IOException

Description copied from interface: MemcachedClient

Aadd a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)

Specified by:

addServer in interface MemcachedClient

Parameters:

server - host string

port - port number

Throws:

IOException

addServer

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

add a memcached server to MemcachedClient

Specified by:

addServer in interface MemcachedClient

Parameters:

server -

port -

weight -

Throws:

IOException

addServer

public final void addServer(InetSocketAddress inetSocketAddress)
                     throws IOException

Description copied from interface: MemcachedClient

Add a memcached server,the thread call this method will be blocked until the connecting operations completed(success or fail)

Specified by:

addServer in interface MemcachedClient

Parameters:

inetSocketAddress - memcached server's socket address

Throws:

IOException

addServer

public final void addServer(InetSocketAddress inetSocketAddress,
 int weight)
                     throws IOException

Specified by:

addServer in interface MemcachedClient

Throws:

IOException

addServer

public final void addServer(String hostList)
                     throws IOException

Description copied from interface: XMemcachedClientMBean

Add memcached servers

Specified by:

addServer in interface MemcachedClient

Specified by:

addServer in interface XMemcachedClientMBean

Throws:

IOException

addOneServerWithWeight

public void addOneServerWithWeight(String server,
 int weight)
                            throws IOException

Description copied from interface: XMemcachedClientMBean

Add a memcached server

Specified by:

addOneServerWithWeight in interface XMemcachedClientMBean

Parameters:

server - a String in the form of "[host1]:[port1],[host2]:[port2]"

weight - server's weight

Throws:

IOException

getServersDescription

public final List<String> getServersDescription()

Description copied from interface: XMemcachedClientMBean

Get all connected memcached servers

Specified by:

getServersDescription in interface MemcachedClient

Specified by:

getServersDescription in interface XMemcachedClientMBean

Returns:

a list of string,every string is in the form of "[host1]:[port1](weight=num1) [host2]:[port2](weight=num1)"

setServerWeight

public final void setServerWeight(String server,
 int weight)

Description copied from interface: XMemcachedClientMBean

Set a memcached server's weight

Specified by:

setServerWeight in interface XMemcachedClientMBean

Parameters:

server -

weight -

removeServer

public final void removeServer(String hostList)

Description copied from interface: XMemcachedClientMBean

Remove memcached servers

Specified by:

removeServer in interface MemcachedClient

Specified by:

removeServer in interface XMemcachedClientMBean

removeServer

public void removeServer(InetSocketAddress address)

Description copied from interface: MemcachedClient

Remove memcached server with the exact given address.

Specified by:

removeServer in interface MemcachedClient

Parameters:

address - Resolved server address

connect

protected void connect(InetSocketAddressWrapper inetSocketAddressWrapper)
                throws IOException

Throws:

IOException

fetch0

private final <T> Object fetch0(String key,
 byte[] keyBytes,
 CommandType cmdType,
 long timeout,
 Transcoder<T> transcoder)
                         throws InterruptedException,
TimeoutException,
MemcachedException

Throws:

InterruptedException

TimeoutException

MemcachedException

start0

private final void start0()
                   throws IOException

Throws:

IOException

startConnector

private final void startConnector()
                           throws IOException

Throws:

IOException

setMaxQueuedNoReplyOperations

void setMaxQueuedNoReplyOperations(int maxQueuedNoReplyOperations)

Set max queued noreply operations number

Parameters:

maxQueuedNoReplyOperations -

buildConnector

private void buildConnector(MemcachedSessionLocator locator,
 MemcachedSessionComparator comparator,
 BufferAllocator bufferAllocator,
 Configuration configuration,
 Map<SocketOption, Object> socketOptions,
 CommandFactory commandFactory,
 Transcoder transcoder)

newConnector

protected MemcachedConnector newConnector(BufferAllocator bufferAllocator,
 Configuration configuration,
 MemcachedSessionLocator memcachedSessionLocator,
 MemcachedSessionComparator memcachedSessionComparator,
 CommandFactory commandFactory,
 int poolSize,
 int maxQueuedNoReplyOperations)

registerMBean

private final void registerMBean()

setOptimizeGet

public void setOptimizeGet(boolean optimizeGet)

Description copied from interface: MemcachedClient

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.

Specified by:

setOptimizeGet in interface MemcachedClient

Parameters:

optimizeGet -

setBufferAllocator

public final void setBufferAllocator(BufferAllocator bufferAllocator)

Description copied from interface: MemcachedClient

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

Specified by:

setBufferAllocator in interface MemcachedClient

Parameters:

bufferAllocator -

optimiezeSetReadThreadCount

private final void optimiezeSetReadThreadCount(Configuration conf,
 int addressCount)

isWindowsPlatform

private final boolean isWindowsPlatform()

get

public final <T> T get(String key,
 long timeout,
 Transcoder<T> transcoder)
                throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Get value by key

Specified by:

get in interface MemcachedClient

Type Parameters:

T -

Parameters:

key - Key

timeout - Operation timeout,if the method is not returned in this time,throw TimeoutException

transcoder - The value's transcoder

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

get

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

Specified by:

get in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

get

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

Specified by:

get in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

get

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

Specified by:

get in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

get0

private <T> Object get0(String key,
 long timeout,
 CommandType cmdType,
 Transcoder<T> transcoder)
                 throws TimeoutException,
InterruptedException,
MemcachedException

Throws:

TimeoutException

InterruptedException

MemcachedException

gets

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

Description copied from interface: MemcachedClient

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

key - key

timeout - operation timeout

transcoder -

Returns:

GetsResponse

Throws:

TimeoutException

InterruptedException

MemcachedException

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(String, long, Transcoder)

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

timeout -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(String, long, Transcoder)

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

transcoder -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(String, long, Transcoder)

get

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

Description copied from interface: MemcachedClient

Bulk get items

Specified by:

get in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections - key collection

timeout - opTimeout

transcoder - Value transcoder

Returns:

Exists items map

Throws:

TimeoutException

InterruptedException

MemcachedException

get

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

Specified by:

get in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

transcoder -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.get(Collection, long, Transcoder)

get

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

Specified by:

get in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.get(Collection, long, Transcoder)

get

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

Specified by:

get in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

timeout -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.get(Collection, long, Transcoder)

gets

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

Description copied from interface: MemcachedClient

Bulk gets items

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections - key collection

timeout - Operation timeout

transcoder - Value transcoder

Returns:

Exists GetsResponse map

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• GetsResponse

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(Collection, long, Transcoder)

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

timeout -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(Collection, long, Transcoder)

gets

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

Specified by:

gets in interface MemcachedClient

Type Parameters:

T -

Parameters:

keyCollections -

transcoder -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.gets(Collection, long, Transcoder)

getMulti0

private final <T> Map<String,T> getMulti0(Collection<String> keys,
 long timeout,
 CommandType cmdType,
 Transcoder<T> transcoder)
                                   throws TimeoutException,
InterruptedException,
MemcachedException

Throws:

TimeoutException

InterruptedException

MemcachedException

reduceResult

private <T> Map<String,T> reduceResult(CommandType cmdType,
 Transcoder<T> transcoder,
 List<Command> commands)
                                throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

catalogKeys

private final Collection<List<String>> catalogKeys(Collection<String> keyCollections)

Hash key to servers

Parameters:

keyCollections -

Returns:

sendGetMultiCommand

private final <T> Command sendGetMultiCommand(Collection<String> keys,
 CountDownLatch latch,
 CommandType cmdType,
 Transcoder<T> transcoder)
                                       throws InterruptedException,
TimeoutException,
MemcachedException

Throws:

InterruptedException

TimeoutException

MemcachedException

set

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

Description copied from interface: MemcachedClient

Store key-value item to memcached

Specified by:

set in interface MemcachedClient

Type Parameters:

T -

Parameters:

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

Returns:

boolean result

Throws:

TimeoutException

InterruptedException

MemcachedException

setWithNoReply

public void setWithNoReply(String key,
 int exp,
 Object value)
                    throws InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Store key-value item to memcached,doesn't wait for reply

Specified by:

setWithNoReply in interface MemcachedClient

Parameters:

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

Throws:

InterruptedException

MemcachedException

setWithNoReply

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

Specified by:

setWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

Throws:

InterruptedException

MemcachedException

See Also:

• MemcachedClient.setWithNoReply(String, int, Object, Transcoder)

checkStoreArguments

private final <T> byte[] checkStoreArguments(String key,
 int exp,
 T value)

set

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

Specified by:

set in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.set(String, int, Object, Transcoder, long)

set

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

Specified by:

set in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.set(String, int, Object, Transcoder, long)

set

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

Specified by:

set in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.set(String, int, Object, Transcoder, long)

add

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

Description copied from interface: MemcachedClient

Add key-value item to memcached, success only when the key is not exists in memcached.

Specified by:

add in interface MemcachedClient

Type Parameters:

T -

Parameters:

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 -

Returns:

boolean result

Throws:

TimeoutException

InterruptedException

MemcachedException

add0

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

Throws:

InterruptedException

TimeoutException

MemcachedException

add

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

Specified by:

add in interface MemcachedClient

Parameters:

key -

exp -

value -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.add(String, int, Object, Transcoder, long)

add

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

Specified by:

add in interface MemcachedClient

Parameters:

key -

exp -

value -

timeout -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.add(String, int, Object, Transcoder, long)

add

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

Specified by:

add in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.add(String, int, Object, Transcoder, long)

addWithNoReply

public void addWithNoReply(String key,
 int exp,
 Object value)
                    throws InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Add key-value item to memcached, success only when the key is not exists in memcached.This method doesn't wait for reply.

Specified by:

addWithNoReply in interface MemcachedClient

Parameters:

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 -

Throws:

InterruptedException

MemcachedException

addWithNoReply

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

Specified by:

addWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

Throws:

InterruptedException

MemcachedException

See Also:

• MemcachedClient.addWithNoReply(String, int, Object, Transcoder)

replaceWithNoReply

public void replaceWithNoReply(String key,
 int exp,
 Object value)
                        throws InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

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.

Specified by:

replaceWithNoReply in interface MemcachedClient

Parameters:

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 -

Throws:

InterruptedException

MemcachedException

replaceWithNoReply

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

Specified by:

replaceWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

Throws:

InterruptedException

MemcachedException

See Also:

• MemcachedClient.replaceWithNoReply(String, int, Object, Transcoder)

replace

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

Description copied from interface: MemcachedClient

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.

Specified by:

replace in interface MemcachedClient

Type Parameters:

T -

Parameters:

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 -

Returns:

boolean result

Throws:

TimeoutException

InterruptedException

MemcachedException

replace

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

Specified by:

replace in interface MemcachedClient

Parameters:

key -

exp -

value -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.replace(String, int, Object, Transcoder, long)

replace

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

Specified by:

replace in interface MemcachedClient

Parameters:

key -

exp -

value -

timeout -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.replace(String, int, Object, Transcoder, long)

replace

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

Specified by:

replace in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.replace(String, int, Object, Transcoder, long)

append

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

Specified by:

append in interface MemcachedClient

Parameters:

key -

value -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.append(String, Object, long)

append

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

Description copied from interface: MemcachedClient

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

Specified by:

append in interface MemcachedClient

Parameters:

key -

value -

timeout -

Returns:

boolean result

Throws:

TimeoutException

InterruptedException

MemcachedException

appendWithNoReply

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

Description copied from interface: MemcachedClient

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

Specified by:

appendWithNoReply in interface MemcachedClient

Parameters:

key -

value -

Throws:

InterruptedException

MemcachedException

prepend

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

Specified by:

prepend in interface MemcachedClient

Parameters:

key -

value -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.prepend(String, Object, long)

prepend

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

Description copied from interface: MemcachedClient

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

Specified by:

prepend in interface MemcachedClient

Parameters:

key -

value -

Returns:

boolean result

Throws:

TimeoutException

InterruptedException

MemcachedException

prependWithNoReply

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

Description copied from interface: MemcachedClient

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

Specified by:

prependWithNoReply in interface MemcachedClient

Parameters:

key -

value -

Throws:

InterruptedException

MemcachedException

cas

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

Specified by:

cas in interface MemcachedClient

Parameters:

key -

exp -

value -

cas -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, Object, Transcoder, long, long)

cas

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

Description copied from interface: MemcachedClient

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."

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

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 -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

cas

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

Specified by:

cas in interface MemcachedClient

Parameters:

key -

exp -

value -

timeout -

cas -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, Object, Transcoder, long, long)

cas

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

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

value -

transcoder -

cas -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, Object, Transcoder, long, long)

cas0

private final <T> boolean cas0(String key,
 int exp,
 GetsResponse<T> getsResponse,
 CASOperation<T> operation,
 Transcoder<T> transcoder,
 byte[] keyBytes,
 boolean noreply)
                        throws TimeoutException,
InterruptedException,
MemcachedException

Throws:

TimeoutException

InterruptedException

MemcachedException

cas

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

Description copied from interface: MemcachedClient

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."

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

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

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

cas

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

Description copied from interface: MemcachedClient

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."

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

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 -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

cas

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

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

getsReponse -

operation -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, GetsResponse, CASOperation, Transcoder)

casWithNoReply

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

Specified by:

casWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

operation -

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.casWithNoReply(String, int, GetsResponse, CASOperation)

casWithNoReply

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

Specified by:

casWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

getsResponse -

operation -

Throws:

TimeoutException

InterruptedException

MemcachedException

casWithNoReply

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

Specified by:

casWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

operation -

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.casWithNoReply(String, int, GetsResponse, CASOperation)

casWithNoReply

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

Description copied from interface: MemcachedClient

cas noreply

Specified by:

casWithNoReply in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

getsReponse -

operation -

Throws:

TimeoutException

InterruptedException

MemcachedException

cas

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

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

getsReponse -

operation -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, GetsResponse, CASOperation, Transcoder)

cas

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

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

exp -

operation -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, GetsResponse, CASOperation, Transcoder)

cas

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

Specified by:

cas in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

operation -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.cas(String, int, GetsResponse, CASOperation, Transcoder)

delete

public final boolean delete(String key,
 int time)
                     throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

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.

Specified by:

delete in interface MemcachedClient

Parameters:

key -

time -

Throws:

InterruptedException

MemcachedException

TimeoutException

delete

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

Description copied from interface: MemcachedClient

Delete key's date item from memcached

Specified by:

delete in interface MemcachedClient

Parameters:

key -

opTimeout - Operation timeout

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

delete

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

Description copied from interface: MemcachedClient

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

Specified by:

delete in interface MemcachedClient

Parameters:

key -

opTimeout - Operation timeout

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

deleteWithNoReply

public final void deleteWithNoReply(String key,
 int time)
                             throws InterruptedException,
MemcachedException

Delete key's data item from memcached.This method doesn't wait for reply

Specified by:

deleteWithNoReply in interface MemcachedClient

Parameters:

key -

time -

Throws:

InterruptedException

MemcachedException

deleteWithNoReply

public final void deleteWithNoReply(String key)
                             throws InterruptedException,
MemcachedException

Specified by:

deleteWithNoReply in interface MemcachedClient

Throws:

InterruptedException

MemcachedException

delete0

private boolean delete0(String key,
 int time,
 long cas,
 boolean noreply,
 long opTimeout)
                 throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

checkException

protected void checkException(Command command)
                       throws MemcachedException

Throws:

MemcachedException

touch

public boolean touch(String key,
 int exp,
 long opTimeout)
              throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Set a new expiration time for an existing item

Specified by:

touch in interface MemcachedClient

Parameters:

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

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

touch

public boolean touch(String key,
 int exp)
              throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Set a new expiration time for an existing item,using default opTimeout second.

Specified by:

touch in interface MemcachedClient

Parameters:

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.

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

getAndTouch

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

Description copied from interface: MemcachedClient

Get item and set a new expiration time for it

Specified by:

getAndTouch in interface MemcachedClient

Type Parameters:

T -

Parameters:

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

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

getAndTouch

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

Description copied from interface: MemcachedClient

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

Specified by:

getAndTouch in interface MemcachedClient

Type Parameters:

T -

Parameters:

key -

newExp -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

incr

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

Description copied from interface: MemcachedClient

"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.

Specified by:

incr in interface MemcachedClient

Parameters:

key -

Returns:

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

Throws:

InterruptedException

MemcachedException

TimeoutException

incr

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

Specified by:

incr in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

incr

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

Description copied from interface: MemcachedClient

"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.

Specified by:

incr in interface MemcachedClient

Parameters:

key - key

initValue - initValue if the data is not exists.

timeout - operation timeout

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

incr

public long incr(String key,
 long delta,
 long initValue,
 long timeout,
 int exp)
          throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

"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.

Specified by:

incr in interface MemcachedClient

Parameters:

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.

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

incrWithNoReply

public final void incrWithNoReply(String key,
 long delta)
                           throws InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

"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.

Specified by:

incrWithNoReply in interface MemcachedClient

Parameters:

key -

Throws:

InterruptedException

MemcachedException

decrWithNoReply

public final void decrWithNoReply(String key,
 long delta)
                           throws InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

"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.

Specified by:

decrWithNoReply in interface MemcachedClient

Parameters:

key -

Throws:

InterruptedException

MemcachedException

decr

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

Description copied from interface: MemcachedClient

"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.

Specified by:

decr in interface MemcachedClient

Parameters:

key -

Returns:

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

Throws:

InterruptedException

MemcachedException

TimeoutException

decr

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

Specified by:

decr in interface MemcachedClient

Parameters:

key -

initValue -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

See Also:

• MemcachedClient.decr(java.lang.String,long)

decr

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

Description copied from interface: MemcachedClient

"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.

Specified by:

decr in interface MemcachedClient

Parameters:

key - The key

initValue - The initial value if the data is not exists.

timeout - Operation timeout

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

decr

public long decr(String key,
 long delta,
 long initValue,
 long timeout,
 int exp)
          throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

"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.

Specified by:

decr in interface MemcachedClient

Parameters:

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.

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

flushAll

public final void flushAll()
                    throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

Make All connected memcached's data item invalid

Specified by:

flushAll in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

flushAllWithNoReply

public void flushAllWithNoReply()
                         throws InterruptedException,
MemcachedException

Specified by:

flushAllWithNoReply in interface MemcachedClient

Throws:

InterruptedException

MemcachedException

flushAllWithNoReply

public void flushAllWithNoReply(int exptime)
                         throws InterruptedException,
MemcachedException

Specified by:

flushAllWithNoReply in interface MemcachedClient

Throws:

InterruptedException

MemcachedException

flushAllWithNoReply

public void flushAllWithNoReply(InetSocketAddress address)
                         throws MemcachedException,
InterruptedException

Specified by:

flushAllWithNoReply in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

flushAllWithNoReply

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

Specified by:

flushAllWithNoReply in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

flushAll

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

Specified by:

flushAll in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

flushAll

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

Description copied from interface: MemcachedClient

Make All connected memcached's data item invalid

Specified by:

flushAll in interface MemcachedClient

Parameters:

timeout - operation timeout

Throws:

TimeoutException

InterruptedException

MemcachedException

flushAllMemcachedServers

private void flushAllMemcachedServers(long timeout,
 boolean noreply,
 int exptime)
                               throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

setLoggingLevelVerbosity

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

Description copied from interface: MemcachedClient

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

Specified by:

setLoggingLevelVerbosity in interface MemcachedClient

Parameters:

address -

level - logging level

Throws:

TimeoutException

InterruptedException

MemcachedException

setMemcachedLoggingLevel

private void setMemcachedLoggingLevel(InetSocketAddress address,
 int level,
 boolean noreply)
                               throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

setLoggingLevelVerbosityWithNoReply

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

Description copied from interface: MemcachedClient

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

Specified by:

setLoggingLevelVerbosityWithNoReply in interface MemcachedClient

Parameters:

address - memcached server address

level - logging level

Throws:

InterruptedException

MemcachedException

flushAll

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

Description copied from interface: MemcachedClient

Invalidate all existing items immediately

Specified by:

flushAll in interface MemcachedClient

Parameters:

address - Target memcached server

Throws:

MemcachedException

InterruptedException

TimeoutException

flushAll

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

Specified by:

flushAll in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

TimeoutException

flushAll

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

Specified by:

flushAll in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

TimeoutException

flushSpecialMemcachedServer

private void flushSpecialMemcachedServer(InetSocketAddress address,
 long timeout,
 boolean noreply,
 int exptime)
                                  throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

flushAll

public final void flushAll(String host)
                    throws TimeoutException,
InterruptedException,
MemcachedException

Description copied from interface: MemcachedClient

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

Specified by:

flushAll in interface MemcachedClient

Parameters:

host -

Throws:

TimeoutException

InterruptedException

MemcachedException

stats

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

Specified by:

stats in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

TimeoutException

stats

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

Description copied from interface: MemcachedClient

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

Specified by:

stats in interface MemcachedClient

Parameters:

address - ����板�

timeout - ���瓒��

Returns:

Throws:

MemcachedException

InterruptedException

TimeoutException

getStats

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

Specified by:

getStats in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

TimeoutException

getStatsByItem

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

Description copied from interface: MemcachedClient

Get special item stats. "stats items" for example

Specified by:

getStatsByItem in interface MemcachedClient

Returns:

Throws:

MemcachedException

InterruptedException

TimeoutException

getStatsByItem

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

Specified by:

getStatsByItem in interface MemcachedClient

Throws:

MemcachedException

InterruptedException

TimeoutException

getVersions

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

Description copied from interface: MemcachedClient

Get all connected memcached servers's version.

Specified by:

getVersions in interface MemcachedClient

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

getVersions

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

Specified by:

getVersions in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

getStats

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

Description copied from interface: MemcachedClient

Get stats from all memcached servers

Specified by:

getStats in interface MemcachedClient

Parameters:

timeout -

Returns:

server->item->value map

Throws:

MemcachedException

InterruptedException

TimeoutException

shutdown0

protected void shutdown0()

For subclass override.

shutdown

public final void shutdown()
                    throws IOException

Specified by:

shutdown in interface MemcachedClient

Throws:

IOException

sendIncrOrDecrCommand

private long sendIncrOrDecrCommand(String key,
 long delta,
 long initValue,
 CommandType cmdType,
 boolean noreply,
 long operationTimeout,
 int exp)
                            throws InterruptedException,
TimeoutException,
MemcachedException

Throws:

InterruptedException

TimeoutException

MemcachedException

setConnectionPoolSize

public void setConnectionPoolSize(int poolSize)

Description copied from interface: MemcachedClient

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.

Specified by:

setConnectionPoolSize in interface MemcachedClient

Parameters:

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

delete

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

Specified by:

delete in interface MemcachedClient

Throws:

TimeoutException

InterruptedException

MemcachedException

getTranscoder

public final Transcoder getTranscoder()

Description copied from interface: MemcachedClient

return default transcoder,default is SerializingTranscoder

Specified by:

getTranscoder in interface MemcachedClient

Returns:

setTranscoder

public final void setTranscoder(Transcoder transcoder)

Description copied from interface: MemcachedClient

set transcoder

Specified by:

setTranscoder in interface MemcachedClient

Parameters:

transcoder -

sendStoreCommand

private final <T> boolean sendStoreCommand(Command command,
 long timeout)
                                    throws InterruptedException,
TimeoutException,
MemcachedException

Throws:

InterruptedException

TimeoutException

MemcachedException

latchWait

protected void latchWait(Command cmd,
 long timeout,
 Session session)
                  throws InterruptedException,
TimeoutException

Throws:

InterruptedException

TimeoutException

getContinuousTimeoutCounter

private AtomicInteger getContinuousTimeoutCounter(Session session)

getAvaliableServers

@Deprecated
public final Collection<InetSocketAddress> getAvaliableServers()

Deprecated.

Use getAvailableServers() instead

Specified by:

getAvaliableServers in interface MemcachedClient

Returns:

See Also:

• MemcachedClient.getAvailableServers()

getAvailableServers

public Collection<InetSocketAddress> getAvailableServers()

Description copied from interface: MemcachedClient

Returns available memcached servers list.

Specified by:

getAvailableServers in interface MemcachedClient

Returns:

A available server collection

getConnectionSizeBySocketAddress

public final int getConnectionSizeBySocketAddress(InetSocketAddress address)

addStateListener

public void addStateListener(MemcachedClientStateListener listener)

Description copied from interface: MemcachedClient

Add a memcached client listener

Specified by:

addStateListener in interface MemcachedClient

Parameters:

listener -

getStateListeners

public Collection<MemcachedClientStateListener> getStateListeners()

Description copied from interface: MemcachedClient

Get all current state listeners

Specified by:

getStateListeners in interface MemcachedClient

Returns:

setPrimitiveAsString

public void setPrimitiveAsString(boolean primitiveAsString)

Description copied from interface: MemcachedClient

Store all primitive type as string,defualt is false.

Specified by:

setPrimitiveAsString in interface MemcachedClient

removeStateListener

public void removeStateListener(MemcachedClientStateListener listener)

Description copied from interface: MemcachedClient

Remove a memcached client listener

Specified by:

removeStateListener in interface MemcachedClient

Parameters:

listener -

getProtocol

public Protocol getProtocol()

Specified by:

getProtocol in interface MemcachedClient

isSanitizeKeys

public boolean isSanitizeKeys()

Specified by:

isSanitizeKeys in interface MemcachedClient

setSanitizeKeys

public void setSanitizeKeys(boolean sanitizeKeys)

Description copied from interface: MemcachedClient

Enables/disables sanitizing keys by URLEncoding.

Specified by:

setSanitizeKeys in interface MemcachedClient

Parameters:

sanitizeKeys - if true, then URLEncode all keys

decodeKey

private String decodeKey(String key)
                  throws MemcachedException,
InterruptedException,
TimeoutException

Throws:

MemcachedException

InterruptedException

TimeoutException

preProcessKey

private String preProcessKey(String key)
                      throws MemcachedException,
InterruptedException

Throws:

MemcachedException

InterruptedException

invalidateNamespace

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

Description copied from interface: MemcachedClient

Invalidate all items under the namespace.

Specified by:

invalidateNamespace in interface MemcachedClient

Parameters:

ns - the namespace

opTimeout - operation timeout in milliseconds.

Throws:

MemcachedException

InterruptedException

TimeoutException

invalidateNamespace

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

Description copied from interface: MemcachedClient

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

Specified by:

invalidateNamespace in interface MemcachedClient

Parameters:

ns - the namespace

Throws:

MemcachedException

InterruptedException

TimeoutException

getNamespace

public String getNamespace(String ns)
                    throws TimeoutException,
InterruptedException,
MemcachedException

Returns the real namespace of ns.

Parameters:

ns -

Returns:

Throws:

TimeoutException

InterruptedException

MemcachedException

getNSKey

private String getNSKey(String ns)

getCounter

public Counter getCounter(String key,
 long initialValue)

Description copied from interface: MemcachedClient

Get counter for key,and if the key's value is not set,then set it with initial value.

Specified by:

getCounter in interface MemcachedClient

Parameters:

key -

initialValue -

Returns:

getCounter

public Counter getCounter(String key)

Description copied from interface: MemcachedClient

Get counter for key,and if the key's value is not set,then set it with 0.

Specified by:

getCounter in interface MemcachedClient

Parameters:

key -

Returns:

getKeyIterator

@Deprecated
public KeyIterator getKeyIterator(InetSocketAddress address)
                           throws MemcachedException,
TimeoutException,
InterruptedException

Deprecated.

memcached 1.6.x will remove cachedump stats command,so this method will be removed in the future

Description copied from interface: MemcachedClient

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.

Specified by:

getKeyIterator in interface MemcachedClient

Parameters:

address -

Returns:

Throws:

MemcachedException

TimeoutException

InterruptedException

setEnableHealSession

public void setEnableHealSession(boolean enableHealSession)

Description copied from interface: MemcachedClient

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.

Specified by:

setEnableHealSession in interface MemcachedClient

Parameters:

enableHealSession -

setFailureMode

public void setFailureMode(boolean failureMode)

Description copied from interface: MemcachedClient

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.

Specified by:

setFailureMode in interface MemcachedClient

Parameters:

failureMode - true is to configure client in failure mode.

isFailureMode

public boolean isFailureMode()

Description copied from interface: MemcachedClient

Returns if client is in failure mode.

Specified by:

isFailureMode in interface MemcachedClient

Returns:

getReconnectRequestQueue

public Queue<ReconnectRequest> getReconnectRequestQueue()

Description copied from interface: MemcachedClient

Returns reconnecting task queue,the queue is thread-safe and 'weakly consistent',but maybe you should not modify it at all.

Specified by:

getReconnectRequestQueue in interface MemcachedClient

Returns:

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