Class/Object

com.twitter.finagle.Mux

Client

Related Docs: object Client | package Mux

Permalink

final case class Client(stack: Stack[ServiceFactory[Request, Response]] = Mux.Client.stack, params: Params = Mux.Client.params) extends PushStackClient[Request, Response, Client] with WithDefaultLoadBalancer[Client] with OpportunisticTlsParams[Client] with WithCompressionPreferences[Client] with Product with Serializable

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

Instance Constructors

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

    Permalink

Type Members

  1. type In = ByteReader

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  2. type Out = Buf

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  3. type SessionT = MuxClientNegotiatingSession

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient

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
    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 copy1(stack: Stack[ServiceFactory[Request, Response]], params: Params): Client

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient → EndpointerStackClient
  10. final def endpointer: Stackable[ServiceFactory[Request, Response]]

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

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

    Permalink
    Definition Classes
    EndpointerStackClient
  13. def finalize(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    Client
  20. def newPushTransporter(sa: SocketAddress): PushTransporter[ByteReader, Buf]

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  21. def newService(dest: Name, label: String): Service[Request, Response]

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

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

    Permalink
    Definition Classes
    Client
  24. def newSession(handle: PushChannelHandle[ByteReader, Buf]): Future[MuxClientNegotiatingSession]

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  25. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  27. val params: Params

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

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

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

    Permalink
    Definition Classes
    AnyRef
  31. def toService(session: MuxClientNegotiatingSession): Future[Service[Request, Response]]

    Permalink
    Attributes
    protected
    Definition Classes
    Client → PushStackClient
  32. def transformed(t: Transformer): StackClient[Request, Response]

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

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

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

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

    Permalink
    Definition Classes
    WithClientAdmissionControl
  37. val withCompressionPreferences: CompressionParams[Client]

    Permalink

    An entry point for configuring the client or server's compression.

    An entry point for configuring the client or server's compression.

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    CommonParams
  45. def withNoOpportunisticTls: Client

    Permalink

    Disables opportunistic TLS.

    Disables opportunistic TLS.

    If this is still TLS configured, it will speak mux over TLS. To instead configure this to be Off, use withOpportunisticTls(OpportunisticTls.Off).

    Definition Classes
    OpportunisticTlsParams
  46. def withOpportunisticTls(level: Level): Client

    Permalink

    Configures whether to speak TLS or not.

    Configures whether to speak TLS or not.

    By default, don't use opportunistic TLS, and instead try to speak mux over TLS if TLS has been configured.

    The valid levels are Off, which indicates this will never speak TLS, Desired, which indicates it may speak TLS, but may also not speak TLS, and Required, which indicates it must speak TLS.

    Peers that are configured with level Required cannot speak to peers that are configured with level Off.

    Note that opportunistic TLS is negotiated in a cleartext handshake, and is incompatible with mux over TLS.

    Definition Classes
    OpportunisticTlsParams
  47. def withParams(params: Params): Client

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

    Permalink
    Definition Classes
    CommonParams
  49. def withRequestTimeout(timeout: Duration): Client

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

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

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

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

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

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

    Permalink
    Definition Classes
    EndpointerStackClient → StackClient
  56. def withStack(stack: Stack[ServiceFactory[Request, Response]]): Client

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

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

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

    Permalink
    Definition Classes
    WithClientTransport

Deprecated Value Members

  1. def transformed(f: (Stack[ServiceFactory[Request, Response]]) ⇒ Stack[ServiceFactory[Request, Response]]): Client

    Permalink
    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 OpportunisticTlsParams[Client]

Inherited from WithSessionQualifier[Client]

Inherited from WithClientSession[Client]

Inherited from WithClientTransport[Client]

Inherited from ClientParams[Client]

Inherited from CommonParams[Client]

Inherited from StackClient[Request, Response]

Inherited from StackBasedClient[Request, Response]

Inherited from Transformable[StackClient[Request, Response]]

Inherited from Parameterized[Client]

Inherited from finagle.Client[Request, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped