Class/Object

com.twitter.finagle.ThriftMux

Client

Related Docs: object Client | package ThriftMux

Permalink

case class Client(muxer: StackClient[Request, Response] = Client.standardMuxer) extends StackBasedClient[ThriftClientRequest, Array[Byte]] with Parameterized[Client] with Transformable[Client] with CommonParams[Client] with ClientParams[Client] with WithClientTransport[Client] with WithClientAdmissionControl[Client] with WithClientSession[Client] with WithSessionQualifier[Client] with WithDefaultLoadBalancer[Client] with ThriftRichClient with OpportunisticTlsParams[Client] with WithCompressionPreferences[Client] with Product with Serializable

A ThriftMux com.twitter.finagle.Client.

See also

Mux documentation

Thrift documentation

Configuration documentation

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

Instance Constructors

  1. new Client(muxer: StackClient[Request, Response] = Client.standardMuxer)

    Permalink

Type Members

  1. class MultiplexedThriftClient extends AnyRef

    Permalink
    Definition Classes
    ThriftRichClient

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 build[ThriftServiceType](name: Name, label: String, cls: Class[_], clientParam: RichClientParam, service: Service[ThriftClientRequest, Array[Byte]]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  6. def build[ThriftServiceType](name: Name, label: String, cls: Class[_]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  7. def build[ThriftServiceType](dest: Name, label: String)(implicit arg0: ClassTag[ThriftServiceType]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  8. def build[ThriftServiceType](dest: String, label: String)(implicit arg0: ClassTag[ThriftServiceType]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  9. def build[ThriftServiceType](dest: String)(implicit arg0: ClassTag[ThriftServiceType]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  10. def build[ThriftServiceType](dest: String, label: String, cls: Class[_]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  11. def build[ThriftServiceType](dest: String, cls: Class[_]): ThriftServiceType

    Permalink
    Definition Classes
    ThriftRichClient
  12. val clientParam: RichClientParam

    Permalink
    Attributes
    protected
    Definition Classes
    Client → ThriftRichClient
  13. def clone(): AnyRef

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

    Permalink
    Definition Classes
    Client → Parameterized
  15. def configured[P](p: P)(implicit sp: Param[P]): Client

    Permalink
    Definition Classes
    Parameterized
  16. def configuredParams(newParams: Params): Client

    Permalink
    Definition Classes
    Parameterized
  17. lazy val defaultClientName: String

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

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

    Permalink

    Prepends filter to the top of the client.

    Prepends filter to the top of the client. That is, after materializing the client (newClient/newService) filter will be the first element which requests flow through. This is a familiar chaining combinator for filters.

  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def methodBuilder(dest: Name): MethodBuilder

    Permalink

    Create a thriftmux.MethodBuilder for a given destination.

    Create a thriftmux.MethodBuilder for a given destination.

    See also

    user guide

  23. def methodBuilder(dest: String): MethodBuilder

    Permalink

    Create a thriftmux.MethodBuilder for a given destination.

    Create a thriftmux.MethodBuilder for a given destination.

    See also

    user guide

  24. def multiplex[T](dest: String, label: String)(build: (MultiplexedThriftClient) ⇒ T): T

    Permalink
    Definition Classes
    ThriftRichClient
  25. def multiplex[T](dest: Name, label: String)(build: (MultiplexedThriftClient) ⇒ T): T

    Permalink
    Definition Classes
    ThriftRichClient
  26. val muxer: StackClient[Request, Response]

    Permalink
  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  28. def newClient(dest: Name, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client → Client
  29. final def newClient(dest: String, label: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client
  30. final def newClient(dest: String): ServiceFactory[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client
  31. def newService(dest: Name, label: String): Service[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client → Client
  32. final def newService(dest: String, label: String): Service[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client
  33. final def newService(dest: String): Service[ThriftClientRequest, Array[Byte]]

    Permalink
    Definition Classes
    Client
  34. def newServicePerEndpoint[ServicePerEndpoint <: Filterable[ServicePerEndpoint]](service: Service[ThriftClientRequest, Array[Byte]], label: String)(implicit builder: ServicePerEndpointBuilder[ServicePerEndpoint]): ServicePerEndpoint

    Permalink
    Attributes
    protected
    Definition Classes
    ThriftRichClient
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  37. def params: Params

    Permalink
    Definition Classes
    Client → ThriftRichClient → Parameterized
  38. def servicePerEndpoint[ServicePerEndpoint <: Filterable[ServicePerEndpoint]](dest: Name, label: String)(implicit builder: ServicePerEndpointBuilder[ServicePerEndpoint]): ServicePerEndpoint

    Permalink
    Definition Classes
    ThriftRichClient
  39. def servicePerEndpoint[ServicePerEndpoint <: Filterable[ServicePerEndpoint]](dest: String, label: String)(implicit builder: ServicePerEndpointBuilder[ServicePerEndpoint]): ServicePerEndpoint

    Permalink
    Definition Classes
    ThriftRichClient
  40. def stack: Stack[ServiceFactory[Request, Response]]

    Permalink
  41. def stats: StatsReceiver

    Permalink
    Attributes
    protected
    Definition Classes
    ThriftRichClient
  42. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  43. def transformed(t: Transformer): Client

    Permalink
    Definition Classes
    Client → Transformable
  44. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(): Unit

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

    Permalink
    Definition Classes
    Client → WithClientAdmissionControl
  48. def withClientId(clientId: ClientId): Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client using the provided client ID.

  49. val withCompressionPreferences: CompressionParams[Client]

    Permalink
    Definition Classes
    WithCompressionPreferences
  50. def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): Client

    Permalink
    Definition Classes
    Client → CommonParams
  51. def withExecutionOffloaded(executor: ExecutorService): Client

    Permalink
    Definition Classes
    CommonParams
  52. def withExecutionOffloaded(pool: FuturePool): Client

    Permalink
    Definition Classes
    CommonParams
  53. def withLabel(label: String): Client

    Permalink
    Definition Classes
    Client → CommonParams
  54. def withLabels(keywords: String*): Client

    Permalink
    Definition Classes
    CommonParams
  55. val withLoadBalancer: DefaultLoadBalancingParams[Client]

    Permalink
    Definition Classes
    Client → WithDefaultLoadBalancer
  56. def withMaxReusableBufferSize(size: Int): Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client with the specified max size of the reusable buffer for thrift responses.

    Produce a com.twitter.finagle.ThriftMux.Client with the specified max size of the reusable buffer for thrift responses. If this size is exceeded, the buffer is not reused and a new buffer is allocated for the next thrift response. The default max size is 16Kb.

    size

    Max size of the reusable buffer for thrift responses in bytes.

    Note

    MaxReusableBufferSize will be ignored if TReusableBufferFactory is set.

  57. def withMonitor(monitor: Monitor): Client

    Permalink
    Definition Classes
    Client → CommonParams
  58. def withNoOpportunisticTls: Client

    Permalink
    Definition Classes
    Client → OpportunisticTlsParams
  59. def withOpportunisticTls(level: Level): Client

    Permalink
    Definition Classes
    Client → OpportunisticTlsParams
  60. def withParams(ps: Params): Client

    Permalink
    Definition Classes
    Client → Parameterized
  61. def withPerEndpointStats: Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client with per-endpoint stats filters

  62. def withProtocolFactory(pf: TProtocolFactory): Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client using the provided protocolFactory.

  63. def withRequestTimeout(timeout: Duration): Client

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

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

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

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

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

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

    Permalink
    Definition Classes
    Client → WithSessionQualifier
  70. def withStack(fn: (Stack[ServiceFactory[Request, Response]]) ⇒ Stack[ServiceFactory[Request, Response]]): Client

    Permalink
  71. def withStack(stack: Stack[ServiceFactory[Request, Response]]): Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client using the provided stack.

  72. def withStatsReceiver(statsReceiver: StatsReceiver): Client

    Permalink
    Definition Classes
    Client → CommonParams
  73. def withTReusableBufferFactory(tReusableBufferFactory: () ⇒ TReusableBuffer): Client

    Permalink

    Produce a com.twitter.finagle.ThriftMux.Client with a factory creates new TReusableBuffer, the TReusableBuffer can be shared with other client instance.

    Produce a com.twitter.finagle.ThriftMux.Client with a factory creates new TReusableBuffer, the TReusableBuffer can be shared with other client instance. If set, the MaxReusableBufferSize will be ignored.

  74. def withTracer(tracer: Tracer): Client

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

    Permalink
    Definition Classes
    Client → WithClientTransport

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def newIface[Iface](name: Name, label: String, cls: Class[_], protocolFactory: TProtocolFactory, service: Service[ThriftClientRequest, Array[Byte]]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-8-16) Use com.twitter.finagle.thrift.RichClientParam

  3. def newIface[Iface](name: Name, label: String, cls: Class[_], clientParam: RichClientParam, service: Service[ThriftClientRequest, Array[Byte]]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  4. def newIface[Iface](name: Name, label: String, cls: Class[_]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  5. def newIface[Iface](dest: Name, label: String)(implicit arg0: ClassTag[Iface]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  6. def newIface[Iface](dest: String, label: String)(implicit arg0: ClassTag[Iface]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  7. def newIface[Iface](dest: String)(implicit arg0: ClassTag[Iface]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  8. def newIface[Iface](dest: String, label: String, cls: Class[_]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  9. def newIface[Iface](dest: String, cls: Class[_]): Iface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-20) Use com.twitter.finagle.ThriftRichClient#build

  10. def newServiceIface[ServiceIface <: Filterable[ServiceIface]](dest: Name, label: String)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-13) Use com.twitter.finagle.ThriftRichClient#servicePerEndpoint[ServicePerEndpoint]

  11. def newServiceIface[ServiceIface <: Filterable[ServiceIface]](dest: String, label: String)(implicit builder: ServiceIfaceBuilder[ServiceIface]): ServiceIface

    Permalink
    Definition Classes
    ThriftRichClient
    Annotations
    @deprecated
    Deprecated

    (Since version 2017-11-13) Use com.twitter.finagle.ThriftRichClient#servicePerEndpoint[ServicePerEndpoint]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from OpportunisticTlsParams[Client]

Inherited from ThriftRichClient

Inherited from WithSessionQualifier[Client]

Inherited from WithClientSession[Client]

Inherited from WithClientTransport[Client]

Inherited from ClientParams[Client]

Inherited from CommonParams[Client]

Inherited from Transformable[Client]

Inherited from Parameterized[Client]

Inherited from AnyRef

Inherited from Any

Ungrouped