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 Object
implements BinaryMemcacheClient<V>

The default implementation of BinaryMemcacheClient

Field Summary

Fields

Modifier and Type	Field and Description
private Charset	charset
private Metrics	metrics
private RawMemcacheClient	rawMemcacheClient
private TransformerUtil<V>	transformerUtil
private Transcoder<V>	valueTranscoder

Constructor Summary

Constructors

Constructor and Description
DefaultBinaryMemcacheClient(RawMemcacheClient rawMemcacheClient, Metrics metrics, Transcoder<V> valueTranscoder, Charset charset)

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	add(String key, V value, int ttl) Add a key in memcache with the provided value, with the specified TTL.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	add(String key, V value, int ttl, long cas) Add a key in memcache with the provided value, with the specified TTL.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	append(String key, V value)
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	append(String key, V value, long cas)
com.google.common.util.concurrent.ListenableFuture<List<GetResult<V>>>	casGet(List<String> keys) Get the value for the provided keys
com.google.common.util.concurrent.ListenableFuture<GetResult<V>>	casGet(String key) Get the value for the provided key, including the CAS value
com.google.common.util.concurrent.ListenableFuture<GetResult<V>>	casGetAndTouch(String key, int ttl) Get the value for the provided key, including the CAS value, and sets the expiration
private com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	casSetInternal(byte opcode, String key, V value, int ttl, long cas)
com.google.common.util.concurrent.ListenableFuture<Long>	decr(String key, long by, long initial, int ttl) Decrement a counter for the provided key
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	delete(String key) Delete the provided key
com.google.common.util.concurrent.ListenableFuture<List<V>>	get(List<String> keys) Get the value for the provided keys
com.google.common.util.concurrent.ListenableFuture<V>	get(String key) Get the value for the provided key
com.google.common.util.concurrent.ListenableFuture<List<V>>	getAndTouch(List<String> keys, int ttl) Get the values for the provided keys and sets the expiration
com.google.common.util.concurrent.ListenableFuture<V>	getAndTouch(String key, int ttl) Get the value for the provided key and sets the expiration
private com.google.common.util.concurrent.ListenableFuture<GetResult<V>>	getInternal(String key, int ttl)
com.google.common.util.concurrent.ListenableFuture<Long>	incr(String key, long by, long initial, int ttl) Increment a counter for the provided key
private com.google.common.util.concurrent.ListenableFuture<Long>	incrInternal(byte opcode, String key, long by, long initial, int ttl)
boolean	isConnected() Is the client connected to a server?
private com.google.common.util.concurrent.ListenableFuture<List<GetResult<V>>>	multiget(List<String> keys, int ttl)
com.google.common.util.concurrent.ListenableFuture<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.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	prepend(String key, V value)
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	prepend(String key, V value, long cas)
void	registerForConnectionChanges(ConnectionChangeListener listener) Register for connection change events.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	replace(String key, V value, int ttl) Replace a key in memcache with the provided value, with the specified TTL.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	replace(String key, V value, int ttl, long cas) Replace a key in memcache with the provided value, with the specified TTL.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	set(String key, V value, int ttl) Set a key in memcache to the provided value, with the specified TTL
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	set(String key, V value, int ttl, long cas) Compare and set a key in memcache to the provided value, with the specified TTL
private com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	setInternal(byte opcode, String key, V value, int ttl)
void	shutdown() Shut down the client.
String	toString()
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	touch(String key, int ttl) Sets the expiration for the provided key
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

Field Detail

rawMemcacheClient

private final RawMemcacheClient rawMemcacheClient

metrics

private final Metrics metrics

valueTranscoder

private final Transcoder<V> valueTranscoder

transformerUtil

private final TransformerUtil<V> transformerUtil

charset

private final Charset charset

Constructor Detail

DefaultBinaryMemcacheClient

public DefaultBinaryMemcacheClient(RawMemcacheClient rawMemcacheClient,
                                   Metrics metrics,
                                   Transcoder<V> valueTranscoder,
                                   Charset charset)

Method Detail

set

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> set(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> set(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> add(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> replace(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> setInternal(byte opcode,
                                                                                       String key,
                                                                                       V value,
                                                                                       int ttl)

add

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> add(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> replace(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> casSetInternal(byte opcode,
                                                                                          String key,
                                                                                          V value,
                                                                                          int ttl,
                                                                                          long cas)

get

public com.google.common.util.concurrent.ListenableFuture<V> get(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 com.google.common.util.concurrent.ListenableFuture<V> getAndTouch(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 com.google.common.util.concurrent.ListenableFuture<List<V>> get(List<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 com.google.common.util.concurrent.ListenableFuture<GetResult<V>> casGet(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 com.google.common.util.concurrent.ListenableFuture<GetResult<V>> getInternal(String key,
                                                                                     int ttl)

casGet

public com.google.common.util.concurrent.ListenableFuture<List<GetResult<V>>> casGet(List<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 com.google.common.util.concurrent.ListenableFuture<List<GetResult<V>>> multiget(List<String> keys,
                                                                                        int ttl)

getAndTouch

public com.google.common.util.concurrent.ListenableFuture<List<V>> getAndTouch(List<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 com.google.common.util.concurrent.ListenableFuture<GetResult<V>> casGetAndTouch(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> touch(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

delete

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> delete(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

incr

public com.google.common.util.concurrent.ListenableFuture<Long> incr(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 com.google.common.util.concurrent.ListenableFuture<Long> incrInternal(byte opcode,
                                                                              String key,
                                                                              long by,
                                                                              long initial,
                                                                              int ttl)

decr

public com.google.common.util.concurrent.ListenableFuture<Long> decr(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 com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> append(String key,
                                                                                 V value)

Specified by:

append in interface MemcacheClient<V>

append

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> append(String key,
                                                                                 V value,
                                                                                 long cas)

Specified by:

append in interface BinaryMemcacheClient<V>

prepend

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> prepend(String key,
                                                                                  V value)

Specified by:

prepend in interface MemcacheClient<V>

prepend

public com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> prepend(String key,
                                                                                  V value,
                                                                                  long cas)

Specified by:

prepend in interface BinaryMemcacheClient<V>

noop

public com.google.common.util.concurrent.ListenableFuture<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 ListenableFuture 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

numTotalConnections

public int numTotalConnections()

Description copied from interface: MemcacheClient

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

Specified by:

numTotalConnections in interface MemcacheClient<V>

Returns:

the number of total connections

numActiveConnections

public int numActiveConnections()

Description copied from interface: MemcacheClient

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

Specified by:

numActiveConnections in interface MemcacheClient<V>

Returns:

the number of active connections

toString

public String toString()

Overrides:

toString in class Object