Packages

  • package root
    Definition Classes
    root
  • package com

    Start with com.twitter.finagle.

    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 context
    Definition Classes
    finagle
  • trait Context extends AnyRef

    A context contains a number of let-delimited bindings.

    A context contains a number of let-delimited bindings. Bindings are indexed by type Key[A] in a typesafe manner. Later bindings shadow earlier ones.

    Note that the implementation of context maintains all bindings in a linked list; context lookup requires a linear search.

    Definition Classes
    context
  • Bound
  • Cleared
  • Empty
  • Env
  • Key
  • OrElse

case class Cleared[A](next: Env, key: Key[A]) extends Env with Product with Serializable

An environment without key. Lookups for other keys are forwarded to next.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Cleared
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Env
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cleared(next: Env, key: Key[A])

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. def apply[B](key: Key[B]): B

    Retrieve the current definition of a key.

    Retrieve the current definition of a key.

    Definition Classes
    ClearedEnv
    Exceptions thrown

    NoSuchElementException when the key is undefined in this environment.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. final def bound[A](key: Key[A], value: A): Env

    Create a derived environment where key is bound to value; previous bindings of key are shadowed.

    Create a derived environment where key is bound to value; previous bindings of key are shadowed.

    Definition Classes
    Env
  7. final def cleared(key: Key[_]): Env

    Clear the binding for the given key.

    Clear the binding for the given key. Lookups for key will be negative in the returned environment.

    Definition Classes
    Env
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def contains[B](key: Key[B]): Boolean

    Tells whether key is defined in this environment.

    Tells whether key is defined in this environment.

    Definition Classes
    ClearedEnv
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def get[B](key: Key[B]): Option[B]

    Retrieve the current definition of a key, but only if it is defined.

    Retrieve the current definition of a key, but only if it is defined.

    Definition Classes
    ClearedEnv
  13. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  14. def getOrElse[B](key: Key[B], orElse: () ⇒ B): B

    Retrieve the current definition of a key if it is defined.

    Retrieve the current definition of a key if it is defined. If it is not defined, orElse is evaluated and returned.

    Definition Classes
    ClearedEnv
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val key: Key[A]
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. val next: Env
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    Cleared → AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Env

Inherited from AnyRef

Inherited from Any

Ungrouped