Trait/Object

com.twitter.finagle.memcached

TwemcacheClient

Related Docs: object TwemcacheClient | package memcached

Permalink

trait TwemcacheClient extends Client

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TwemcacheClient
  2. Client
  3. BaseClient
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink

    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
  2. abstract def append(key: String, flags: Int, expiry: Time, value: Buf): Future[Boolean]

    Permalink

    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
  3. abstract def checkAndSet(key: String, flags: Int, expiry: Time, value: Buf, casUnique: Buf): Future[CasResult]

    Permalink

    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
  4. abstract def decr(key: String, delta: Long): Future[Option[Long]]

    Permalink

    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
  5. abstract def delete(key: String): Future[Boolean]

    Permalink

    Remove a key.

    Remove a key.

    returns

    true if deleted, false if not found

    Definition Classes
    BaseClient
  6. abstract def getResult(keys: Iterable[String]): Future[GetResult]

    Permalink

    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
  7. abstract def getsResult(keys: Iterable[String]): Future[GetsResult]

    Permalink

    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
  8. abstract def getvResult(keys: Iterable[String]): Future[GetsResult]

    Permalink

    Get the server returned value for a set of keys for getv operation, in the format of GetsResult since the data format for gets and getv are identical

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

    Permalink

    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
  10. abstract def prepend(key: String, flags: Int, expiry: Time, value: Buf): Future[Boolean]

    Permalink

    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
  11. abstract def release(): Unit

    Permalink

    release the underlying service(s)

    release the underlying service(s)

    Definition Classes
    BaseClient
  12. abstract def replace(key: String, flags: Int, expiry: Time, value: Buf): Future[Boolean]

    Permalink

    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
  13. abstract def set(key: String, flags: Int, expiry: Time, value: Buf): Future[Unit]

    Permalink

    Store a key.

    Store a key. Override an existing value.

    returns

    true

    Definition Classes
    BaseClient
  14. abstract def stats(args: Option[String]): Future[Seq[String]]

    Permalink

    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
  15. abstract def upsert(key: String, flags: Int, expiry: Time, value: Buf, version: Buf): Future[Boolean]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def adapt[T](bijection: Bijection[Buf, T]): BaseClient[T]

    Permalink
    Definition Classes
    Client
  5. def add(key: String, value: Buf): Future[Boolean]

    Permalink

    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
  6. def append(key: String, value: Buf): Future[Boolean]

    Permalink

    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
  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def bufferToType(v: Buf): Buf

    Permalink
    Definition Classes
    ClientBaseClient
  9. def checkAndSet(key: String, value: Buf, casUnique: Buf): Future[CasResult]

    Permalink

    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
  10. def clone(): AnyRef

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

    Permalink
    Definition Classes
    BaseClient
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

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

    Permalink

    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
  16. def get(key: String): Future[Option[Buf]]

    Permalink

    Get a key from the server.

    Get a key from the server.

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

    Permalink
    Definition Classes
    AnyRef → Any
  18. def gets(keys: Iterable[String]): Future[Map[String, (Buf, Buf)]]

    Permalink

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

    Permalink

    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
  20. def getv(keys: Iterable[String]): Future[Map[String, (Buf, Buf)]]

    Permalink
  21. def getv(key: String): Future[Option[(Buf, Buf)]]

    Permalink

    Get a set of keys from the server, together with a "version" token.

    Get a set of keys from the server, together with a "version" token.

    returns

    a Map[String, (Buf, Buf)] of all the keys the server had, together with their "version" token

  22. def hashCode(): Int

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

    Permalink
    Definition Classes
    BaseClient
  24. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def prepend(key: String, value: Buf): Future[Boolean]

    Permalink

    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
  29. def quit(): Future[Unit]

    Permalink

    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
  30. def replace(key: String, value: Buf): Future[Boolean]

    Permalink

    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
  31. def set(key: String, value: Buf): Future[Unit]

    Permalink

    Store a key.

    Store a key. Override an existing values.

    returns

    true

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

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

    Permalink
    Definition Classes
    BaseClient
  34. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  35. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  36. def upsert(key: String, value: Buf, version: Buf): Future[Boolean]

    Permalink

    Perform a UPSERT operation on the key, only if the value 'version' is not newer than the provided one.

    Perform a UPSERT operation on the key, only if the value 'version' is not newer than the provided one.

    returns

    true if replaced, false if not

  37. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def withBytes: BaseClient[Array[Byte]]

    Permalink

    Adaptor to use Array[Byte] as values

    Adaptor to use Array[Byte] as values

    Definition Classes
    Client
  41. def withStrings: BaseClient[String]

    Permalink

    Adaptor to use String as values

    Adaptor to use String as values

    Definition Classes
    Client

Deprecated Value Members

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

    Permalink

    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

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

    Permalink

    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

Inherited from Client

Inherited from BaseClient[Buf]

Inherited from AnyRef

Inherited from Any

Ungrouped