Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package twitter

    Start with com.twitter.finagle.

    Definition Classes
    com
  • package finagle

    Finagle is an extensible RPC system.

    Finagle is an extensible RPC system.

    Services are represented by class com.twitter.finagle.Service. Clients make use of com.twitter.finagle.Service objects while servers implement them.

    Finagle contains a number of protocol implementations; each of these implement Client and/or com.twitter.finagle.Server. For example, Finagle's HTTP implementation, com.twitter.finagle.Http (in package finagle-http), exposes both.

    Thus a simple HTTP server is built like this:

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Await, Future}
    
    val service = new Service[Request, Response] {
      def apply(req: Request): Future[Response] =
        Future.value(Response())
    }
    val server = Http.server.serve(":8080", service)
    Await.ready(server)

    We first define a service to which requests are dispatched. In this case, the service returns immediately with a HTTP 200 OK response, and with no content.

    This service is then served via the Http protocol on TCP port 8080. Finally we wait for the server to stop serving.

    We can now query our web server:

    % curl -D - localhost:8080
    HTTP/1.1 200 OK

    Building an HTTP client is also simple. (Note that type annotations are added for illustration.)

    import com.twitter.finagle.{Http, Service}
    import com.twitter.finagle.http.{Request, Response}
    import com.twitter.util.{Future, Return, Throw}
    
    val client: Service[Request, Response] = Http.client.newService("localhost:8080")
    val f: Future[Response] = client(Request()).respond {
      case Return(rep) =>
        printf("Got HTTP response %s\n", rep)
      case Throw(exc) =>
        printf("Got error %s\n", exc)
    }

    Http.client.newService("localhost:8080") constructs a new com.twitter.finagle.Service instance connected to localhost TCP port 8080. We then issue a HTTP/1.1 GET request to URI "/". The service returns a com.twitter.util.Future representing the result of the operation. We listen to this future, printing an appropriate message when the response arrives.

    The Finagle homepage contains useful documentation and resources for using Finagle.

    Definition Classes
    twitter
  • object Http extends Client[Request, Response] with HttpRichClient with Server[Request, Response]

    HTTP/1.1 protocol support, including client and server.

    HTTP/1.1 protocol support, including client and server.

    Definition Classes
    finagle
  • Client
  • HttpImpl
  • Server

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

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Client
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. WithDefaultLoadBalancer
  7. WithSessionPool
  8. EndpointerStackClient
  9. WithSessionQualifier
  10. WithClientSession
  11. WithClientTransport
  12. WithClientAdmissionControl
  13. ClientParams
  14. CommonParams
  15. StackClient
  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(stack: Stack[ServiceFactory[Request, Response]] = Client.stack, params: Params = Client.params)

Type Members

  1. type Context = TransportContext
    Attributes
    protected
  2. type In = Any
    Attributes
    protected
  3. type Out = Any
    Attributes
    protected

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. def configured[P](psp: (P, Param[P])): Client

    Creates a new StackClient with parameter psp._1 and Stack Param type psp._2.

    Creates a new StackClient with parameter psp._1 and Stack Param type psp._2.

    Definition Classes
    ClientEndpointerStackClientStackClientParameterized
  7. def configured[P](p: P)(implicit arg0: Param[P]): Client

    Creates a new StackClient with parameter p.

    Creates a new StackClient with parameter p.

    Definition Classes
    EndpointerStackClientStackClientParameterized
  8. def configuredParams(newParams: Params): Client

    Creates a new StackClient with additional parameters newParams.

    Creates a new StackClient with additional parameters newParams.

    Definition Classes
    ClientEndpointerStackClientStackClientParameterized
  9. def copy1(stack: Stack[ServiceFactory[Request, Response]] = this.stack, params: Params = this.params): Client

    A copy constructor in lieu of defining StackClient as a case class.

    A copy constructor in lieu of defining StackClient as a case class.

    Attributes
    protected
    Definition Classes
    ClientEndpointerStackClient
  10. def endpointer: Stackable[ServiceFactory[Request, Response]]

    Defines the service factory, which establishes connections to a remote peer on apply and returns a service which can write messages onto the wire and read them off of the wire.

    Defines the service factory, which establishes connections to a remote peer on apply and returns a service which can write messages onto the wire and read them off of the wire.

    Concrete StackClient implementations are expected to specify this.

    Attributes
    protected
    Definition Classes
    ClientEndpointerStackClient
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def filtered(filter: Filter[Request, Response, Request, Response]): Client

    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 and is particularly useful for StdStackClient implementations that don't expose services but instead wrap the resulting service with a rich API.

    Definition Classes
    ClientEndpointerStackClient
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def methodBuilder(dest: Name): MethodBuilder

    Create a http.MethodBuilder for a given destination.

    Create a http.MethodBuilder for a given destination.

    See also

    user guide

  17. def methodBuilder(dest: String): MethodBuilder

    Create a http.MethodBuilder for a given destination.

    Create a http.MethodBuilder for a given destination.

    See also

    user guide

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. def newClient(dest: Name, label0: String): ServiceFactory[Request, Response]

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

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

    label0

    if an empty String is provided, then the label from the Label Stack.Params is used. If that is also an empty String, then dest is used.

    Definition Classes
    ClientEndpointerStackClientClient
  20. final def newClient(dest: String, label: String): ServiceFactory[Request, Response]

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

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

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

    Create a new client connected to dest.

    Create a new client connected to dest. See the user guide for details on destination names.

    Definition Classes
    Client
  22. def newService(dest: Name, label: String): Service[Request, Response]

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

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

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

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

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

    Create a new service which dispatches requests to dest.

    Create a new service which dispatches requests to dest. See the user guide for details on destination names.

    Definition Classes
    Client
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. val params: Params
    Definition Classes
    ClientStackClientParameterized
  28. final def registerTransporter(transporterName: String): Unit

    Export info about the transporter type so that we can query info about its implementation at runtime.

    Export info about the transporter type so that we can query info about its implementation at runtime.

    Attributes
    protected
    Definition Classes
    StackClient
  29. val stack: Stack[ServiceFactory[Request, Response]]
    Definition Classes
    ClientStackClient
  30. def superNewClient(dest: Name, label0: String): ServiceFactory[Request, Response]
    Attributes
    protected
  31. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  32. def transformed(f: (Stack[ServiceFactory[Request, Response]]) ⇒ Stack[ServiceFactory[Request, Response]]): Client

    Creates a new StackClient with f applied to stack.

    Creates a new StackClient with f applied to stack.

    For expert users only.

    Definition Classes
    EndpointerStackClient
  33. def transformed(t: Transformer): StackClient[Request, Response]

    Transform the stack using the given Transformer.

    Transform the stack using the given Transformer.

    Definition Classes
    StackClientTransformable
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  37. val withAdmissionControl: ClientAdmissionControlParams[Client]
    Definition Classes
    ClientWithClientAdmissionControl
  38. def withCompressionLevel(level: Int): Client

    The compression level to use.

    The compression level to use. If passed the default value (-1) then it will use TextualContentCompressor which will compress text-like content-types with the default compression level (6). Otherwise, use Netty HttpContentCompressor for all content-types with specified compression level.

  39. def withDecompression(enabled: Boolean): Client

    Enables decompression of http content bodies.

  40. def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): Client

    Configures this server or client with given exception stats handler.

    Configures this server or client with given exception stats handler.

    Definition Classes
    ClientCommonParams
  41. def withHttpStats: Client

    Enable the collection of HTTP specific metrics.

    Enable the collection of HTTP specific metrics. See http.filter.StatsFilter.

  42. def withLabel(label: String): Client

    Configures this server or client with given label (default: empty string).

    Configures this server or client with given label (default: empty string).

    The label value is used for stats reporting to scope stats reported from different clients/servers to a single stats receiver.

    Definition Classes
    ClientCommonParams
  43. val withLoadBalancer: DefaultLoadBalancingParams[Client]
    Definition Classes
    ClientWithDefaultLoadBalancer
  44. def withMaxHeaderSize(size: StorageUnit): Client

    For HTTP1*, configures the max size of headers For HTTP2, sets the MAX_HEADER_LIST_SIZE setting which is the maximum number of uncompressed bytes of header name/values.

    For HTTP1*, configures the max size of headers For HTTP2, sets the MAX_HEADER_LIST_SIZE setting which is the maximum number of uncompressed bytes of header name/values. These may be set independently via the .configured API.

  45. def withMaxInitialLineSize(size: StorageUnit): Client

    Configures the maximum initial line length the client can receive from a server.

  46. def withMaxRequestSize(size: StorageUnit): Client

    Configures the maximum request size that the client can send.

  47. def withMaxResponseSize(size: StorageUnit): Client

    Configures the maximum response size that client can receive.

  48. def withMonitor(monitor: Monitor): Client

    Configures this server or client with given util.Monitor (default: com.twitter.finagle.util.DefaultMonitor).

    Configures this server or client with given util.Monitor (default: com.twitter.finagle.util.DefaultMonitor).

    Definition Classes
    ClientCommonParams
  49. def withParams(params: Params): Client

    Creates a new StackClient with params used to configure this StackClient's stack.

    Creates a new StackClient with params used to configure this StackClient's stack.

    Definition Classes
    EndpointerStackClientStackClientParameterized
  50. def withRequestTimeout(timeout: Duration): Client

    Configures the request timeout of this server or client (default: unbounded).

    Configures the request timeout of this server or client (default: unbounded).

    If the request has not completed within the given timeout, the pending work will be interrupted via com.twitter.util.Future.raise.

    Client's Request Timeout

    The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.

    Server's Request Timeout

    The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.

    Definition Classes
    ClientCommonParams
    See also

    https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration

  51. def withRequestTimeout(timeout: Tunable[Duration]): Client

    Configures the Tunable request timeout of this server or client (if applying the Tunable produces a value of None, an unbounded timeout is used for the request).

    Configures the Tunable request timeout of this server or client (if applying the Tunable produces a value of None, an unbounded timeout is used for the request).

    If the request has not completed within the Duration resulting from timeout.apply(), the pending work will be interrupted via com.twitter.util.Future.raise.

    Client's Request Timeout

    The client request timeout is the maximum amount of time given to a single request (if there are retries, they each get a fresh request timeout). The timeout is applied only after a connection has been acquired. That is: it is applied to the interval between the dispatch of the request and the receipt of the response.

    Server's Request Timeout

    The server request timeout is the maximum amount of time, a server is allowed to spend handling the incoming request. Using the Finagle terminology, this is an amount of time after which a non-satisfied future returned from the user-defined service times out.

    Definition Classes
    CommonParams
    See also

    https://twitter.github.io/finagle/guide/Clients.html#timeouts-expiration and https://twitter.github.io/finagle/guide/Configuration.html#tunables

  52. def withResponseClassifier(responseClassifier: ResponseClassifier): Client

    Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.

    Configure a com.twitter.finagle.service.ResponseClassifier which is used to determine the result of a request/response.

    This allows developers to give Finagle the additional application-specific knowledge necessary in order to properly classify responses. Without this, Finagle cannot make judgements about application-level failures as it only has a narrow understanding of failures (for example: transport level, timeouts, and nacks).

    As an example take an HTTP server that returns a response with a 500 status code. To Finagle this is a successful request/response. However, the application developer may want to treat all 500 status codes as failures and can do so via setting a com.twitter.finagle.service.ResponseClassifier.

    ResponseClassifier is a PartialFunction and as such multiple classifiers can be composed together via PartialFunction.orElse.

    Response classification is independently configured on the client and server. For client-side response classification using com.twitter.finagle.builder.ClientBuilder, see com.twitter.finagle.builder.ClientBuilder.responseClassifier

    Definition Classes
    ClientCommonParams
    Note

    If unspecified, the default classifier is com.twitter.finagle.service.ResponseClassifier.Default which is a total function fully covering the input domain.

    See also

    com.twitter.finagle.http.service.HttpResponseClassifier for some HTTP classification tools.

  53. def withRetryBackoff(backoff: Stream[Duration]): Client

    Configures the requeue backoff policy of this client (default: no delay).

    Configures the requeue backoff policy of this client (default: no delay).

    The backoff policy is represented by a stream of delays (i.e., Stream[Duration]) used to delay each retry.

    Definition Classes
    ClientClientParams
    See also

    https://twitter.github.io/finagle/guide/Clients.html#retries

  54. def withRetryBudget(budget: RetryBudget): Client

    Configures the retry budget of this client (default: allows for about 20% of the total requests to be retried on top of 10 retries per second).

    Configures the retry budget of this client (default: allows for about 20% of the total requests to be retried on top of 10 retries per second).

    This budget is shared across requests and governs the number of retries that can be made by this client.

    Definition Classes
    ClientClientParams
    Note

    The retry budget helps prevent clients from overwhelming the downstream service.

    See also

    https://twitter.github.io/finagle/guide/Clients.html#retries

  55. val withSession: ClientSessionParams[Client]
    Definition Classes
    ClientWithClientSession
  56. val withSessionPool: SessionPoolingParams[Client]
    Definition Classes
    ClientWithSessionPool
  57. val withSessionQualifier: SessionQualificationParams[Client]
    Definition Classes
    ClientWithSessionQualifier
  58. def withStack(stack: Stack[ServiceFactory[Request, Response]]): Client

    A new StackClient with the provided stack.

    A new StackClient with the provided stack.

    Definition Classes
    ClientEndpointerStackClientStackClient
  59. def withStatsReceiver(statsReceiver: StatsReceiver): Client

    Configures this server or client with given stats.StatsReceiver (default: stats.DefaultStatsReceiver).

    Configures this server or client with given stats.StatsReceiver (default: stats.DefaultStatsReceiver).

    Definition Classes
    ClientCommonParams
  60. def withStreaming(enabled: Boolean): Client

    Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies.

    Streaming allows applications to work with HTTP messages that have large (or infinite) content bodies. When this set to true, the message content is available through a com.twitter.io.Reader, which gives the application a handle to the byte stream. If false, the entire message content is buffered into a com.twitter.io.Buf.

  61. def withTls(hostname: String): Client
  62. def withTlsWithoutValidation: Client
  63. def withTracer(tracer: Tracer): Client

    Configures this server or client with given tracing.Tracer (default: com.twitter.finagle.tracing.DefaultTracer).

    Configures this server or client with given tracing.Tracer (default: com.twitter.finagle.tracing.DefaultTracer).

    Definition Classes
    ClientCommonParams
  64. val withTransport: ClientTransportParams[Client]
    Definition Classes
    ClientWithClientTransport

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WithSessionPool[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 Parameterized[Client]

Inherited from finagle.Client[Request, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped