memcached

Type Members

trait BaseClient[T] extends AnyRef

A friendly client to talk to a Memcached server.
case class CacheNode(host: String, port: Int, weight: Int, key: Option[String] = None) extends SocketAddress with Product with Serializable
trait CachePoolCluster extends Cluster[CacheNode]
case class CachePoolConfig(cachePoolSize: Int, detectKeyRemapping: Boolean = false) extends Product with Serializable

Cache pool config data format Currently this data format is only used by ZookeeperCachePoolManager to read the config data from zookeeper serverset parent node, and the expected cache pool size is the only attribute we need for now.
Cache pool config data format Currently this data format is only used by ZookeeperCachePoolManager to read the config data from zookeeper serverset parent node, and the expected cache pool size is the only attribute we need for now. In the future this can be extended for other config attributes like cache pool migrating state, backup cache servers list, or replication role, etc
sealed trait CasResult extends AnyRef
trait Client extends BaseClient[Buf]
class ClientAdaptor[T] extends BaseClient[T] with Proxy
class ConnectedClient extends Client

A Client connected to an individual Memcached server.
A Client connected to an individual Memcached server.

Attributes
protected
case class Entry(value: Buf, expiry: Time) extends Product with Serializable
class FailureAccrualException extends RequestException
case class GetResult extends Product with Serializable
case class GetsResult(getResult: GetResult) extends Product with Serializable
class Interpreter extends AnyRef

Evaluates a given Memcached operation and returns the result.
class InterpreterService extends Service[Command, Response]
abstract class KetamaClientKey extends AnyRef
class MockClient extends Client

Map-based mock client for testing
Map-based mock client for testing
Note: expiry and flags are ignored on update operations.
class PHPMemCacheClient extends PartitionedClient

PHP memcache-client (memcache.so) compatible client.
case class PHPMemCacheClientBuilder(_nodes: Seq[(String, Int, Int)], _hashName: Option[String], _clientBuilder: Option[ClientBuilder[_, _, _, _, Yes]]) extends Product with Serializable

Builder for memcache-client (memcache.so) compatible client.
trait PartitionedClient extends Client

A partitioned client is a client that delegates to an actual client based on the key value.
A partitioned client is a client that delegates to an actual client based on the key value. Subclasses implement clientOf to choose the Client.
class PoolingReadRepairClient extends Client

This class is designed to support replicated memcached setups.
This class is designed to support replicated memcached setups. It supports a limited subset of operations (just get, set, and delete).
trait ProxyClient extends Client
class RubyMemCacheClient extends PartitionedClient

Ruby memcache-client (MemCache) compatible client.
case class RubyMemCacheClientBuilder(_nodes: Seq[(String, Int, Int)], _clientBuilder: Option[ClientBuilder[_, _, _, _, Yes]]) extends Product with Serializable

Builder for memcache-client (MemCache) compatible client.
class StaticCachePoolCluster extends CachePoolCluster

Cache pool based on a static list
trait TwemcacheClient extends Client
trait TwemcacheConnectedClient extends TwemcacheClient

Twemcache commands implementation.
Twemcache commands implementation. This trait can only be mixed into a memcache client implementation as extension.
trait TwemcachePartitionedClient extends TwemcacheClient

Twemcache commands implemenation for a partitioned client.
Twemcache commands implemenation for a partitioned client. This trait can only be mixed into a ParitionedClient that is delegating twemcache compatible clients.
class TwitterCacheResolver extends Resolver

A com.twitter.finagle.Resolver for resolving destination names associated with Twitter cache pools.
class TwitterCacheResolverException extends Exception

Indicates that an error occurred while resolving a cache address.
Indicates that an error occurred while resolving a cache address. See com.twitter.finagle.memcached.TwitterCacheResolver for details.
class ZookeeperCachePoolCluster extends CachePoolCluster with ZookeeperStateMonitor

Zookeeper based cache pool cluster with a serverset as the underlying pool.
Zookeeper based cache pool cluster with a serverset as the underlying pool. It will monitor the underlying serverset changes and report the detected underlying pool size. It will also monitor the serverset parent node for cache pool config data, cache pool cluster update will be triggered whenever cache config data change event happens.
trait ZookeeperStateMonitor extends AnyRef

A zk monitor trait that assists with monitoring a given zk path for any node data change, in which the provided zk data handling implementation will be invoked.
A zk monitor trait that assists with monitoring a given zk path for any node data change, in which the provided zk data handling implementation will be invoked.
This monitor will maintain a queue so that every work item triggered by zk event will be processed in an order with a back off policy. It also set-up a zookeeper connection watcher by default to re-set the data change watcher even during zk re-connect.
The monitor will set-up all watcher properly kick off the loop to process future event; you can also invoke loadZKData() in your class anytime to force reading zk data and apply it.
Example use cases are: - zookeeper based CachePoolCluster uses this to monitor cache pool members change - zookeeper based MigrationClient uses this ot monitor migration state transitioning
case class KetamaClientBuilder extends Product with Serializable

