BaseClient

Abstract Value Members

abstract def add(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

Store a key but only if it doesn't already exist on the server.
Store a key but only if it doesn't already exist on the server.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
returns
true if stored, false if not stored
abstract def append(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

Append bytes to the end of an existing key.
Append bytes to the end of an existing key. If the key doesn't exist, the operation has no effect.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
returns
true if stored, false if not stored
abstract def bufferToType(a: Buf): T

Deserialize from the bytes in a Buf into the client's type, T.
abstract def checkAndSet(key: String, flags: Int, expiry: Time, value: T, casUnique: Buf): Future[CasResult]

Perform a CAS operation on the key, only if the value has not changed since the value was last retrieved, and casUnique extracted from a gets command.
Perform a CAS operation on the key, only if the value has not changed since the value was last retrieved, and casUnique extracted from a gets command. We treat the "cas unique" token opaquely, but in reality it is a string-encoded u64.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
returns
Stored if the operation was successful, Exists if the operation failed because someone else had changed the value, or NotFound if the key was not found in the cache.

See also
gets and getsResult for retreiving the cas token.
abstract def close(deadline: Time): Future[Unit]

Close the underlying resources.
Close the underlying resources.

Definition Classes
BaseClient → Closable
abstract def decr(key: String, delta: Long): Future[Option[Long]]

Decrement the key by n.
Decrement the key by n.
Interprets the stored value for key as a Long if it is parseable as a decimal representation of a 64-bit unsigned integer.
This operation has no effect if there is no value there already.
abstract def delete(key: String): Future[Boolean]

Remove a key.
Remove a key.
returns
true if deleted, false if not found
abstract def getResult(keys: Iterable[String]): Future[GetResult]

Get a set of keys from the server.
Get a set of keys from the server. Returns a Future[GetResult] that encapsulates hits, misses and failures.

See also
getsResult if you need "cas unique" tokens.
abstract def getsResult(keys: Iterable[String]): Future[GetsResult]

Get a set of keys from the server.
Get a set of keys from the server. Returns a Future[GetsResult] that encapsulates hits, misses and failures. This variant includes the casToken from memcached.

See also
checkAndSet for using the token.
getResult if you do not need "cas unique" tokens.
abstract def incr(key: String, delta: Long): Future[Option[Long]]

Increment the key by delta.
Increment the key by delta.
Interprets the stored value for key as a Long if it is parseable as a decimal representation of a 64-bit unsigned integer.
This operation has no effect if there is no value there already.
abstract def prepend(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

Prepend bytes to the beginning of an existing key.
Prepend bytes to the beginning of an existing key. If the key doesn't exist, the operation has no effect.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
returns
true if stored, false if not stored
abstract def replace(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

Replace bytes on an existing key.
Replace bytes on an existing key. If the key doesn't exist, the operation has no effect.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
returns
true if stored, false if not stored
abstract def set(key: String, flags: Int, expiry: Time, value: T): Future[Unit]

Store a key.
Store a key. Override an existing value.
flags is an arbitrary integer that the server stores along with the data and sends back when the item is retrieved. Clients may use this as a bit field to store data-specific information; this field is opaque to the server.
expiry is the expiration time for entries. If it is Time.epoch,Time.Top, Time.Bottom or Time.Undefinedthen the item never expires, although it may be deleted from the cache to make room for other items. This is also the case for values where the number of seconds is larger thanLong.MaxValue. Otherwise, clients will not be able to retrieve this item after the expiration time arrives (measured on the cache server).
abstract def stats(args: Option[String]): Future[Seq[String]]

Send a stats command with optional arguments to the server.
Send a stats command with optional arguments to the server.
returns
a sequence of strings, each of which is a line of output

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def add(key: String, value: T): Future[Boolean]

Store a key but only if it doesn't already exist on the server.
Store a key but only if it doesn't already exist on the server.
Neither flags nor expiry are supplied.
returns
true if stored, false if not stored
def append(key: String, value: T): Future[Boolean]

Append a set of bytes to the end of an existing key.
Append a set of bytes to the end of an existing key. If the key doesn't exist, the operation has no effect.
returns
true if stored, false if not stored
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkAndSet(key: String, value: T, casUnique: Buf): Future[CasResult]

Perform a CAS operation on the key, only if the value has not changed since the value was last retrieved.
Perform a CAS operation on the key, only if the value has not changed since the value was last retrieved. This is enforced by passing a casUnique token extracted from a gets command. If the casUnique token matches the one on the server, the value is replaced. We treat the "cas unique" token opaquely, but in reality it is a string-encoded u64.
Neither flags nor expiry are supplied.
returns
Stored if the operation was successful, Exists if the operation failed because someone else had changed the value, or NotFound if the key was not found in the cache.

See also
gets and getsResult for retreiving the cas token.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(after: Duration): Future[Unit]

Definition Classes
Closable
final def close(): Future[Unit]

Definition Classes
Closable
def decr(key: String): Future[Option[Long]]

Decrement the key by 1.
Decrement the key by 1.
Interprets the stored value for key as a Long if it is parseable as a decimal representation of a 64-bit unsigned integer.
This operation has no effect if there is no value there already.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get(keys: Iterable[String]): Future[Map[String, T]]

Get a set of keys from the server.
Get a set of keys from the server.
returns
a Map[String, T] of all of the keys that the server had.

See also
gets if you need a "cas unique" token.
def get(key: String): Future[Option[T]]

Get a key from the server.
Get a key from the server.
returns
None if there is no value stored for key.

See also
gets if you need a "cas unique" token.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getWithFlag(keys: Iterable[String]): Future[Map[String, (T, Buf)]]

Get a set of keys from the server, together with their flags
Get a set of keys from the server, together with their flags
returns
a Map[String, (T, Buf)] of all the keys the server had, together with their flags

See also
get if you do not need the flags
def getWithFlag(key: String): Future[Option[(T, Buf)]]

Get a key from the server along with its flags
Get a key from the server along with its flags
returns
None if there is no value stored for key.

See also
get if you do not need the flags.
def gets(keys: Iterable[String]): Future[Map[String, (T, Buf)]]

Get a set of keys from the server, together with a "cas unique" token.
Get a set of keys from the server, together with a "cas unique" token. The token is treated opaquely by the memcache client but is in reality a string-encoded u64.
returns
a Map[String, (T, Buf)] of all the keys the server had, together with their "cas unique" token

See also
checkAndSet for using the token.
get if you do not need a "cas unique" token.
def gets(key: String): Future[Option[(T, Buf)]]

Get a key from the server along with a "cas unique" token.
Get a key from the server along with a "cas unique" token. The token is treated opaquely by the memcache client but is in reality a string-encoded u64.
returns
None if there is no value stored for key.

See also
checkAndSet for using the token.
get if you do not need a "cas unique" token.
def getsWithFlag(keys: Iterable[String]): Future[Map[String, (T, Buf, Buf)]]

Get a set of keys from the server, together with a "cas unique" token and flags.
Get a set of keys from the server, together with a "cas unique" token and flags. The token is treated opaquely by the memcache client but is in reality a string-encoded u64.
returns
a Map[String, (T, Buf, Buf)] of all the keys the server had, together with their "cas unique" token and flags

See also
checkAndSet for using the token.
getWithFlag if you do not need the token.
gets if you do not need the flag.
get if you do not need the token or the flags.
def getsWithFlag(key: String): Future[Option[(T, Buf, Buf)]]

Get a key from the server along with its flags and a "cas unique" token.
Get a key from the server along with its flags and a "cas unique" token.
returns
None if there is no value stored for key.

See also
getWithFlag if you do not need the token.
gets if you do not need the flags.
get if you do not need the flags or the token.
def hashCode(): Int

Definition Classes
AnyRef → Any
def incr(key: String): Future[Option[Long]]

Increment the key by 1.
Increment the key by 1.
Interprets the stored value for key as a Long if it is parseable as a decimal representation of a 64-bit unsigned integer.
This operation has no effect if there is no value there already.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def prepend(key: String, value: T): Future[Boolean]

Prepend a set of bytes to the beginning of an existing key.
Prepend a set of bytes to the beginning of an existing key. If the key doesn't exist, the operation has no effect.
Neither flags nor expiry are supplied.
returns
true if stored, false if not stored
def quit(): Future[Unit]

Send a quit command to the server.
Send a quit command to the server. Alternative to release, for protocol compatibility.
def replace(key: String, value: T): Future[Boolean]

Replace an item if it exists.
Replace an item if it exists. If it doesn't exist, the operation has no effect.
Neither flags nor expiry are supplied.
returns
true if stored, false if not stored
def set(key: String, value: T): Future[Unit]

Store a key.
Store a key. Override an existing values.
Neither flags nor expiry are supplied.
def stats(): Future[Seq[String]]

Send a stats command to the server.
Send a stats command to the server.
returns
a sequence of strings, each of which is a line of output
def stats(args: String): Future[Seq[String]]

Send a stats command with the given args to the server.
Send a stats command with the given args to the server.
returns
a sequence of strings, each of which is a line of output
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package memcached

trait BaseClient[T] extends Closable

Abstract Value Members

abstract def add(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

abstract def append(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

abstract def bufferToType(a: Buf): T

abstract def checkAndSet(key: String, flags: Int, expiry: Time, value: T, casUnique: Buf): Future[CasResult]

abstract def close(deadline: Time): Future[Unit]

abstract def decr(key: String, delta: Long): Future[Option[Long]]

abstract def delete(key: String): Future[Boolean]

abstract def getResult(keys: Iterable[String]): Future[GetResult]

abstract def getsResult(keys: Iterable[String]): Future[GetsResult]

abstract def incr(key: String, delta: Long): Future[Option[Long]]

abstract def prepend(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

abstract def replace(key: String, flags: Int, expiry: Time, value: T): Future[Boolean]

abstract def set(key: String, flags: Int, expiry: Time, value: T): Future[Unit]

abstract def stats(args: Option[String]): Future[Seq[String]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def add(key: String, value: T): Future[Boolean]

def append(key: String, value: T): Future[Boolean]

final def asInstanceOf[T0]: T0

def checkAndSet(key: String, value: T, casUnique: Buf): Future[CasResult]

def clone(): AnyRef

def close(after: Duration): Future[Unit]

final def close(): Future[Unit]

def decr(key: String): Future[Option[Long]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def get(keys: Iterable[String]): Future[Map[String, T]]

def get(key: String): Future[Option[T]]

final def getClass(): Class[_]

def getWithFlag(keys: Iterable[String]): Future[Map[String, (T, Buf)]]

def getWithFlag(key: String): Future[Option[(T, Buf)]]

def gets(keys: Iterable[String]): Future[Map[String, (T, Buf)]]

def gets(key: String): Future[Option[(T, Buf)]]

def getsWithFlag(keys: Iterable[String]): Future[Map[String, (T, Buf, Buf)]]

def getsWithFlag(key: String): Future[Option[(T, Buf, Buf)]]

def hashCode(): Int

def incr(key: String): Future[Option[Long]]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def prepend(key: String, value: T): Future[Boolean]

def quit(): Future[Unit]

def replace(key: String, value: T): Future[Boolean]

def set(key: String, value: T): Future[Unit]

def stats(): Future[Seq[String]]

def stats(args: String): Future[Seq[String]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped