final case class EngineController(participantId: ParticipantId, requestId: RequestId, loggerFactory: NamedLoggerFactory, testHookFor: (String) => () => Unit = _ => () => ()) extends NamedLogging with Product with Serializable

Simple class to embody the connection between a component that wants to abort an engine computation and the engine itself. An instance of this class is created by the protocol processor for each request and passed along during processing. When a condition determines that the computation should be aborted, the component calls abort. The instance is also passed to the engine when performing a computation. During the execution of a ResultInterruption, the engine will call abortStatus to determine whether it should abort or continue.

participantId

the participant processing the associated request

requestId

the associated request

testHookFor

hooks meant to be used in tests to perform actions during engine processing, such as slowing it down; see com.digitalasset.canton.config.TestingConfigInternal for a more detailed explanation

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EngineController
  2. Serializable
  3. Product
  4. Equals
  5. NamedLogging
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new EngineController(participantId: ParticipantId, requestId: RequestId, loggerFactory: NamedLoggerFactory, testHookFor: (String) => () => Unit = _ => () => ())

    participantId

    the participant processing the associated request

    requestId

    the associated request

    testHookFor

    hooks meant to be used in tests to perform actions during engine processing, such as slowing it down; see com.digitalasset.canton.config.TestingConfigInternal for a more detailed explanation

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 abort(reason: String)(implicit traceContext: TraceContext): Unit

    Ask the engine computation for this request to be aborted for the given reason.

  5. def abortStatus: EngineAbortStatus

    Return the engine abort status for this request.

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  13. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    EngineControllerNamedLogging
  14. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. val participantId: ParticipantId
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val requestId: RequestId
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. val testHookFor: (String) => () => Unit
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. 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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped