com.spotify.folsom

Interface MemcacheClient<V>

All Known Subinterfaces:

AsciiMemcacheClient<V>, BinaryMemcacheClient<V>

All Known Implementing Classes:

DefaultAsciiMemcacheClient, DefaultBinaryMemcacheClient

public interface MemcacheClient<V>

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>	append(String key, V value)
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<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
boolean	isConnected() Is the client connected to a server?
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>	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>	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
void	shutdown() Shut down the client.
com.google.common.util.concurrent.ListenableFuture<MemcacheStatus>	touch(String key, int ttl) Sets the expiration for the provided key

Method Detail

set

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

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

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

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.

delete

com.google.common.util.concurrent.ListenableFuture<MemcacheStatus> delete(String key)

Delete the provided key

Parameters:

key - Key, must not be null

Returns:

A future representing completion of the request

add

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

replace

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

append

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

prepend

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

get

com.google.common.util.concurrent.ListenableFuture<V> get(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

com.google.common.util.concurrent.ListenableFuture<GetResult<V>> casGet(String key)

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

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.

get

com.google.common.util.concurrent.ListenableFuture<List<V>> get(List<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

casGet

com.google.common.util.concurrent.ListenableFuture<List<GetResult<V>>> casGet(List<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. Any non existing values will be null. Order will be maintained from the input keys

touch

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

shutdown

void shutdown()

Shut down the client.

isConnected

boolean isConnected()

Is the client connected to a server?

Returns:

true if the client is connected

numTotalConnections

int numTotalConnections()

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

Returns:

the number of total connections

numActiveConnections

int numActiveConnections()

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

Returns:

the number of active connections