com.spotify.folsom

Interface BinaryMemcacheClient<V>

Type Parameters:

V - The value type for all operations

All Superinterfaces:

MemcacheClient<V>, ObservableClient

All Known Implementing Classes:

DefaultBinaryMemcacheClient

public interface BinaryMemcacheClient<V>
extends MemcacheClient<V>

A memcache client using the binary protocol

Method Summary

Modifier and Type	Method and Description
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, long cas)
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
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<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.util.concurrent.CompletionStage<java.lang.Long>	incr(java.lang.String key, long by, long initial, int ttl) Increment a counter for the provided key
java.util.concurrent.CompletionStage<java.lang.Void>	noop() Send a noop request
java.util.concurrent.CompletionStage<MemcacheStatus>	prepend(java.lang.String key, V value, long cas)
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.

Methods inherited from interface com.spotify.folsom.MemcacheClient

add, append, casGet, casGet, delete, delete, deleteAll, flushAll, get, get, getRawMemcacheClient, getStats, prepend, replace, set, set, shutdown, touch

Methods inherited from interface com.spotify.folsom.ObservableClient

awaitConnected, awaitDisconnected, awaitFullyConnected, awaitFullyDisconnected, awaitFuture, connectFuture, disconnectFuture, fullyConnectedFuture, fullyDisconnectFuture, getConnectionFailure, isConnected, numActiveConnections, numTotalConnections, registerForConnectionChanges, unregisterForConnectionChanges

Method Detail

add

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. Key must not exist in memcache

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

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. Key must exist in memcache

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

getAndTouch

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

Get the value for the provided key and sets the expiration

Parameters:

ttl - The TTL in seconds

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

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

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

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

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.

incr

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

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

decr

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

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

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

prepend

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

noop

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

Send a noop request

Returns:

A future representing completion of the request