Trait

com.twitter.scrooge.adapt

AdaptContext

Related Doc: package adapt

Permalink

trait AdaptContext extends AnyRef

Helper methods for adaptive decoding. See comments for individual methods to learn more.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AdaptContext
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def buildDecoder[T <: ThriftStruct](codec: ThriftStructCodec[T], fallback: Decoder[T], accessRecordingDecoderBuilder: (AccessRecorder) ⇒ Decoder[T]): Decoder[T]

    Permalink

    Build a decoder.

    Build a decoder. This method is called by the scrooge generated code and typically not by user written code.

    fallback

    Scrooge generated code provides a decoder to fallback on in case adaptive decoding is not considered useful. e.g. if all fields in a thrift are accessed all the time.

    accessRecordingDecoderBuilder

    Scrooge generated code provides a decoder that allows injecting an access recorder. The access recorder is called whenever any field of the thrift object is accessed. Knowledge of field accesses is used to build an adapted decoder.

  2. abstract def initCopy(): AdaptContext

    Permalink

    Override this to provide a copy at initial state if implementation uses mutable state.

    Override this to provide a copy at initial state if implementation uses mutable state. This is needed for Adaptive Scrooge to generate the protocol for lazy decoding. When a field that is considered unused does get accessed the entire thrift is deserialized again from original bytes. To do so a new instance of protocol is needed and to create that AdaptContext is needed.

  3. abstract def shouldReloadDecoder: Boolean

    Permalink

    Should the caller reload the decoder.

    Should the caller reload the decoder. This is a contract with the caller, which is honored by the scrooge generated code. Ability to reload the decoder allows for testing. In future this mechanism may be used to retrigger adaptation.

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped