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 netty4

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

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

    Definition Classes
    finagle
  • package exp
    Definition Classes
    netty4
  • package http

    Finagle HTTP implementation based on Netty 4.

    Finagle HTTP implementation based on Netty 4.

    Definition Classes
    netty4
  • package param
    Definition Classes
    netty4
  • package ssl
    Definition Classes
    netty4
  • package threading
    Definition Classes
    netty4
  • Netty4Listener
  • Netty4Transporter
  • nativeEpoll
  • numWorkers
  • referenceLeakLintRule

case class Netty4Listener[In, Out, Ctx <: TransportContext](pipelineInit: (ChannelPipeline) ⇒ Unit, params: Params, setupMarshalling: (ChannelInitializer[Channel]) ⇒ ChannelHandler, transportFactory: (Channel) ⇒ Transport[Any, Any] { type Context <: Ctx })(implicit mIn: Manifest[In], mOut: Manifest[Out]) extends Listener[In, Out, Ctx] with Product with Serializable

Constructs a Listener[In, Out] given a pipelineInit function responsible for framing a Transport stream. The Listener is configured via the passed in Params.

See also

com.twitter.finagle.param

com.twitter.finagle.transport.Transport

com.twitter.finagle.server.Listener

Linear Supertypes
Serializable, Serializable, Product, Equals, Listener[In, Out, Ctx], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Netty4Listener
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Listener
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Netty4Listener(pipelineInit: (ChannelPipeline) ⇒ Unit, params: Params, setupMarshalling: (ChannelInitializer[Channel]) ⇒ ChannelHandler, transportFactory: (Channel) ⇒ Transport[Any, Any] { type Context <: Ctx })(implicit mIn: Manifest[In], mOut: Manifest[Out])

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 finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. def listen(addr: SocketAddress)(serveTransport: (Transport[In, Out] { type Context <: Ctx }) ⇒ Unit): ListeningServer

    Listen for connections and apply the serveTransport callback on connected transports.

    Listen for connections and apply the serveTransport callback on connected transports.

    addr

    socket address for listening.

    serveTransport

    a call-back for newly created transports which in turn are created for new connections.

    Definition Classes
    Netty4ListenerListener
    Note

    the serveTransport implementation is responsible for calling close on transports.

  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. val params: Params
  15. val pipelineInit: (ChannelPipeline) ⇒ Unit
  16. val setupMarshalling: (ChannelInitializer[Channel]) ⇒ ChannelHandler
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    Netty4Listener → AnyRef → Any
  19. val transportFactory: (Channel) ⇒ Transport[Any, Any] { type Context <: Ctx }
  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( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Listener[In, Out, Ctx]

Inherited from AnyRef

Inherited from Any

Ungrouped