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 transport
    Definition Classes
    finagle
  • QueueTransport
  • StatsTransport
  • Transport
  • TransportContext
  • TransportFactory
  • TransportProxy

object Transport

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

Type Members

  1. case class BufferSizes(send: Option[Int], recv: Option[Int]) extends Product with Serializable

    $param the buffer sizes of a Transport.

    $param the buffer sizes of a Transport.

    send

    An option indicating the size of the send buffer. If None, the implementation default is used.

    recv

    An option indicating the size of the receive buffer. If None, the implementation default is used.

  2. case class ClientSsl(sslClientConfiguration: Option[SslClientConfiguration]) extends Product with Serializable

    $param the SSL/TLS client configuration for a Transport.

  3. case class Liveness(readTimeout: Duration, writeTimeout: Duration, keepAlive: Option[Boolean]) extends Product with Serializable

    $param the liveness of a Transport.

    $param the liveness of a Transport. These properties dictate the lifecycle of a Transport and ensure that it remains relevant.

    readTimeout

    A maximum duration a listener is allowed to read a request.

    writeTimeout

    A maximum duration a listener is allowed to write a response.

    keepAlive

    An option indicating if the keepAlive is on or off. If None, the implementation default is used.

  4. case class Options(noDelay: Boolean, reuseAddr: Boolean) extends Product with Serializable

    $param the options (i.e., socket options) of a Transport.

    $param the options (i.e., socket options) of a Transport.

    noDelay

    enables or disables TCP_NODELAY (Nagle's algorithm) option on a transport socket (noDelay = true means disabled). Default is true (disabled).

    reuseAddr

    enables or disables SO_REUSEADDR option on a transport socket. Default is true.

  5. case class ServerSsl(sslServerConfiguration: Option[SslServerConfiguration]) extends Product with Serializable

    $param the SSL/TLS server configuration for a Transport.

  6. case class Verbose(enabled: Boolean) extends Product with Serializable

    $param the verbosity of a Transport.

    $param the verbosity of a Transport. Transport activity is written to com.twitter.finagle.param.Logger.

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 cast[In1, Out1](cls: Class[Out1], trans: Transport[Any, Any]): Transport[In1, Out1]

    Casts an object transport to Transport[In1, Out1].

    Casts an object transport to Transport[In1, Out1]. Note that this is generally unsafe: only do this when you know the cast is guaranteed safe. This is useful when coercing a netty object pipeline into a typed transport, for example.

    See also

    Transport.cast(trans) for Scala users.

  6. def cast[In1, Out1](trans: Transport[Any, Any])(implicit m: Manifest[Out1]): Transport[In1, Out1]

    Casts an object transport to Transport[In1, Out1].

    Casts an object transport to Transport[In1, Out1]. Note that this is generally unsafe: only do this when you know the cast is guaranteed safe. This is useful when coercing a netty object pipeline into a typed transport, for example.

    See also

    transport) for Java users.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. def hashCode(): Int
    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. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def peerCertificate: Option[Certificate]

    Retrieve the transport's SSLSession (if any) from com.twitter.finagle.context.Contexts.local

  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  23. object BufferSizes extends Serializable
  24. object ClientSsl extends Serializable
  25. object Liveness extends Serializable
  26. object Options extends Serializable
  27. object ServerSsl extends Serializable
  28. object Verbose extends Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped