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.
- Alphabetic
- By Inheritance
- MarshalledContext
- Context
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- 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
- 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
is used for marshalling and unmarshalling and thus must be unique. The behavior of the MarshalledContext when using two keys with the same keyid
is undefined.- Note
the key's
id
is treated without case sensitivity.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- 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
- MarshalledContext → Context
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- MarshalledContext → Context
- 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
- MarshalledContext → Context
- def let[A, R](key: Key[A], value: A)(fn: => R): R
Bind
value
tokey
in the scope offn
.Bind
value
tokey
in the scope offn
.- Definition Classes
- MarshalledContext → Context
- 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
- MarshalledContext → Context
- 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
- MarshalledContext → Context
- 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
- MarshalledContext → Context
- 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. - def marshal(): Iterable[(Buf, Buf)]
Marshal the current environment into a set of (id, value) pairs.
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()