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 context
    Definition Classes
    finagle
  • Context
  • Contexts
  • Deadline
  • LocalContext
  • MarshalledContext
  • RemoteInfo
c

com.twitter.finagle.context

MarshalledContext

final class MarshalledContext extends Context

A marshalled context contains bindings that may be marshalled and sent across process boundaries. A set of marshalled bindings may be restored in the local environment. Thus we can use marshalled contexts to propagate a set of bindings across a whole request tree.

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

Type Members

  1. case class KeyValuePair[T](key: Key[T], value: T) extends Product with Serializable

    Represents an opaque type that consists of a key-value pair which can be used to set multiple keys in the context.

    Represents an opaque type that consists of a key-value pair which can be used to set multiple keys in the context.

    Definition Classes
    Context
  2. abstract class Key[A] extends AnyRef

    Keys in MarshalledContext must provide a marshaller and unmarshaller.

    Keys in MarshalledContext must provide a marshaller and unmarshaller. The key id is used for marshalling and unmarshalling and thus must be unique. The behavior of the MarshalledContext when using two keys with the same key id is undefined.

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[A](key: Key[A]): A

    Retrieve the current definition of a key.

    Retrieve the current definition of a key.

    Definition Classes
    Context
    Annotations
    @throws( "If the key does not exist" )
    Exceptions thrown

    NoSuchElementException when the key is undefined in the current request-local context.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def contains[A](key: Key[A]): Boolean

    Tells whether key is defined in the current request-local context.

    Tells whether key is defined in the current request-local context.

    Definition Classes
    Context
  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. def get[A](key: Key[A]): Option[A]

    Retrieve the current definition of a key, but only if it is defined in the current request-local context.

    Retrieve the current definition of a key, but only if it is defined in the current request-local context.

    Definition Classes
    MarshalledContextContext
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def getOrElse[A](key: Key[A], orElse: () ⇒ A): A

    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
    Context
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def let[R](pairs: Iterable[KeyValuePair[_]])(fn: ⇒ R): R

    Bind multiple key-value pairs.

    Bind multiple key-value pairs. Keys later in the collection take precedent over keys earlier in the collection.

    Definition Classes
    MarshalledContextContext
  17. def let[A, B, R](key1: Key[A], value1: A, key2: Key[B], value2: B)(fn: ⇒ R): R

    Bind two keys and values in the scope of fn.

    Bind two keys and values in the scope of fn.

    Definition Classes
    MarshalledContextContext
  18. def let[A, R](key: Key[A], value: A)(fn: ⇒ R): R

    Bind value to key in the scope of fn.

    Bind value to key in the scope of fn.

    Definition Classes
    MarshalledContextContext
  19. def letClear[R](keys: Iterable[Key[_]])(fn: ⇒ R): R

    Unbind the passed-in keys, in the scope of fn.

    Unbind the passed-in keys, in the scope of fn.

    Definition Classes
    MarshalledContextContext
  20. def letClear[R](key: Key[_])(fn: ⇒ R): R

    Unbind the passed-in key, in the scope of fn.

    Unbind the passed-in key, in the scope of fn.

    Definition Classes
    MarshalledContextContext
  21. def letClearAll[R](fn: ⇒ R): R

    Clears all bindings in the scope of fn.

    Clears all bindings in the scope of fn.

    For example:

    context.let(Key1, "value1") {
      context.let(Key2, "something else") {
        context.letClearAll {
          // context.contains(Key1) == false
          // context.contains(Key2) == false
        }
        // context(Key1) == "value1"
        // context(Key2) == "something else"
      }
    }
    Definition Classes
    MarshalledContextContext
  22. def letUnmarshal[R](contexts: Iterable[(Buf, Buf)])(fn: ⇒ R): R

    Store into the current environment a set of marshalled bindings and run fn.

    Store into the current environment a set of marshalled bindings and run fn. Bindings are unmarshalled on demand.

  23. def marshal(): Iterable[(Buf, Buf)]

    Marshal the current environment into a set of (id, value) pairs.

  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    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( ... )

Inherited from Context

Inherited from AnyRef

Inherited from Any

Ungrouped