Annotations
@deprecated
Deprecated
(Since version 2015-02-22) Use the com.twitter.finagle.Memcached builder
class Server extends AnyRef

An in-process memcached server.
An in-process memcached server.

Annotations
@deprecated
Deprecated
(Since version 7.0.0) Moved into test

Value Members

object CacheNodeGroup
object CachePoolCluster

Cache specific cluster implementation.
Cache specific cluster implementation. - A cache pool is a Cluster of cache nodes. - cache pool requires a underlying pool manager as the source of the cache nodes - the underlying pool manager encapsulates logic of monitoring the cache node changes and deciding when to update the cache pool cluster
object CachePoolConfig extends Serializable

Cache pool config data object
object CasResult
object Client
object GetResult extends Serializable
object KetamaClient
object KetamaClientBuilder extends Serializable
object KetamaClientKey
object PHPMemCacheClientBuilder extends Serializable
object PartitionedClient
object TwemcacheClient
object ZookeeperCachePoolCluster

ZooKeeper based cache pool cluster companion object
object ZookeeperStateMonitor
package exp
package java
package migration
package protocol
package replication

Package replication implements a base cache client that can manage multiple cache replicas.
Package replication implements a base cache client that can manage multiple cache replicas.
The base replication client will forward cache command to all replicas, as well as collect and aggregate each replica's response into a ReplicationStatus object representing the replication consistency. The BaseReplicationClient will not handle the consistency between replicas in anyway, but only to report its view of the replication state. For instance, BaseReplicationClient provides interfaces similar to generic memcache client but always returns ReplicationStatus object which can be one of these three forms:
- ConsistentReplication, indicating a consistent state across all replicas
- InconsistentReplication, indicating an inconsistent state across all replicas
- FailedReplication, indicating a failure state
By checking the returned ReplicationStatus object, one can tell the cache replication status and then handle it with application specific logic.
In addition to a base replication client, a simple replication client wrapper that's compatible with generic cache client interface is also provided. The SimpleReplicationClient only supports a subset of all memcached commands for now, and will succeed only if the command succeed on all cache replicas. In a more complicate caching scenario, this simple/naive replication client may not be applicable.
package util

package memcached

Type Members

trait BaseClient[T] extends AnyRef

case class CacheNode(host: String, port: Int, weight: Int, key: Option[String] = None) extends SocketAddress with Product with Serializable

trait CachePoolCluster extends Cluster[CacheNode]

case class CachePoolConfig(cachePoolSize: Int, detectKeyRemapping: Boolean = false) extends Product with Serializable

sealed trait CasResult extends AnyRef

trait Client extends BaseClient[Buf]

class ClientAdaptor[T] extends BaseClient[T] with Proxy

class ConnectedClient extends Client

case class Entry(value: Buf, expiry: Time) extends Product with Serializable

class FailureAccrualException extends RequestException

case class GetResult extends Product with Serializable

case class GetsResult(getResult: GetResult) extends Product with Serializable

class Interpreter extends AnyRef

class InterpreterService extends Service[Command, Response]

abstract class KetamaClientKey extends AnyRef

class MockClient extends Client

class PHPMemCacheClient extends PartitionedClient

case class PHPMemCacheClientBuilder(_nodes: Seq[(String, Int, Int)], _hashName: Option[String], _clientBuilder: Option[ClientBuilder[_, _, _, _, Yes]]) extends Product with Serializable

trait PartitionedClient extends Client

class PoolingReadRepairClient extends Client

trait ProxyClient extends Client

class RubyMemCacheClient extends PartitionedClient

case class RubyMemCacheClientBuilder(_nodes: Seq[(String, Int, Int)], _clientBuilder: Option[ClientBuilder[_, _, _, _, Yes]]) extends Product with Serializable

class StaticCachePoolCluster extends CachePoolCluster

trait TwemcacheClient extends Client

trait TwemcacheConnectedClient extends TwemcacheClient

trait TwemcachePartitionedClient extends TwemcacheClient

class TwitterCacheResolver extends Resolver

class TwitterCacheResolverException extends Exception

class ZookeeperCachePoolCluster extends CachePoolCluster with ZookeeperStateMonitor

trait ZookeeperStateMonitor extends AnyRef

case class KetamaClientBuilder extends Product with Serializable

class Server extends AnyRef

Value Members

object CacheNodeGroup

object CachePoolCluster

object CachePoolConfig extends Serializable

object CasResult

object Client

object GetResult extends Serializable

object KetamaClient

object KetamaClientBuilder extends Serializable

object KetamaClientKey

object PHPMemCacheClientBuilder extends Serializable

object PartitionedClient

object TwemcacheClient

object ZookeeperCachePoolCluster

object ZookeeperStateMonitor

package exp

package java

package migration

package protocol

package replication

package util

Ungrouped