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
  • package dispatch
    Definition Classes
    finagle
  • ExpiringServerDispatcher
  • GenPipeliningDispatcher
  • GenSerialClientDispatcher
  • GenSerialServerDispatcher
  • PipeliningDispatcher
  • SerialClientDispatcher
  • SerialServerDispatcher
  • StalledPipelineTimeout
c

com.twitter.finagle.dispatch

SerialServerDispatcher

class SerialServerDispatcher[Req, Rep] extends GenSerialServerDispatcher[Req, Rep, Rep, Req]

Dispatch requests from transport one at a time, queueing concurrent requests.

Transport errors are considered fatal; the service will be released after any error.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SerialServerDispatcher
  2. GenSerialServerDispatcher
  3. Closable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SerialServerDispatcher(trans: Transport[Rep, Req], service: Service[Req, Rep])

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 close(deadline: Time): Future[Unit]
    Definition Classes
    GenSerialServerDispatcher → Closable
  7. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  8. final def close(): Future[Unit]
    Definition Classes
    Closable
  9. def dispatch(req: Req, eos: Promise[Unit]): Future[Rep]

    Dispatches a request.

    Dispatches a request. The first argument is the request. The second argument eos (end-of-stream promise) must be fulfilled when the request is complete.

    For non-streaming requests, eos.setDone() should be called immediately, since the entire request is present. For streaming requests, eos.setDone() must be called at the end of stream (in HTTP, this is on receipt of last chunk). Refer to the implementation in com.twitter.finagle.http.codec.HttpServerDispatcher.

    Attributes
    protected
    Definition Classes
    SerialServerDispatcherGenSerialServerDispatcher
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. def handle(rep: Rep): Future[Unit]
    Attributes
    protected
    Definition Classes
    SerialServerDispatcherGenSerialServerDispatcher
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def isClosing: Boolean

    Exposed for testing

    Exposed for testing

    Attributes
    protected[com.twitter.finagle.dispatch]
    Definition Classes
    GenSerialServerDispatcher
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from GenSerialServerDispatcher[Req, Rep, Rep, Req]

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped