Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter
    Definition Classes
    com
  • package finagle
    Definition Classes
    twitter
  • object Memcached extends Client[Command, Response] with Server[Command, Response]

    Stack based Memcached client.

    Stack based Memcached client.

    For example, a default client can be built through:

    Definition Classes
    finagle
    Examples: 

    1. val client = Memcached.newRichClient(dest)

      If you want to provide more finely tuned configurations:

      2. , 

    2. val client =
  Memcached.client
    .withEjectFailedHost(true)
    .withTransport.connectTimeout(100.milliseconds))
    .withRequestTimeout(10.seconds)
    .withSession.acquisitionTimeout(20.seconds)
    .newRichClient(dest, "memcached_client")
  • Client
  • Server

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MemcachedRichClient
  7. WithPartitioningStrategy
  8. PushStackClient
  9. EndpointerStackClient
  10. WithSessionQualifier
  11. WithClientSession
  12. WithClientTransport
  13. WithClientAdmissionControl
  14. ClientParams
  15. CommonParams
  16. StackClient
  17. StackBasedClient
  18. Transformable
  19. Parameterized
  20. Client
  21. AnyRef
  22. 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)

Type Members

  1. type In = Response
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  2. type Out = Command
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  3. type SessionT = PipeliningClientPushSession[Response, Command]
    Attributes
    protected
    Definition Classes
    Client → PushStackClient

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def configured[P](psp: (P, Param[P])): Client
    Definition Classes
    Client → EndpointerStackClient → StackClient → Parameterized
  7. def configured[P](p: P)(implicit arg0: Param[P]): Client
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  8. def configuredParams(newParams: Params): Client
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  9. def connectionsPerEndpoint(connections: Int): Client

    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]], params: Params): Client
    Attributes
    protected
    Definition Classes
    Client → PushStackClient → EndpointerStackClient
  11. final def endpointer: Stackable[ServiceFactory[Command, Response]]
    Attributes
    protected
    Definition Classes
    PushStackClient → EndpointerStackClient
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def filtered(filter: Filter[Command, Response, Command, Response]): Client
    Definition Classes
    Client → EndpointerStackClient
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def injectors: Seq[ClientParamsInjector]
    Attributes
    protected
    Definition Classes
    EndpointerStackClient
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def newClient(dest: Name, label0: String): ServiceFactory[Command, Response]
    Definition Classes
    EndpointerStackClient → Client
  20. final def newClient(dest: String, label: String): ServiceFactory[Command, Response]
    Definition Classes
    Client
  21. final def newClient(dest: String): ServiceFactory[Command, Response]
    Definition Classes
    Client
  22. def newLoadBalancedTwemcacheClient(dest: Name, label: String): TwemcacheClient

    If LoadBalancedTwemcacheClient is used to create a client a key hasher won't be used and instead a load balancing algorithm will be used that doesn't account for keys.

    If LoadBalancedTwemcacheClient is used to create a client a key hasher won't be used and instead a load balancing algorithm will be used that doesn't account for keys. Some settings related to configuring client side hashing will be ignored

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

    Definition Classes
    Client → MemcachedRichClient
  23. def newLoadBalancedTwemcacheClient(dest: String): TwemcacheClient

    If LoadBalancedTwemcacheClient is used to create a client a key hasher won't be used and instead a load balancing algorithm will be used that doesn't account for keys.

    If LoadBalancedTwemcacheClient is used to create a client a key hasher won't be used and instead a load balancing algorithm will be used that doesn't account for keys. Some settings related to configuring client side hashing will be ignored

    Definition Classes
    MemcachedRichClient
  24. def newPushTransporter(sa: SocketAddress): PushTransporter[Response, Command]
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  25. def newRichClient(dest: String): memcached.Client

    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
  26. def newRichClient(dest: Name, label: String): memcached.Client

    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
  27. def newService(dest: Name, label: String): Service[Command, Response]
    Definition Classes
    EndpointerStackClient → Client
  28. final def newService(dest: String, label: String): Service[Command, Response]
    Definition Classes
    Client
  29. final def newService(dest: String): Service[Command, Response]
    Definition Classes
    Client
  30. def newSession(handle: PushChannelHandle[Response, Command]): Future[SessionT]
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  31. def newTwemcacheClient(dest: Name, label: String): TwemcacheClient

    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
    Client → MemcachedRichClient
  32. def newTwemcacheClient(dest: String): TwemcacheClient

    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
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. val params: Params
    Definition Classes
    Client → StackClient → Parameterized
  36. final def registerTransporter(transporterName: String): Unit
    Attributes
    protected
    Definition Classes
    StackClient
  37. val stack: Stack[ServiceFactory[Command, Response]]
    Definition Classes
    Client → StackClient
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toService(session: SessionT): Future[Service[Command, Response]]
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  40. def transformed(t: Transformer): StackClient[Command, Response]
    Definition Classes
    StackClient → Transformable
  41. def transformers: Seq[ClientStackTransformer]
    Attributes
    protected
    Definition Classes
    EndpointerStackClient
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  45. val withAdmissionControl: ClientAdmissionControlParams[Client]
    Definition Classes
    Client → WithClientAdmissionControl
  46. def withEjectFailedHost(eject: Boolean): Client
    Definition Classes
    Client → WithPartitioningStrategy
  47. def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): Client
    Definition Classes
    Client → CommonParams
  48. def withExecutionOffloaded(pool: FuturePool): Client
    Definition Classes
    Client → CommonParams
  49. def withExecutionOffloaded(executor: ExecutorService): Client
    Definition Classes
    Client → CommonParams
  50. def withKeyHasher(hasher: KeyHasher): Client
    Definition Classes
    Client → WithPartitioningStrategy
  51. def withLabel(label: String): Client
    Definition Classes
    Client → CommonParams
  52. def withLabels(keywords: String*): Client
    Definition Classes
    CommonParams
  53. def withMonitor(monitor: Monitor): Client
    Definition Classes
    Client → CommonParams
  54. def withNumReps(reps: Int): Client
    Definition Classes
    Client → WithPartitioningStrategy
  55. def withParams(params: Params): Client
    Definition Classes
    EndpointerStackClient → StackClient → Parameterized
  56. def withRequestTimeout(timeout: Duration): Client
    Definition Classes
    Client → CommonParams
  57. def withRequestTimeout(timeout: Tunable[Duration]): Client
    Definition Classes
    CommonParams
  58. def withResponseClassifier(responseClassifier: ResponseClassifier): Client
    Definition Classes
    Client → CommonParams
  59. def withRetryBackoff(backoff: Backoff): Client
    Definition Classes
    Client → ClientParams
  60. def withRetryBudget(budget: RetryBudget): Client
    Definition Classes
    Client → ClientParams
  61. val withSession: ClientSessionParams[Client]
    Definition Classes
    Client → WithClientSession
  62. val withSessionQualifier: SessionQualificationParams[Client]
    Definition Classes
    Client → WithSessionQualifier
  63. def withStack(fn: (Stack[ServiceFactory[Command, Response]]) ⇒ Stack[ServiceFactory[Command, Response]]): Client
    Definition Classes
    Client → EndpointerStackClient → StackClient
  64. def withStack(stack: Stack[ServiceFactory[Command, Response]]): Client
    Definition Classes
    Client → EndpointerStackClient → StackClient
  65. def withStatsReceiver(statsReceiver: StatsReceiver): Client
    Definition Classes
    Client → CommonParams
  66. def withTracer(tracer: Tracer): Client
    Definition Classes
    Client → CommonParams
  67. val withTransport: ClientTransportParams[Client]
    Definition Classes
    Client → WithClientTransport

Deprecated Value Members

  1. def transformed(f: (Stack[ServiceFactory[Command, Response]]) ⇒ Stack[ServiceFactory[Command, Response]]): Client
    Definition Classes
    EndpointerStackClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2018-10-30) Use withStack(Stack[ServiceFactory[Req, Rep]] => Stack[ServiceFactory[Req, Rep]]) instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from MemcachedRichClient

Inherited from WithPartitioningStrategy[Client]

Inherited from PushStackClient[Command, Response, Client]

Inherited from EndpointerStackClient[Command, Response, Client]

Inherited from WithSessionQualifier[Client]

Inherited from WithClientSession[Client]

Inherited from WithClientTransport[Client]

Inherited from WithClientAdmissionControl[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