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 client
    Definition Classes
    finagle
  • AddrMetadataExtraction
  • DefaultPool
  • DynamicTimeout
  • EndpointerModule
  • EndpointerStackClient
  • LatencyCompensation
  • StackBasedClient
  • StackClient
  • StatsScoping
  • StdStackClient
  • Transporter

trait StackClient[Req, Rep] extends StackBasedClient[Req, Rep] with Parameterized[StackClient[Req, Rep]] with Transformable[StackClient[Req, Rep]]

A Client that composes a Stack.

Linear Supertypes
StackBasedClient[Req, Rep], Transformable[StackClient[Req, Rep]], Parameterized[StackClient[Req, Rep]], Client[Req, Rep], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StackClient
  2. StackBasedClient
  3. Transformable
  4. Parameterized
  5. Client
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def newClient(dest: Name, label: String): ServiceFactory[Req, Rep]

    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
  2. abstract def newService(dest: Name, label: String): Service[Req, Rep]

    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
    Client
  3. abstract def params: Params

    The current parameter map.

    The current parameter map.

    Definition Classes
    StackClientParameterized
  4. abstract def stack: Stack[ServiceFactory[Req, Rep]]

    The current stack.

  5. abstract def withParams(ps: Params): StackClient[Req, Rep]
    Definition Classes
    StackClientParameterized
  6. abstract def withStack(stack: Stack[ServiceFactory[Req, Rep]]): StackClient[Req, Rep]

    A new StackClient with the provided stack.

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. 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])): StackClient[Req, Rep]

    Java friendly API for configured.

    Java friendly API for configured.

    The Tuple2 can often be created by calls to a mk(): (P, Stack.Param[P]) method on parameters (see com.twitter.finagle.loadbalancer.LoadBalancerFactory.Param.mk() as an example).

    Definition Classes
    Parameterized
  7. def configured[P](p: P)(implicit sp: Param[P]): StackClient[Req, Rep]

    Add the parameter, p, to the current Params.

    Add the parameter, p, to the current Params.

    Java users may find it easier to use the Tuple2 version below.

    Definition Classes
    Parameterized
  8. def configuredParams(newParams: Params): StackClient[Req, Rep]

    Adds all parameters, newParams, to the current Params.

    Adds all parameters, newParams, to the current Params.

    Definition Classes
    Parameterized
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  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. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def newClient(dest: String, label: String): ServiceFactory[Req, Rep]

    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
  17. final def newClient(dest: String): ServiceFactory[Req, Rep]

    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
  18. final def newService(dest: String, label: String): Service[Req, Rep]

    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
  19. final def newService(dest: String): Service[Req, Rep]

    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
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. 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
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. def transformed(t: Stack.Transformer): StackClient[Req, Rep]

    Transform the stack using the given Transformer.

    Transform the stack using the given Transformer.

    Definition Classes
    StackClientTransformable
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from StackBasedClient[Req, Rep]

Inherited from Transformable[StackClient[Req, Rep]]

Inherited from Parameterized[StackClient[Req, Rep]]

Inherited from Client[Req, Rep]

Inherited from AnyRef

Inherited from Any

Ungrouped