Class

com.twitter.finagle.context

MarshalledContext

Related Doc: package context

Permalink

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. abstract class Key[A] extends AnyRef

    Permalink

    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.

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

    Permalink

    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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply[A](key: Key[A]): A

    Permalink

    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

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def contains[A](key: Key[A]): Boolean

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. def get[A](key: Key[A]): Option[A]

    Permalink

    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[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getOrElse[A](key: Key[A], orElse: () ⇒ A): A

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def let[R](pairs: Iterable[KeyValuePair[_]])(fn: ⇒ R): R

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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

    Permalink

    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)]

    Permalink

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

  24. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  25. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Context

Inherited from AnyRef

Inherited from Any

Ungrouped