com.spotify.folsom.client.binary

Class DefaultBinaryMemcacheClient<V>

java.lang.Object

com.spotify.folsom.client.binary.DefaultBinaryMemcacheClient<V>

Type Parameters:

V - The value type for all operations

All Implemented Interfaces:

BinaryMemcacheClient<V>, MemcacheClient<V>, ObservableClient

public class DefaultBinaryMemcacheClient<V>
extends java.lang.Object
implements BinaryMemcacheClient<V>

The default implementation of BinaryMemcacheClient

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private int	maxKeyLength
private Metrics	metrics
private RawMemcacheClient	rawMemcacheClient
private Tracer	tracer
private TransformerUtil<V>	transformerUtil
private Transcoder<V>	valueTranscoder

Constructor Summary

Constructors

Constructor and Description
DefaultBinaryMemcacheClient(RawMemcacheClient rawMemcacheClient, Metrics metrics, Tracer tracer, Transcoder<V> valueTranscoder, java.nio.charset.Charset charset, int maxKeyLength)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletionStage<MemcacheStatus>	add(java.lang.String key, V value, int ttl) Add a key in memcache with the provided value, with the specified TTL.
java.util.concurrent.CompletionStage<MemcacheStatus>	add(java.lang.String key, V value, int ttl, long cas) Add a key in memcache with the provided value, with the specified TTL.
java.util.concurrent.CompletionStage<MemcacheStatus>	append(java.lang.String key, V value)
java.util.concurrent.CompletionStage<MemcacheStatus>	append(java.lang.String key, V value, long cas)
java.util.concurrent.CompletionStage<java.util.List<GetResult<V>>>	casGet(java.util.List<java.lang.String> keys) Get the value for the provided keys
java.util.concurrent.CompletionStage<GetResult<V>>	casGet(java.lang.String key) Get the value for the provided key, including the CAS value
java.util.concurrent.CompletionStage<GetResult<V>>	casGetAndTouch(java.lang.String key, int ttl) Get the value for the provided key, including the CAS value, and sets the expiration
private java.util.concurrent.CompletionStage<MemcacheStatus>	casSetInternal(OpCode opcode, java.lang.String key, V value, int ttl, long cas)
java.util.concurrent.CompletionStage<java.lang.Long>	decr(java.lang.String key, long by, long initial, int ttl) Decrement a counter for the provided key
java.util.concurrent.CompletionStage<MemcacheStatus>	delete(java.lang.String key) Delete the provided key
java.util.concurrent.CompletionStage<MemcacheStatus>	delete(java.lang.String key, long cas) Deletes a key with CAS check.
java.util.concurrent.CompletionStage<MemcacheStatus>	deleteAll(java.lang.String key) Delete the provided key on all memcached instances.
java.util.concurrent.CompletionStage<MemcacheStatus>	flushAll(int delay) Flushes all entries in the storage
java.util.concurrent.CompletionStage<java.util.List<V>>	get(java.util.List<java.lang.String> keys) Get the value for the provided keys
java.util.concurrent.CompletionStage<V>	get(java.lang.String key) Get the value for the provided key
java.util.concurrent.CompletionStage<java.util.List<V>>	getAndTouch(java.util.List<java.lang.String> keys, int ttl) Get the values for the provided keys and sets the expiration
java.util.concurrent.CompletionStage<V>	getAndTouch(java.lang.String key, int ttl) Get the value for the provided key and sets the expiration
java.lang.Throwable	getConnectionFailure() Returns the unrecoverable connection failure, if any.
private java.util.concurrent.CompletionStage<GetResult<V>>	getInternal(java.lang.String key, int ttl)
RawMemcacheClient	getRawMemcacheClient() Note: This is typically only useful for testing and debugging
java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,MemcachedStats>>	getStats(java.lang.String key) Get raw statistics from the memcached instances.
java.util.concurrent.CompletionStage<java.lang.Long>	incr(java.lang.String key, long by, long initial, int ttl) Increment a counter for the provided key
private java.util.concurrent.CompletionStage<java.lang.Long>	incrInternal(OpCode opcode, java.lang.String key, long by, long initial, int ttl)
boolean	isConnected() Is the client connected to a server?
private java.util.concurrent.CompletionStage<java.util.List<GetResult<V>>>	multiget(java.util.List<byte[]> keys, int ttl)
java.util.concurrent.CompletionStage<java.lang.Void>	noop() Send a noop request
int	numActiveConnections() How many active socket connections do we have (i.e.
int	numTotalConnections() How many actual socket connections do we have, including currently disconnected clients.
java.util.concurrent.CompletionStage<MemcacheStatus>	prepend(java.lang.String key, V value)
java.util.concurrent.CompletionStage<MemcacheStatus>	prepend(java.lang.String key, V value, long cas)
void	registerForConnectionChanges(ConnectionChangeListener listener) Register for connection change events.
java.util.concurrent.CompletionStage<MemcacheStatus>	replace(java.lang.String key, V value, int ttl) Replace a key in memcache with the provided value, with the specified TTL.
java.util.concurrent.CompletionStage<MemcacheStatus>	replace(java.lang.String key, V value, int ttl, long cas) Replace a key in memcache with the provided value, with the specified TTL.
java.util.concurrent.CompletionStage<MemcacheStatus>	set(java.lang.String key, V value, int ttl) Set a key in memcache to the provided value, with the specified TTL
java.util.concurrent.CompletionStage<MemcacheStatus>	set(java.lang.String key, V value, int ttl, long cas) Compare and set a key in memcache to the provided value, with the specified TTL
private java.util.concurrent.CompletionStage<MemcacheStatus>	setInternal(OpCode opcode, java.lang.String key, V value, int ttl)
void	shutdown() Shut down the client.
java.lang.String	toString()
java.util.concurrent.CompletionStage<MemcacheStatus>	touch(java.lang.String key, int ttl) Sets the expiration for the provided key
private void	trace(OpCode opcode, java.lang.String key, byte[] value, java.util.concurrent.CompletionStage<?> future)
void	unregisterForConnectionChanges(ConnectionChangeListener listener) Unregister the provided listener so that it no longer receives connection change callbacks.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.spotify.folsom.ObservableClient

awaitConnected, awaitDisconnected, awaitFullyConnected, awaitFullyDisconnected, awaitFuture, connectFuture, disconnectFuture, fullyConnectedFuture, fullyDisconnectFuture

Field Detail

rawMemcacheClient

private final RawMemcacheClient rawMemcacheClient

metrics

private final Metrics metrics

tracer

private final Tracer tracer

valueTranscoder

private final Transcoder<V> valueTranscoder

transformerUtil

private final TransformerUtil<V> transformerUtil

maxKeyLength

private final int maxKeyLength

charset

private final java.nio.charset.Charset charset

Constructor Detail

DefaultBinaryMemcacheClient

public DefaultBinaryMemcacheClient(RawMemcacheClient rawMemcacheClient,
                                   Metrics metrics,
                                   Tracer tracer,
                                   Transcoder<V> valueTranscoder,
                                   java.nio.charset.Charset charset,
                                   int maxKeyLength)

Method Detail

set

public java.util.concurrent.CompletionStage<MemcacheStatus> set(java.lang.String key,
                                                                V value,
                                                                int ttl)

Description copied from interface: MemcacheClient

Set a key in memcache to the provided value, with the specified TTL

Specified by:

set in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request

set

public java.util.concurrent.CompletionStage<MemcacheStatus> set(java.lang.String key,
                                                                V value,
                                                                int ttl,
                                                                long cas)

Description copied from interface: MemcacheClient

Compare and set a key in memcache to the provided value, with the specified TTL

Specified by:

set in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

cas - The CAS value, must match the value on the server for the set to go through

Returns:

A future representing completion of the request.

add

public java.util.concurrent.CompletionStage<MemcacheStatus> add(java.lang.String key,
                                                                V value,
                                                                int ttl)

Description copied from interface: MemcacheClient

Add a key in memcache with the provided value, with the specified TTL. Key must not exist in memcache

Specified by:

add in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request

replace

public java.util.concurrent.CompletionStage<MemcacheStatus> replace(java.lang.String key,
                                                                    V value,
                                                                    int ttl)

Description copied from interface: MemcacheClient

Replace a key in memcache with the provided value, with the specified TTL. Key must exist in memcache

Specified by:

replace in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request

setInternal

private java.util.concurrent.CompletionStage<MemcacheStatus> setInternal(OpCode opcode,
                                                                         java.lang.String key,
                                                                         V value,
                                                                         int ttl)

add

public java.util.concurrent.CompletionStage<MemcacheStatus> add(java.lang.String key,
                                                                V value,
                                                                int ttl,
                                                                long cas)

Description copied from interface: BinaryMemcacheClient

Add a key in memcache with the provided value, with the specified TTL. Key must not exist in memcache

Specified by:

add in interface BinaryMemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

cas - The CAS value, must match the value on the server for the set to go through

Returns:

A future representing completion of the request, containing the new CAS value

replace

public java.util.concurrent.CompletionStage<MemcacheStatus> replace(java.lang.String key,
                                                                    V value,
                                                                    int ttl,
                                                                    long cas)

Description copied from interface: BinaryMemcacheClient

Replace a key in memcache with the provided value, with the specified TTL. Key must exist in memcache

Specified by:

replace in interface BinaryMemcacheClient<V>

Parameters:

key - The key, must not be null

value - The value, must not be null

ttl - The TTL in seconds

cas - The CAS value, must match the value on the server for the set to go through

Returns:

A future representing completion of the request, containing the new CAS value

casSetInternal

private java.util.concurrent.CompletionStage<MemcacheStatus> casSetInternal(OpCode opcode,
                                                                            java.lang.String key,
                                                                            V value,
                                                                            int ttl,
                                                                            long cas)

get

public java.util.concurrent.CompletionStage<V> get(java.lang.String key)

Description copied from interface: MemcacheClient

Get the value for the provided key

Specified by:

get in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

Returns:

A future representing completion of the request, with the value, or null if the key does not exist

getAndTouch

public java.util.concurrent.CompletionStage<V> getAndTouch(java.lang.String key,
                                                           int ttl)

Description copied from interface: BinaryMemcacheClient

Get the value for the provided key and sets the expiration

Specified by:

getAndTouch in interface BinaryMemcacheClient<V>

Parameters:

key - The key, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request, with the value, or null if the key does not exist

get

public java.util.concurrent.CompletionStage<java.util.List<V>> get(java.util.List<java.lang.String> keys)

Description copied from interface: MemcacheClient

Get the value for the provided keys

Specified by:

get in interface MemcacheClient<V>

Parameters:

keys - Keys, must not be null, nor must any key in the list

Returns:

A future representing completion of the request, with the values. Any non existing values will be null. Order will be maintained from the input keys

casGet

public java.util.concurrent.CompletionStage<GetResult<V>> casGet(java.lang.String key)

Description copied from interface: MemcacheClient

Get the value for the provided key, including the CAS value

Specified by:

casGet in interface MemcacheClient<V>

Parameters:

key - First key, must not be null

Returns:

A future representing completion of the request, with the value, including the CAS value, or null if the value does not exists.

getInternal

private java.util.concurrent.CompletionStage<GetResult<V>> getInternal(java.lang.String key,
                                                                       int ttl)

casGet

public java.util.concurrent.CompletionStage<java.util.List<GetResult<V>>> casGet(java.util.List<java.lang.String> keys)

Description copied from interface: MemcacheClient

Get the value for the provided keys

Specified by:

casGet in interface MemcacheClient<V>

Parameters:

keys - Keys, must not be null, nor must any key in the list

Returns:

A future representing completion of the request, with the values, including the CAS value. Any non existing values will be null. Order will be maintained from the input keys

multiget

private java.util.concurrent.CompletionStage<java.util.List<GetResult<V>>> multiget(java.util.List<byte[]> keys,
                                                                                    int ttl)

getAndTouch

public java.util.concurrent.CompletionStage<java.util.List<V>> getAndTouch(java.util.List<java.lang.String> keys,
                                                                           int ttl)

Description copied from interface: BinaryMemcacheClient

Get the values for the provided keys and sets the expiration

Specified by:

getAndTouch in interface BinaryMemcacheClient<V>

Parameters:

keys - Keys, must not be null, nor must any key in the list

ttl - The TTL in seconds

Returns:

A future representing completion of the request, with the values. Any non existing values will be null. Order will be maintained from the input keys

casGetAndTouch

public java.util.concurrent.CompletionStage<GetResult<V>> casGetAndTouch(java.lang.String key,
                                                                         int ttl)

Description copied from interface: BinaryMemcacheClient

Get the value for the provided key, including the CAS value, and sets the expiration

Specified by:

casGetAndTouch in interface BinaryMemcacheClient<V>

Parameters:

key - First key, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request, with the value, including the CAS value, or null if the value does not exists.

touch

public java.util.concurrent.CompletionStage<MemcacheStatus> touch(java.lang.String key,
                                                                  int ttl)

Description copied from interface: MemcacheClient

Sets the expiration for the provided key

Specified by:

touch in interface MemcacheClient<V>

Parameters:

key - First key, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request

flushAll

public java.util.concurrent.CompletionStage<MemcacheStatus> flushAll(int delay)

Description copied from interface: MemcacheClient

Flushes all entries in the storage

Specified by:

flushAll in interface MemcacheClient<V>

Parameters:

delay - The flush delay in seconds.

Returns:

A future representing completion of the request

delete

public java.util.concurrent.CompletionStage<MemcacheStatus> delete(java.lang.String key)

Description copied from interface: MemcacheClient

Delete the provided key

Specified by:

delete in interface MemcacheClient<V>

Parameters:

key - Key, must not be null

Returns:

A future representing completion of the request

delete

public java.util.concurrent.CompletionStage<MemcacheStatus> delete(java.lang.String key,
                                                                   long cas)

Description copied from interface: MemcacheClient

Deletes a key with CAS check.

Specified by:

delete in interface MemcacheClient<V>

Parameters:

key - The key, must not be null

cas - The CAS value, must match the value on the server for the set to go through

Returns:

A future representing completion of the request.

deleteAll

public java.util.concurrent.CompletionStage<MemcacheStatus> deleteAll(java.lang.String key)

Description copied from interface: MemcacheClient

Delete the provided key on all memcached instances. This is typically only useful for a multi-instance setup (using Ketama).

Specified by:

deleteAll in interface MemcacheClient<V>

Parameters:

key - Key, must not be null

Returns:

A future representing completion of the request

incr

public java.util.concurrent.CompletionStage<java.lang.Long> incr(java.lang.String key,
                                                                 long by,
                                                                 long initial,
                                                                 int ttl)

Description copied from interface: BinaryMemcacheClient

Increment a counter for the provided key

Specified by:

incr in interface BinaryMemcacheClient<V>

Parameters:

key - The key, must not be null

by - The value to increment the counter by

initial - The initial value if the key does not exist

ttl - The TTL, in seconds

Returns:

A future representing completion of the request, with the new value of the counter

incrInternal

private java.util.concurrent.CompletionStage<java.lang.Long> incrInternal(OpCode opcode,
                                                                          java.lang.String key,
                                                                          long by,
                                                                          long initial,
                                                                          int ttl)

decr

public java.util.concurrent.CompletionStage<java.lang.Long> decr(java.lang.String key,
                                                                 long by,
                                                                 long initial,
                                                                 int ttl)

Description copied from interface: BinaryMemcacheClient

Decrement a counter for the provided key

Specified by:

decr in interface BinaryMemcacheClient<V>

Parameters:

key - The key, must not be null

by - The value to decrement the counter by

initial - The initial value if the key does not exist

ttl - The TTL, in seconds

Returns:

A future representing completion of the request, with the new value of the counter

append

public java.util.concurrent.CompletionStage<MemcacheStatus> append(java.lang.String key,
                                                                   V value)

Specified by:

append in interface MemcacheClient<V>

append

public java.util.concurrent.CompletionStage<MemcacheStatus> append(java.lang.String key,
                                                                   V value,
                                                                   long cas)

Specified by:

append in interface BinaryMemcacheClient<V>

prepend

public java.util.concurrent.CompletionStage<MemcacheStatus> prepend(java.lang.String key,
                                                                    V value)

Specified by:

prepend in interface MemcacheClient<V>

prepend

public java.util.concurrent.CompletionStage<MemcacheStatus> prepend(java.lang.String key,
                                                                    V value,
                                                                    long cas)

Specified by:

prepend in interface BinaryMemcacheClient<V>

noop

public java.util.concurrent.CompletionStage<java.lang.Void> noop()

Description copied from interface: BinaryMemcacheClient

Send a noop request

Specified by:

noop in interface BinaryMemcacheClient<V>

Returns:

A future representing completion of the request

shutdown

public void shutdown()

Description copied from interface: MemcacheClient

Shut down the client.

Specified by:

shutdown in interface MemcacheClient<V>

registerForConnectionChanges

public void registerForConnectionChanges(ConnectionChangeListener listener)

Description copied from interface: ObservableClient

Register for connection change events. This should trigger at least once for every connection change. You should immediately get an initial callback, so that if you are creating a CompletionStage looking for a connection state that has already been reached it will return immediately.

Specified by:

registerForConnectionChanges in interface ObservableClient

Parameters:

listener - the listener to notify of connection changes

unregisterForConnectionChanges

public void unregisterForConnectionChanges(ConnectionChangeListener listener)

Description copied from interface: ObservableClient

Unregister the provided listener so that it no longer receives connection change callbacks.

Specified by:

unregisterForConnectionChanges in interface ObservableClient

Parameters:

listener - the listener to unregister.

isConnected

public boolean isConnected()

Description copied from interface: ObservableClient

Is the client connected to a server?

Specified by:

isConnected in interface ObservableClient

Returns:

true if the client is connected

getConnectionFailure

public java.lang.Throwable getConnectionFailure()

Description copied from interface: ObservableClient

Returns the unrecoverable connection failure, if any.

Specified by:

getConnectionFailure in interface ObservableClient

Returns:

null, if there's no connection failure

numTotalConnections

public int numTotalConnections()

Description copied from interface: ObservableClient

How many actual socket connections do we have, including currently disconnected clients.

Specified by:

numTotalConnections in interface ObservableClient

Returns:

the number of total connections

numActiveConnections

public int numActiveConnections()

Description copied from interface: ObservableClient

How many active socket connections do we have (i.e. not disconnected)

Specified by:

numActiveConnections in interface ObservableClient

Returns:

the number of active connections

getRawMemcacheClient

public RawMemcacheClient getRawMemcacheClient()

Description copied from interface: MemcacheClient

Note: This is typically only useful for testing and debugging

Specified by:

getRawMemcacheClient in interface MemcacheClient<V>

Returns:

the underlying raw memcache client.

getStats

public java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,MemcachedStats>> getStats(java.lang.String key)

Description copied from interface: MemcacheClient

Get raw statistics from the memcached instances. The return type is a map from hostname:port to a statistics container.

The reason for including potentially multiple statistics containers is to support the ketama use-case where there may be multiple memcached instances.

If any of the instances fail to return statistics, the exception will be propagated.

Valid keys are:

• Empty string: ""
• "slabs"
• "sizes"
• "items"
• "settings"

Specified by:

getStats in interface MemcacheClient<V>

Parameters:

key - - statistics key.

Returns:

a map of hostname:port to a statistics container

trace

private void trace(OpCode opcode,
                   java.lang.String key,
                   byte[] value,
                   java.util.concurrent.CompletionStage<?> future)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object