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

abstract class GenPipeliningDispatcher[Req, Rep, In, Out, T] extends GenSerialClientDispatcher[Req, Rep, In, Out]

A generic pipelining dispatcher, which assumes that servers will respect normal pipelining semantics, and that replies will be sent in the same order as requests were sent. Exploits GenSerialClientDispatcher to serialize requests.

Because many requests might be sharing the same transport, Futures returned by GenPipeliningDispatcher#apply are masked, and will only propagate the interrupt if the future doesn't return after a configurable amount of time after the interruption. This ensures that interrupting a Future in one request won't change the result of another request unless the connection is stuck, and does not look like it will make progress. Use StalledPipelineTimeout to configure this timeout.

Self Type
GenPipeliningDispatcher[Req, Rep, In, Out, T]
Linear Supertypes
GenSerialClientDispatcher[Req, Rep, In, Out], Service[Req, Rep], Closable, (Req) ⇒ Future[Rep], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenPipeliningDispatcher
  2. GenSerialClientDispatcher
  3. Service
  4. Closable
  5. Function1
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GenPipeliningDispatcher(trans: Transport[In, Out], statsReceiver: StatsReceiver, stallTimeout: Duration, timer: Timer)

    statsReceiver

    typically scoped to clientName/dispatcher

Abstract Value Members

  1. abstract def pipeline(req: Req, p: Promise[Rep]): Future[T]

    Send a request req to the server and provide a value T to insert into the pipeline queue.

    Send a request req to the server and provide a value T to insert into the pipeline queue. The value is provided back to respond to handle the corresponding request.

    req

    the request to send

    p

    the promise to fulfill when the request is handled.

    returns

    a value associated with req that is handed back during response handling.

    Attributes
    protected
  2. abstract def respond(value: T, p: Promise[Rep], out: Try[Out]): Unit

    Handle the server response out given the corresponding element value enqueued during dispatch.

    Handle the server response out given the corresponding element value enqueued during dispatch.

    This typically involves fulfilling p with a function of (T, Try[Out]) => Rep

    value

    the corresponding element returned by pipeline during dispatch

    p

    the promise to fulfill the rpc

    out

    the server response

    Attributes
    protected

Concrete 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. def andThen[A](g: (Future[Rep]) ⇒ A): (Req) ⇒ A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(req: Req): Future[Rep]

    This is the method to override/implement to create your own Service.

    This is the method to override/implement to create your own Service.

    Definition Classes
    GenPipeliningDispatcherGenSerialClientDispatcherService → Function1
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def close(deadline: Time): Future[Unit]
    Definition Classes
    GenSerialClientDispatcherService → Closable
  9. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  10. final def close(): Future[Unit]
    Definition Classes
    Closable
  11. def compose[A](g: (A) ⇒ Req): (A) ⇒ Future[Rep]
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  12. def dispatch(req: Req, p: Promise[Rep]): Future[Unit]

    Dispatch a request, satisfying Promise p with the response; the returned Future is satisfied when the dispatch is complete: only one request is admitted at any given time.

    Dispatch a request, satisfying Promise p with the response; the returned Future is satisfied when the dispatch is complete: only one request is admitted at any given time.

    Note that GenSerialClientDispatcher manages interrupts, satisfying p should it be interrupted -- implementors beware: use only updateIfEmpty variants for satisfying the Promise.

    GenSerialClientDispatcher will also attempt to satisfy the promise if the returned Future[Unit] fails.

    Attributes
    protected
    Definition Classes
    GenPipeliningDispatcherGenSerialClientDispatcher
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isAvailable: Boolean

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Determines whether this Service is available (can accept requests with a reasonable likelihood of success).

    Definition Classes
    Service
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[Req1](f: (Req1) ⇒ Req): Service[Req1, Rep]
    Definition Classes
    Service
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. def status: Status

    The current availability Status of this Service.

    The current availability Status of this Service.

    Definition Classes
    GenSerialClientDispatcherService
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from GenSerialClientDispatcher[Req, Rep, In, Out]

Inherited from Service[Req, Rep]

Inherited from Closable

Inherited from (Req) ⇒ Future[Rep]

Inherited from AnyRef

Inherited from Any

Ungrouped