class MutableLockableState[Status <: PrettyPrinting] extends LockableState[Status] with PrettyPrinting

A mutable lockable in-memory state with support for pre-fetching from a store

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MutableLockableState
  2. LockableState
  3. PrettyPrinting
  4. PrettyUtil
  5. ShowUtil
  6. ShowSyntax
  7. ToShowOps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new MutableLockableState(initialState: Option[Option[StateChange[Status]]])

    initialState

    scala.None$ for no pre-fetched state scala.Some$(scala.None$) for the pre-fetched state where the underlying store has not entry. scala.Some$(scala.Some$(...)) for the pre-fetched state ... from the underlying store.

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  9. abstract class StringOperators extends AnyRef

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Enables syntax like show"This is a string: ${myString.doubleQuoted}" and show"This is a hash: ${myHash.readableHash}".

    Definition Classes
    ShowUtil

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 adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def completeActivenessCheck(): Unit

    Completes one pending activeness check.

    Completes one pending activeness check.

    Exceptions thrown

    IllegalConflictDetectionStateException if all pending activeness checks have already been completed.

  8. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hasPendingActivenessChecks: Boolean
    Definition Classes
    LockableState
  13. def hasPendingWrites: Boolean
    Definition Classes
    LockableState
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. def lock: LockCounter
    Definition Classes
    MutableLockableStateLockableState
  17. def locked: Boolean
    Definition Classes
    LockableState
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def obtainLock(): Boolean

    Obtains one lock on the status and returns whether the lock was free before.

    Obtains one lock on the status and returns whether the lock was free before.

    Exceptions thrown

    IllegalConflictDetectionStateException if 2^32 - 1 locks have already been taken.

  22. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  23. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  24. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  25. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  26. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  27. def pendingActivenessChecks: PendingActivenessCheckCounter
    Definition Classes
    MutableLockableStateLockableState
  28. def pendingWrites: PendingWriteCounter
    Definition Classes
    MutableLockableStateLockableState
  29. def pretty: Pretty[MutableLockableState.this.type]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Definition Classes
    LockableStatePrettyPrinting
  30. def prettyInfix[T, U, V](first: (T) => U, infixOp: String, second: (T) => V)(implicit arg0: Pretty[U], arg1: Pretty[V]): Pretty[T]
    Definition Classes
    PrettyUtil
  31. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  32. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  33. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  34. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  35. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  36. def provideFetchedState(fetchedState: Option[StateChange[Status]]): Unit

    Signals that fetchedState is the latest state in the store, except for updates written to the store through the ConflictDetector.

    Signals that fetchedState is the latest state in the store, except for updates written to the store through the ConflictDetector. Signals to all pending activeness check callers that the state is now available unless the state previously was available.

    Does not complete a pending activeness check.

  37. def registerPendingActivenessCheck(): Option[Future[Option[StateChange[Status]]]]

    Registers one pending activeness checks.

    Registers one pending activeness checks.

    returns

    scala.None$ if the state is unknown. The caller must fetch the latest state from the store and signal it with provideFetchedState. scala.Some$ a future that completes after the state has become available (via provideFetchedState or setStatusPendingWrite)

    Exceptions thrown

    IllegalConflictDetectionStateException if 2^32 - 1 pending activeness checks have already been registered.

  38. def safeToEvict(implicit stateLocking: LockableStatus[Status]): Boolean
  39. def setStatusPendingWrite(newStatus: Status, toc: TimeOfChange): Unit

    Set a new state for the contract with the update of the persistent store pending.

    Set a new state for the contract with the update of the persistent store pending.

    Exceptions thrown

    IllegalConflictDetectionStateException if no lock is held or there are already 2^32-1 pending writes.

  40. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  41. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  42. def signalWrite(): Unit

    Signal that one of the contract's pending state changes has been written to the persistent store.

    Signal that one of the contract's pending state changes has been written to the persistent store.

    Exceptions thrown

    IllegalConflictDetectionStateException if there are no pending writes.

  43. def snapshot: ImmutableLockableState[Status]
  44. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  45. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  46. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  47. def unlock(): Unit

    Releases one lock.

    Releases one lock.

    Exceptions thrown

    IllegalConflictDetectionStateException if no lock is held.

  48. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  49. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  50. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  51. def versionedState: Option[Option[StateChange[Status]]]

    scala.None$ for no pre-fetched state scala.Some$(scala.None$) for the state where the underlying store has no entry.

    scala.None$ for no pre-fetched state scala.Some$(scala.None$) for the state where the underlying store has no entry. scala.Some$(scala.Some$(...)) for the actual state ....

    Definition Classes
    MutableLockableStateLockableState
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from LockableState[Status]

Inherited from PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from AnyRef

Inherited from Any

Ungrouped