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

object Transporter

A collection of Stack.Params useful for configuring a com.twitter.finagle.client.Transporter.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Transporter
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class ConnectTimeout(howlong: Duration) extends Product with Serializable

    $param the connect timeout of a Transporter.

    $param the connect timeout of a Transporter.

    howlong

    Maximum amount of time a transport is allowed to spend connecting. Must be non-negative.

  2. case class Credentials(username: String, password: String) extends Product with Serializable

    This class wraps the username, password that we use for http proxy auth

  3. case class EndpointAddr(addr: Address) extends Product with Serializable

    $param a SocketAddress that a Transporter connects to.

  4. case class HttpProxy(sa: Option[SocketAddress], credentials: Option[Credentials]) extends Product with Serializable

    $param a HttpProxy as the endpoint for a Transporter.

    $param a HttpProxy as the endpoint for a Transporter.

    See also

    http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html#9.9

  5. case class HttpProxyTo(hostAndCredentials: Option[(String, Option[Credentials])]) extends Product with Serializable
  6. case class SocksProxy(sa: Option[SocketAddress], credentials: Option[(String, String)]) extends Product with Serializable

    $param a SocksProxy as the endpoint for a Transporter.

  7. case class TrafficClass(value: Option[Int]) extends Product with Serializable

    Configures the traffic class to be used by clients.

    Configures the traffic class to be used by clients.

    value

    None indicates no class specified. When Some, is an opaque identifier and its meaning and interpretation are implementation specific. Currently used to configure java.net.StandardSocketOptions.IP_TOS.

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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  20. object ConnectTimeout extends Serializable
  21. object EndpointAddr extends Serializable
  22. object HttpProxy extends Serializable
  23. object HttpProxyTo extends Serializable
  24. object SocksProxy extends Serializable
  25. object TrafficClass extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped