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
- Alphabetic
- By Inheritance
- EngineController
- Serializable
- Product
- Equals
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- 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 abort(reason: String)(implicit traceContext: TraceContext): Unit
Ask the engine computation for this request to be aborted for the given reason.
- def abortStatus: EngineAbortStatus
Return the engine abort status for this request.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- EngineController → NamedLogging
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val participantId: ParticipantId
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requestId: RequestId
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val testHookFor: (String) => () => Unit
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])