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 netty3

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Package netty3 implements the bottom finagle primitives: {{com.twitter.finagle.Server}} and a client transport in terms of the netty3 event loop.

    Note: when {{com.twitter.finagle.builder.ClientBuilder}} and {{com.twitter.finagle.builder.ServerBuilder}} are deprecated, package netty3 can move into its own package, so that only the (new-style) clients and servers that depend on netty3 bring it in.

    Definition Classes
    finagle
  • package transport
    Definition Classes
    netty3
  • ChannelTransport

class ChannelTransport[In, Out] extends Transport[In, Out] with ChannelUpstreamHandler

Linear Supertypes
ChannelUpstreamHandler, ChannelHandler, Transport[In, Out], Closable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChannelTransport
  2. ChannelUpstreamHandler
  3. ChannelHandler
  4. Transport
  5. Closable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChannelTransport(ch: Channel)

Type Members

  1. type Context = TransportContext
    Definition Classes
    ChannelTransportTransport

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
    ChannelTransport → Closable
  7. def close(after: Duration): Future[Unit]
    Definition Classes
    Closable
  8. final def close(): Future[Unit]
    Definition Classes
    Closable
  9. val context: TransportContext
    Definition Classes
    ChannelTransportTransport
  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 handleUpstream(ctx: ChannelHandlerContext, e: ChannelEvent): Unit
    Definition Classes
    ChannelTransport → ChannelUpstreamHandler
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. def localAddress: SocketAddress

    The locally bound address of this transport.

    The locally bound address of this transport.

    Definition Classes
    ChannelTransportTransport
  18. def map[In1, Out1](f: (In1) ⇒ In, g: (Out) ⇒ Out1): Transport[In1, Out1]

    Maps this transport to Transport[In1, Out2].

    Maps this transport to Transport[In1, Out2]. Note, exceptions in f and g are lifted to a com.twitter.util.Future.

    f

    The function applied to writes input.

    g

    The function applied to the result of a read

    Definition Classes
    Transport
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val onClose: Future[Throwable]
    Definition Classes
    ChannelTransportTransport
  23. val peerCertificate: Option[Certificate]
    Definition Classes
    ChannelTransportTransport
  24. def read(): Future[Out]

    Read a message from the transport.

    Read a message from the transport.

    Definition Classes
    ChannelTransportTransport
  25. def remoteAddress: SocketAddress

    The remote address to which the transport is connected.

    The remote address to which the transport is connected.

    Definition Classes
    ChannelTransportTransport
  26. def status: Status

    The status of this transport; see com.twitter.finagle.Status for status definitions.

    The status of this transport; see com.twitter.finagle.Status for status definitions.

    Definition Classes
    ChannelTransportTransport
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    ChannelTransport → AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  32. def write(msg: In): Future[Unit]

    Write req to this transport; the returned future acknowledges write completion.

    Write req to this transport; the returned future acknowledges write completion.

    Definition Classes
    ChannelTransportTransport

Inherited from ChannelUpstreamHandler

Inherited from ChannelHandler

Inherited from Transport[In, Out]

Inherited from Closable

Inherited from AnyRef

Inherited from Any

Ungrouped