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 ThriftMux extends Client[ThriftClientRequest, Array[Byte]] with Server[Array[Byte], Array[Byte]]

    The ThriftMux object is both a com.twitter.finagle.Client and a com.twitter.finagle.Server for the Thrift protocol served over com.twitter.finagle.mux.

    The ThriftMux object is both a com.twitter.finagle.Client and a com.twitter.finagle.Server for the Thrift protocol served over com.twitter.finagle.mux. Rich interfaces are provided to adhere to those generated from a Thrift IDL by Scrooge or thrift-finagle.

    Clients

    Clients can be created directly from an interface generated from a Thrift IDL:

    For example, this IDL:

    service TestService {
      string query(1: string x)
    }

    compiled with Scrooge, generates the interface TestService.FutureIface. This is then passed into ThriftMux.Client.newIface:

    ThriftMux.client.newIface[TestService.FutureIface](
      addr, classOf[TestService.FutureIface])

    However note that the Scala compiler can insert the latter Class for us, for which another variant of newIface is provided:

    ThriftMux.client.newIface[TestService.FutureIface](addr)

    In Java, we need to provide the class object:

    TestService.FutureIface client =
      ThriftMux.client.newIface(addr, TestService.FutureIface.class);

    Servers

    Servers are also simple to expose:

    TestService.FutureIface must be implemented and passed into serveIface:

    // An echo service
    ThriftMux.server.serveIface(":*", new TestService.FutureIface {
      def query(x: String): Future[String] = Future.value(x)
    })

    This object does not expose any configuration options. Both clients and servers are instantiated with sane defaults. Clients are labeled with the "clnt/thrift" prefix and servers with "srv/thrift". If you'd like more configuration, see the configuration documentation.

    Definition Classes
    finagle
  • Client
  • Server
  • ServerMuxer

case class ServerMuxer(stack: Stack[ServiceFactory[Request, Response]] = BaseServerStack, params: Params = ...) extends StdStackServer[Request, Response, ServerMuxer] with Product with Serializable

A server for the Thrift protocol served over com.twitter.finagle.mux. ThriftMuxServer is backwards-compatible with Thrift clients that use the framed transport and binary protocol. It switches to the backward-compatible mode when the first request is not recognized as a valid Mux message but can be successfully handled by the underlying Thrift service. Since a Thrift message that is encoded with the binary protocol starts with a header value of 0x800100xx, Mux does not confuse it with a valid Mux message (0x80 = -128 is an invalid Mux message type) and the server can reliably detect the non-Mux Thrift client and switch to the backwards-compatible mode.

Note that the server is also compatible with non-Mux finagle-thrift clients. It correctly responds to the protocol up-negotiation request and passes the tracing information embedded in the thrift requests to Mux (which has native tracing support).

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerMuxer
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. StdStackServer
  7. ListeningStackServer
  8. WithServerAdmissionControl
  9. WithServerSession
  10. WithServerTransport
  11. CommonParams
  12. StackServer
  13. StackBasedServer
  14. Parameterized
  15. Server
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

Type Members

  1. type Context = MuxContext

    The type of the transport's context.

    The type of the transport's context.

    Attributes
    protected
    Definition Classes
    ServerMuxerStdStackServer
  2. type In = Buf

    The type we write into the transport.

    The type we write into the transport.

    Attributes
    protected
    Definition Classes
    ServerMuxerStdStackServer
  3. type Out = Buf

    The type we read out of the transport.

    The type we read out of the transport.

    Attributes
    protected
    Definition Classes
    ServerMuxerStdStackServer

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])): ServerMuxer

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

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

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

    Creates a new StackServer with parameter p.

    Creates a new StackServer with parameter p.

    Definition Classes
    ListeningStackServerStackServerParameterized
  8. def configuredParams(newParams: Params): ServerMuxer

    Creates a new StackServer with additional parameters newParams.

    Creates a new StackServer with additional parameters newParams.

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

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

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

    Attributes
    protected
    Definition Classes
    ServerMuxerListeningStackServer
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def newDispatcher(transport: Transport[In, Out] { type Context <: ServerMuxer.this.Context }, service: Service[Request, Response]): Closable

    Defines a dispatcher, a function which binds a transport to a com.twitter.finagle.Service.

    Defines a dispatcher, a function which binds a transport to a com.twitter.finagle.Service. Together with a Listener, it forms the foundation of a finagle server. Concrete implementations are expected to specify this.

    Attributes
    protected
    Definition Classes
    ServerMuxerStdStackServer
    Note

    The dispatcher must be prepared to handle the situation where it receives an already-closed transport.

    See also

    com.twitter.finagle.dispatch.GenSerialServerDispatcher

  16. def newListener(): Listener[In, Out, Context]

    Defines a typed com.twitter.finagle.server.Listener for this server.

    Defines a typed com.twitter.finagle.server.Listener for this server. Concrete StackServer implementations are expected to specify this.

    Attributes
    protected
    Definition Classes
    ServerMuxerStdStackServer
  17. final def newListeningServer(serviceFactory: ServiceFactory[Request, Response], addr: SocketAddress)(trackSession: (ClientConnection) ⇒ Unit): ListeningServer

    Constructs a new ListeningServer from the ServiceFactory.

    Constructs a new ListeningServer from the ServiceFactory. Each new session is passed to the trackSession function exactly once to facilitate connection resource management.

    Attributes
    protected
    Definition Classes
    StdStackServerListeningStackServer
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. val params: Params
    Definition Classes
    ServerMuxerStackServerParameterized
  21. def serve(addr: SocketAddress, factory: ServiceFactory[Request, Response]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    ServerMuxerListeningStackServerServer
  22. final def serve(addr: String, service: Service[Request, Response]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  23. final def serve(addr: String, service: ServiceFactory[Request, Response]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  24. final def serve(addr: SocketAddress, service: Service[Request, Response]): ListeningServer

    Serve service at addr

    Serve service at addr

    Definition Classes
    Server
  25. def serveAndAnnounce(name: String, service: Service[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  26. def serveAndAnnounce(name: String, service: ServiceFactory[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  27. def serveAndAnnounce(name: String, addr: String, service: Service[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  28. def serveAndAnnounce(name: String, addr: String, service: ServiceFactory[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  29. def serveAndAnnounce(name: String, addr: SocketAddress, service: Service[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  30. def serveAndAnnounce(name: String, addr: SocketAddress, service: ServiceFactory[Request, Response]): ListeningServer

    Serve service at addr and announce with name.

    Serve service at addr and announce with name. Announcements will be removed when the service is closed. Omitting the addr will bind to an ephemeral port.

    Definition Classes
    Server
  31. val stack: Stack[ServiceFactory[Request, Response]]
    Definition Classes
    ServerMuxerStackServer
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  36. val withAdmissionControl: ServerAdmissionControlParams[ServerMuxer]

    An entry point for configuring the servers' admission control.

    An entry point for configuring the servers' admission control.

    Definition Classes
    WithServerAdmissionControl
  37. def withExceptionStatsHandler(exceptionStatsHandler: ExceptionStatsHandler): ServerMuxer

    Configures this server or client with given exception stats handler.

    Configures this server or client with given exception stats handler.

    Definition Classes
    CommonParams
  38. def withLabel(label: String): ServerMuxer

    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
    CommonParams
  39. def withMonitor(monitor: Monitor): ServerMuxer

    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
    CommonParams
  40. def withParams(params: Params): ServerMuxer

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

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

    Definition Classes
    ListeningStackServerStackServerParameterized
  41. def withRequestTimeout(timeout: Tunable[Duration]): ServerMuxer

    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

  42. def withRequestTimeout(timeout: Duration): ServerMuxer

    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
    CommonParams
    See also

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

  43. def withResponseClassifier(responseClassifier: ResponseClassifier): ServerMuxer

    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
    CommonParams
    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.

  44. val withSession: SessionParams[ServerMuxer]

    An entry point for configuring the client's sessions.

    An entry point for configuring the client's sessions.

    Session might be viewed as logical connection that wraps a physical connection (i.e., transport) and controls its lifecycle. Sessions are used in Finagle to maintain liveness, requests cancellation, draining, and many more.

    The default setup for a Finagle client's sessions is to not put any timeouts on it.

    Definition Classes
    WithServerSession
  45. def withStack(stack: Stack[ServiceFactory[Request, Response]]): ServerMuxer

    A new StackServer with the provided Stack.

    A new StackServer with the provided Stack.

    Definition Classes
    ListeningStackServerStackServer
  46. def withStatsReceiver(statsReceiver: StatsReceiver): ServerMuxer

    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
    CommonParams
  47. def withTracer(tracer: Tracer): ServerMuxer

    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
    CommonParams
  48. val withTransport: ServerTransportParams[ServerMuxer]

    An entry point for configuring servers' com.twitter.finagle.transport.Transport.

    An entry point for configuring servers' com.twitter.finagle.transport.Transport.

    Transport is a Finagle abstraction over the network connection (i.e., a TCP connection).

    Definition Classes
    WithServerTransport

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from WithServerSession[ServerMuxer]

Inherited from CommonParams[ServerMuxer]

Inherited from StackServer[Request, Response]

Inherited from StackBasedServer[Request, Response]

Inherited from Parameterized[ServerMuxer]

Inherited from finagle.Server[Request, Response]

Inherited from AnyRef

Inherited from Any

Ungrouped