org.glassfish.grizzly.memcached

Interface MemcachedCache<K,V>

All Superinterfaces:

Cache<K,V>, CacheLifecycle, Commands<K,V>

All Known Implementing Classes:

GrizzlyMemcachedCache

public interface MemcachedCache<K,V>
extends Commands<K,V>, Cache<K,V>

The memcached's cache interface

This interface extends Commands and Cache and has methods related to operation timeout. Additionally, this supports several bulk operations such as getMulti(java.util.Set<K>) and setMulti(java.util.Map<K, V>, int) for dramatic performance improvement.

By addServer(java.net.SocketAddress) and removeServer(java.net.SocketAddress), servers can be added and removed dynamically in this cache. In other words, the managed server list can be changed in runtime by APIs.

Author:

Bongjae Chang

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	addServer(SocketAddress serverAddress) Add a specific server in this cache
boolean	append(K key, V value, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	cas(K key, V value, int expirationInSecs, long cas, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,Boolean>	casMulti(Map<K,ValueWithCas<V>> map, int expirationInSecs)
Map<K,Boolean>	casMulti(Map<K,ValueWithCas<V>> map, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
long	decr(K key, long delta, long initial, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	delete(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis) delete the item with the given key in memcached
Map<K,Boolean>	deleteMulti(Set<K> keys)
Map<K,Boolean>	deleteMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	flushAll(SocketAddress address, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
V	gat(K key, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
V	get(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
List<SocketAddress>	getCurrentServerList() Get current server list
ValueWithKey<K,V>	getKey(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,V>	getMulti(Set<K> keys)
Map<K,V>	getMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
ValueWithCas<V>	gets(K key, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,ValueWithCas<V>>	getsMulti(Set<K> keys)
Map<K,ValueWithCas<V>>	getsMulti(Set<K> keys, long writeTimeoutInMillis, long responseTimeoutInMillis)
long	incr(K key, long delta, long initial, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	isInServerList(SocketAddress serverAddress) Check if this cache contains the given server
boolean	noop(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	prepend(K key, V value, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	quit(SocketAddress address, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
void	removeServer(SocketAddress serverAddress) Remove the given server in this cache
boolean	replace(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslAuth(SocketAddress address, String mechanism, byte[] data, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslList(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	saslStep(SocketAddress address, String mechanism, byte[] data, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	set(K key, V value, int expirationInSecs, boolean noReply, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<K,Boolean>	setMulti(Map<K,V> map, int expirationInSecs)
Map<K,Boolean>	setMulti(Map<K,V> map, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<String,String>	stats(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)
Map<String,String>	statsItems(SocketAddress address, String item, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	touch(K key, int expirationInSecs, long writeTimeoutInMillis, long responseTimeoutInMillis)
boolean	verbosity(SocketAddress address, int verbosity, long writeTimeoutInMillis, long responseTimeoutInMillis)
String	version(SocketAddress address, long writeTimeoutInMillis, long responseTimeoutInMillis)

Methods inherited from interface org.glassfish.grizzly.memcached.Commands

add, append, cas, decr, delete, flushAll, gat, get, getKey, gets, incr, noop, prepend, quit, replace, saslAuth, saslList, saslStep, set, stats, statsItems, touch, verbosity, version

Methods inherited from interface org.glassfish.grizzly.memcached.Cache

getName

Methods inherited from interface org.glassfish.grizzly.memcached.CacheLifecycle

start, stop

Method Detail

set

boolean set(K key,
          V value,
          int expirationInSecs,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

setMulti

Map<K,Boolean> setMulti(Map<K,V> map,
                      int expirationInSecs)

setMulti

Map<K,Boolean> setMulti(Map<K,V> map,
                      int expirationInSecs,
                      long writeTimeoutInMillis,
                      long responseTimeoutInMillis)

add

boolean add(K key,
          V value,
          int expirationInSecs,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

replace

boolean replace(K key,
              V value,
              int expirationInSecs,
              boolean noReply,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

append

boolean append(K key,
             V value,
             boolean noReply,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

prepend

boolean prepend(K key,
              V value,
              boolean noReply,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

cas

boolean cas(K key,
          V value,
          int expirationInSecs,
          long cas,
          boolean noReply,
          long writeTimeoutInMillis,
          long responseTimeoutInMillis)

casMulti

Map<K,Boolean> casMulti(Map<K,ValueWithCas<V>> map,
                      int expirationInSecs)

casMulti

Map<K,Boolean> casMulti(Map<K,ValueWithCas<V>> map,
                      int expirationInSecs,
                      long writeTimeoutInMillis,
                      long responseTimeoutInMillis)

get

V get(K key,
    boolean noReply,
    long writeTimeoutInMillis,
    long responseTimeoutInMillis)

getMulti

Map<K,V> getMulti(Set<K> keys)

getMulti

Map<K,V> getMulti(Set<K> keys,
                long writeTimeoutInMillis,
                long responseTimeoutInMillis)

getKey

ValueWithKey<K,V> getKey(K key,
                       boolean noReply,
                       long writeTimeoutInMillis,
                       long responseTimeoutInMillis)

gets

ValueWithCas<V> gets(K key,
                   boolean noReply,
                   long writeTimeoutInMillis,
                   long responseTimeoutInMillis)

getsMulti

Map<K,ValueWithCas<V>> getsMulti(Set<K> keys)

getsMulti

Map<K,ValueWithCas<V>> getsMulti(Set<K> keys,
                               long writeTimeoutInMillis,
                               long responseTimeoutInMillis)

gat

V gat(K key,
    int expirationInSecs,
    boolean noReply,
    long writeTimeoutInMillis,
    long responseTimeoutInMillis)

delete

boolean delete(K key,
             boolean noReply,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

delete the item with the given key in memcached

Parameters:

key - item's key

noReply - whether you need to receive a reply or not. true means the quiet operation(no reply).

writeTimeoutInMillis - write timeout

responseTimeoutInMillis - response timeout

Returns:

true if the key and the corresponding item is deleted successfully in memcached. false if the deletion is failed(ex. timeout, io failures, ...). Note) true will be returned when the key doesn't exist in memcached(since v1.3.2)

deleteMulti

Map<K,Boolean> deleteMulti(Set<K> keys)

deleteMulti

Map<K,Boolean> deleteMulti(Set<K> keys,
                         long writeTimeoutInMillis,
                         long responseTimeoutInMillis)

incr

long incr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply,
        long writeTimeoutInMillis,
        long responseTimeoutInMillis)

decr

long decr(K key,
        long delta,
        long initial,
        int expirationInSecs,
        boolean noReply,
        long writeTimeoutInMillis,
        long responseTimeoutInMillis)

saslAuth

String saslAuth(SocketAddress address,
              String mechanism,
              byte[] data,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

saslStep

String saslStep(SocketAddress address,
              String mechanism,
              byte[] data,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

saslList

String saslList(SocketAddress address,
              long writeTimeoutInMillis,
              long responseTimeoutInMillis)

stats

Map<String,String> stats(SocketAddress address,
                       long writeTimeoutInMillis,
                       long responseTimeoutInMillis)

statsItems

Map<String,String> statsItems(SocketAddress address,
                            String item,
                            long writeTimeoutInMillis,
                            long responseTimeoutInMillis)

quit

boolean quit(SocketAddress address,
           boolean noReply,
           long writeTimeoutInMillis,
           long responseTimeoutInMillis)

flushAll

boolean flushAll(SocketAddress address,
               int expirationInSecs,
               boolean noReply,
               long writeTimeoutInMillis,
               long responseTimeoutInMillis)

touch

boolean touch(K key,
            int expirationInSecs,
            long writeTimeoutInMillis,
            long responseTimeoutInMillis)

noop

boolean noop(SocketAddress address,
           long writeTimeoutInMillis,
           long responseTimeoutInMillis)

verbosity

boolean verbosity(SocketAddress address,
                int verbosity,
                long writeTimeoutInMillis,
                long responseTimeoutInMillis)

version

String version(SocketAddress address,
             long writeTimeoutInMillis,
             long responseTimeoutInMillis)

addServer

boolean addServer(SocketAddress serverAddress)

Add a specific server in this cache

Parameters:

serverAddress - a specific server's SocketAddress to be added

Returns:

true if the given serverAddress is added successfully

removeServer

void removeServer(SocketAddress serverAddress)

Remove the given server in this cache

Parameters:

serverAddress - the specific server's SocketAddress to be removed in this cache

isInServerList

boolean isInServerList(SocketAddress serverAddress)

Check if this cache contains the given server

Parameters:

serverAddress - the specific server's SocketAddress to be checked

Returns:

true if this cache already contains the given serverAddress

getCurrentServerList

List<SocketAddress> getCurrentServerList()

Get current server list

Returns:

current server list or empty list if there are no alive servers