Class/Object

com.twitter.finagle.Memcached

Client

Related Docs: object Client | package Memcached

Permalink

case class Client(stack: Stack[ServiceFactory[Command, Response]] = Client.stack, params: Params = Client.params) extends EndpointerStackClient[Command, Response, Client] with MemcachedRichClient with Product with Serializable

A memcached client with support for pipelined requests, consistent hashing, and per-node load-balancing.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MemcachedRichClient
  7. EndpointerStackClient
  8. WithSessionQualifier
  9. WithClientSession
  10. WithClientTransport
  11. WithClientAdmissionControl
  12. ClientParams
  13. CommonParams
  14. StackClient
  15. StackBasedClient
  16. Transformable
  17. Parameterized
  18. Client
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Client(stack: Stack[ServiceFactory[Command, Response]] = Client.stack, params: Params = Client.params)

    Permalink

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

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def configured[P](psp: (P, Param[P])): Client

    Permalink
    Definition Classes
    Client → EndpointerStackClient → StackClient → Parameterized
  7. def configured[P](p: P)(implicit arg0: Param[P]): Client

    Permalink
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  8. def configuredParams(newParams: Params): Client

    Permalink
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  9. def connectionsPerEndpoint(connections: Int): Client

    Permalink

    Configures the number of concurrent connections a single endpoint has.

    Configures the number of concurrent connections a single endpoint has. The connections are load balanced over which allows the pipelined client to avoid head-of-line blocking and reduce its latency.

    We've empirically found that two is a good default for this, but it can be increased at the cost of additional connection overhead.

  10. def copy1(stack: Stack[ServiceFactory[Command, Response]] = this.stack, params: Params = this.params): Client

    Permalink
    Attributes
    protected
    Definition Classes
    Client → EndpointerStackClient
  11. def endpointer: Stackable[ServiceFactory[Command, Response]]

    Permalink
    Attributes
    protected
    Definition Classes
    Client → EndpointerStackClient
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def filtered(filter: Filter[Command, Response, Command, Response]): Client

    Permalink
    Definition Classes
    Client → EndpointerStackClient
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  18. def newClient(dest: Name, label0: String): ServiceFactory[Command, Response]

    Permalink
    Definition Classes
    EndpointerStackClient → Client
  19. final def newClient(dest: String, label: String): ServiceFactory[Command, Response]

    Permalink
    Definition Classes
    Client
  20. final def newClient(dest: String): ServiceFactory[Command, Response]

    Permalink
    Definition Classes
    Client
  21. def newRichClient(dest: String): memcached.Client

    Permalink

    Constructs a memcached.Client that dispatches requests over dest.

    Constructs a memcached.Client that dispatches requests over dest. When dest resolves to multiple hosts, the hosts are hashed across a ring with key affinity. The key hashing algorithm can be configured via the withKeyHasher method on Memcached.client. Failing hosts can be ejected from the hash ring if withEjectFailedHost is set to true. Note, the current implementation only supports bound Names.

    Definition Classes
    MemcachedRichClient
  22. def newRichClient(dest: Name, label: String): memcached.Client

    Permalink

    Constructs a memcached.Client that dispatches requests over dest.

    Constructs a memcached.Client that dispatches requests over dest. When dest resolves to multiple hosts, the hosts are hashed across a ring with key affinity. The key hashing algorithm can be configured via the withKeyHasher method on Memcached.client. Failing hosts can be ejected from the hash ring if withEjectFailedHost is set to true. Note, the current implementation only supports bound Names.

    Argument label is used to assign a label to this client. The label is used to scope stats, etc.

    Definition Classes
    MemcachedRichClient
  23. def newService(dest: Name, label: String): Service[Command, Response]

    Permalink
    Definition Classes
    EndpointerStackClient → Client
  24. final def newService(dest: String, label: String): Service[Command, Response]

    Permalink
    Definition Classes
    Client
  25. final def newService(dest: String): Service[Command, Response]

    Permalink
    Definition Classes
    Client
  26. def newTwemcacheClient(dest: Name, label: String): TwemcacheClient

    Permalink

    Constructs a memcached.Client that dispatches requests over dest.

    Constructs a memcached.Client that dispatches requests over dest. When dest resolves to multiple hosts, the hosts are hashed across a ring with key affinity. The key hashing algorithm can be configured via the withKeyHasher method on Memcached.client. Failing hosts can be ejected from the hash ring if withEjectFailedHost is set to true. Note, the current implementation only supports bound Names.

    Argument label is used to assign a label to this client. The label is used to scope stats, etc.

    Definition Classes
    ClientMemcachedRichClient
  27. def newTwemcacheClient(dest: String): TwemcacheClient

    Permalink

    Constructs a memcached.Client that dispatches requests over dest.

    Constructs a memcached.Client that dispatches requests over dest. When dest resolves to multiple hosts, the hosts are hashed across a ring with key affinity. The key hashing algorithm can be configured via the withKeyHasher method on Memcached.client. Failing hosts can be ejected from the hash ring if withEjectFailedHost is set to true. Note, the current implementation only supports bound Names.

    Definition Classes
    MemcachedRichClient
  28. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  30. val params: Params

    Permalink
    Definition Classes
    Client → StackClient → Parameterized
  31. final def registerTransporter(transporterName: String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    StackClient
  32. val stack: Stack[ServiceFactory[Command, Response]]

    Permalink
    Definition Classes
    Client → StackClient
  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  34. def transformed(f: (Stack[ServiceFactory[Command, Response]]) ⇒ Stack[ServiceFactory[Command, Response]]): Client

    Permalink
    Definition Classes
    EndpointerStackClient
  35. def transformed(t: Transformer): StackClient[Command, Response]

    Permalink
    Definition Classes
    StackClient → Transformable
  36. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. val withAdmissionControl: ClientAdmissionControlParams[Client]

    Permalink
    Definition Classes
    Client → WithClientAdmissionControl
  40. def withEjectFailedHost(eject: Boolean): Client

    Permalink

    Whether to eject cache host from the Ketama ring based on failure accrual.

    Whether to eject cache host from the Ketama ring based on failure accrual. By default, this is off. When turning on, keep the following caveat in mind: ejection is based on local failure accrual, so your cluster may get different views of the same cache host. With cache updates, this can introduce inconsistency in cache data. In many cases, it's better to eject cache host from a separate mechanism that's based on a global view.

  41. def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): Client

    Permalink
    Definition Classes
    Client → CommonParams
  42. def withKeyHasher(hasher: KeyHasher): Client

    Permalink

    Defines the hash function to use for partitioned clients when mapping keys to partitions.

  43. def withLabel(label: String): Client

    Permalink
    Definition Classes
    Client → CommonParams
  44. def withMonitor(monitor: Monitor): Client

    Permalink
    Definition Classes
    Client → CommonParams
  45. def withNumReps(reps: Int): Client

    Permalink

    Duplicate each node across the hash ring according to reps.

    Duplicate each node across the hash ring according to reps.

    See also

    com.twitter.hashing.KetamaDistributor for more details.

  46. def withParams(params: Params): Client

    Permalink
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  47. def withRequestTimeout(timeout: Duration): Client

    Permalink
    Definition Classes
    Client → CommonParams
  48. def withRequestTimeout(timeout: Tunable[Duration]): Client

    Permalink
    Definition Classes
    CommonParams
  49. def withResponseClassifier(responseClassifier: ResponseClassifier): Client

    Permalink
    Definition Classes
    Client → CommonParams
  50. def withRetryBackoff(backoff: Stream[Duration]): Client

    Permalink
    Definition Classes
    Client → ClientParams
  51. def withRetryBudget(budget: RetryBudget): Client

    Permalink
    Definition Classes
    Client → ClientParams
  52. val withSession: ClientSessionParams[Client]

    Permalink
    Definition Classes
    Client → WithClientSession
  53. val withSessionQualifier: SessionQualificationParams[Client]

    Permalink
    Definition Classes
    Client → WithSessionQualifier
  54. def withStack(stack: Stack[ServiceFactory[Command, Response]]): Client

    Permalink
    Definition Classes
    Client → EndpointerStackClient → StackClient
  55. def withStatsReceiver(statsReceiver: StatsReceiver): Client

    Permalink
    Definition Classes
    Client → CommonParams
  56. def withTracer(tracer: Tracer): Client

    Permalink
    Definition Classes
    Client → CommonParams
  57. val withTransport: ClientTransportParams[Client]

    Permalink
    Definition Classes
    Client → WithClientTransport

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MemcachedRichClient

Inherited from WithSessionQualifier[Client]

Inherited from WithClientSession[Client]

Inherited from WithClientTransport[Client]

Inherited from ClientParams[Client]

Inherited from CommonParams[Client]

Inherited from StackClient[Command, Response]

Inherited from StackBasedClient[Command, Response]

Inherited from Transformable[StackClient[Command, Response]]

Inherited from Parameterized[Client]

Inherited from finagle.Client[Command, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped