Client

Abstract Value Members

abstract def add(key: String, flags: Int, expiry: Time, value: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
abstract def append(key: String, flags: Int, expiry: Time, value: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
abstract def checkAndSet(key: String, flags: Int, expiry: Time, value: Buf, 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.
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.

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

Decrement a key.
Decrement a key. Interpret the value as an JLong if it is parseable. This operation has no effect if there is no value there already.

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

Remove a key.
Remove a key.
returns
true if deleted, false if not found

Definition Classes
BaseClient
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.

Definition Classes
BaseClient
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.

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

Increment a key.
Increment a key. Interpret the value as an Long if it is parseable. This operation has no effect if there is no value there already.

Definition Classes
BaseClient
abstract def prepend(key: String, flags: Int, expiry: Time, value: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
abstract def release(): Unit

release the underlying service(s)
release the underlying service(s)

Definition Classes
BaseClient
abstract def replace(key: String, flags: Int, expiry: Time, value: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
abstract def set(key: String, flags: Int, expiry: Time, value: Buf): Future[Unit]

Store a key.
Store a key. Override an existing value.
returns
true

Definition Classes
BaseClient
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

Definition Classes
BaseClient

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 adapt[T](bijection: Bijection[Buf, T]): BaseClient[T]
def add(key: String, value: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
def append(key: String, value: Buf): 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

Definition Classes
BaseClient
final def asInstanceOf[T0]: T0

Definition Classes
Any
def bufferToType(v: Buf): Buf

Definition Classes
Client → BaseClient
def checkAndSet(key: String, value: Buf, 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.
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.

Definition Classes
BaseClient
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def decr(key: String): Future[Option[Long]]

Definition Classes
BaseClient
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, Buf]]

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.

Definition Classes
BaseClient
def get(key: String): Future[Option[Buf]]

Get a key from the server.
Get a key from the server.

Definition Classes
BaseClient
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def gets(keys: Iterable[String]): Future[Map[String, (Buf, 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

Definition Classes
BaseClient
def gets(key: String): Future[Option[(Buf, Buf)]]

Get a key from the server, with a "cas unique" token.
Get a key from the server, with a "cas unique" token. The token is treated opaquely by the memcache client but is in reality a string-encoded u64.

Definition Classes
BaseClient
def hashCode(): Int

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

Definition Classes
BaseClient
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: Buf): 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.
returns
true if stored, false if not stored

Definition Classes
BaseClient
def quit(): Future[Unit]

Send a quit command to the server.
Send a quit command to the server. Alternative to release, for protocol compatability.
returns
none

Definition Classes
BaseClient
def replace(key: String, value: Buf): Future[Boolean]

Replace an item if it exists.
Replace an item if it exists. If it doesn't exist, the operation has no effect.
returns
true if stored, false if not stored

Definition Classes
BaseClient
def set(key: String, value: Buf): Future[Unit]

Store a key.
Store a key. Override an existing values.
returns
true

Definition Classes
BaseClient
def stats(): Future[Seq[String]]

Definition Classes
BaseClient
def stats(args: String): Future[Seq[String]]

Definition Classes
BaseClient
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( ... )
def withBytes: BaseClient[Array[Byte]]

Adaptor to use Array[Byte] as values
def withStrings: BaseClient[String]

Adaptor to use String as values

Deprecated Value Members

final def cas(key: String, value: Buf, casUnique: Buf): Future[Boolean]

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.
returns
true if replaced, false if not

Definition Classes
BaseClient
Annotations
@deprecated
Deprecated
(Since version 2015-12-10) BaseClient.cas deprecated in favor of checkAndSet
Note
this is superceded by checkAndSet which returns a higher fidelity return value
final def cas(key: String, flags: Int, expiry: Time, value: Buf, casUnique: Buf): Future[Boolean]

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.
returns
true if replaced, false if not

Definition Classes
BaseClient
Annotations
@deprecated
Deprecated
(Since version 2015-12-10) BaseClient.cas deprecated in favor of checkAndSet
Note
this is superceded by checkAndSet which returns a higher fidelity return value

Related Docs: object Client | package memcached

trait Client extends BaseClient[Buf]

Abstract Value Members

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

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

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

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: Buf): Future[Boolean]

abstract def release(): Unit

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

abstract def set(key: String, flags: Int, expiry: Time, value: Buf): 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 adapt[T](bijection: Bijection[Buf, T]): BaseClient[T]

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

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

final def asInstanceOf[T0]: T0

def bufferToType(v: Buf): Buf

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

def clone(): AnyRef

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, Buf]]

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

final def getClass(): Class[_]

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

def gets(key: String): Future[Option[(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: Buf): Future[Boolean]

def quit(): Future[Unit]

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

def set(key: String, value: Buf): 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

def withBytes: BaseClient[Array[Byte]]

def withStrings: BaseClient[String]

Deprecated Value Members

final def cas(key: String, value: Buf, casUnique: Buf): Future[Boolean]

final def cas(key: String, flags: Int, expiry: Time, value: Buf, casUnique: Buf): Future[Boolean]

Inherited from BaseClient[Buf]

Inherited from AnyRef

Inherited from Any

Ungrouped