com.spotify.folsom

Interface MemcacheClient<V>

All Superinterfaces:

ObservableClient

All Known Subinterfaces:

AsciiMemcacheClient<V>, BinaryMemcacheClient<V>

All Known Implementing Classes:

DefaultAsciiMemcacheClient, DefaultBinaryMemcacheClient

public interface MemcacheClient<V>
extends ObservableClient

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.
default java.util.concurrent.CompletionStage<MemcacheStatus>	add(java.lang.String key, V value, int ttl, int flags) 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<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 and flags
default java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,GetResult<V>>>	casGetAsMap(java.util.List<java.lang.String> keys) Get the value for the provided keys
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
default java.util.Map<java.lang.String,? extends MemcacheClient<V>>	getAllNodes() Returns a snapshot of the individual nodes that are part of the cluster right now.
default java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,V>>	getAsMap(java.util.List<java.lang.String> keys) Get the value for the provided keys
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<MemcacheStatus>	prepend(java.lang.String key, V value)
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.
default java.util.concurrent.CompletionStage<MemcacheStatus>	replace(java.lang.String key, V value, int ttl, int flags) 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
default java.util.concurrent.CompletionStage<MemcacheStatus>	set(java.lang.String key, V value, int ttl, int flags) 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
default java.util.concurrent.CompletionStage<MemcacheStatus>	set(java.lang.String key, V value, int ttl, long cas, int flags) Compare and set a key in memcache to the provided value, with the specified TTL
void	shutdown() Shut down the client.
java.util.concurrent.CompletionStage<MemcacheStatus>	touch(java.lang.String key, int ttl) Sets the expiration for the provided key

Methods inherited from interface com.spotify.folsom.ObservableClient

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

Method Detail

set

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

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

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

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

Parameters:

key - The key, must not be null

value - The value, must not be null

flags - Memcached flags

Returns:

A future representing completion of the request

set

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

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.

set

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

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

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

flags - Memcached flags

Returns:

A future representing completion of the request.

delete

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

Delete the provided key

Parameters:

key - Key, must not be null

Returns:

A future representing completion of the request

delete

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

Deletes a key with CAS check.

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

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

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

Parameters:

key - Key, must not be null

Returns:

A future representing completion of the request

add

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

Returns:

A future representing completion of the request

add

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

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

flags - Memcached flags

Returns:

A future representing completion of the request

replace

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

Returns:

A future representing completion of the request

replace

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

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

flags - Memcached flags

Returns:

A future representing completion of the request

append

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

prepend

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

get

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

Get the value for the provided key

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

casGet

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

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

Parameters:

key - First key, must not be null

Returns:

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

get

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

Get the value for the provided keys

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

getAsMap

default java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,V>> getAsMap(java.util.List<java.lang.String> keys)

Get the value for the provided keys

Parameters:

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

Returns:

A future representing completion of the request, with a map of keys to values. Missing values will be excluded from the map.

casGet

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

Get the value for the provided keys

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 and flags. Any non existing values will be null. Order will be maintained from the input keys

casGetAsMap

default java.util.concurrent.CompletionStage<java.util.Map<java.lang.String,GetResult<V>>> casGetAsMap(java.util.List<java.lang.String> keys)

Get the value for the provided keys

Parameters:

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

Returns:

A future representing completion of the request, with a map of keys to values, including the CAS value and flags. Missing values will be excluded from the map.

touch

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

Sets the expiration for the provided key

Parameters:

key - First key, must not be null

ttl - The TTL in seconds

Returns:

A future representing completion of the request

flushAll

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

Flushes all entries in the storage

Parameters:

delay - The flush delay in seconds.

Returns:

A future representing completion of the request

getStats

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

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"

Parameters:

key - - statistics key.

Returns:

a map of hostname:port to a statistics container

shutdown

void shutdown()

Shut down the client.

getRawMemcacheClient

RawMemcacheClient getRawMemcacheClient()

Note: This is typically only useful for testing and debugging

Returns:

the underlying raw memcache client.

getAllNodes

default java.util.Map<java.lang.String,? extends MemcacheClient<V>> getAllNodes()

Returns a snapshot of the individual nodes that are part of the cluster right now. This can be an empty map for a completely disconnected client, or a map with a single entry, or map of the currently connected nodes for a Ketama based cluster.

The keys of the map are in the format "host:port" and the values are regular memcached clients.

Note that changes to the topology will not be reflected this snapshot. The snapshot should be considered short-lived.

The clients from the snapshot should not be closed after use since they are references to the actual clients in the cluster.

Returns:

a snapshot of the currently connected nodes.