Trait

com.twitter.finagle.context

Context

Related Doc: package context

Permalink

trait Context extends AnyRef

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.

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

Type Members

  1. abstract type Key[A]

    Permalink
  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.

Abstract Value Members

  1. abstract 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.

  2. abstract def let[R](keys: 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.

  3. abstract 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.

  4. abstract def let[A, R](key: Key[A], value: A)(fn: ⇒ R): R

    Permalink

    Bind value to key in the scope of fn.

  5. abstract def letClear[R](keys: Iterable[Key[_]])(fn: ⇒ R): R

    Permalink

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

  6. abstract def letClear[R](key: Key[_])(fn: ⇒ R): R

    Permalink

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

  7. abstract 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"
      }
    }

Concrete 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.

    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.

  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. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. 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.

  13. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped