trait ConsoleEnvironment extends NamedLogging with FlagCloseable with NoTracing
The environment in which console commands are evaluated.
- Annotations
- @SuppressWarnings()
- Alphabetic
- By Inheritance
- ConsoleEnvironment
- NoTracing
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- abstract type DomainLocalRef <: LocalDomainReference
- abstract type DomainRemoteRef <: RemoteDomainReference
- abstract type Env <: Environment
- abstract type Status <: CantonStatus
- case class TopLevelValue[T](nameUnsafe: String, summary: String, value: T, topic: Seq[String] = Seq())(implicit tag: scala.reflect.api.JavaUniverse.TypeTag[T]) extends Product with Serializable
Holder for top level values including their name, their value, and a description to display when
helpis printed.Holder for top level values including their name, their value, and a description to display when
helpis printed.- Attributes
- protected
Abstract Value Members
- abstract def consoleEnvironmentBindings: ConsoleEnvironmentBinding
- Attributes
- protected
- abstract val consoleOutput: ConsoleOutput
the console for user facing output
- abstract def createAdminCommandRunner: (ConsoleEnvironment) => ConsoleGrpcAdminCommandRunner
allows for injecting a custom admin command runner during tests
allows for injecting a custom admin command runner during tests
- Attributes
- protected
- abstract def createDomainReference(name: String): DomainLocalRef
- Attributes
- protected
- abstract def createRemoteDomainReference(name: String): DomainRemoteRef
- Attributes
- protected
- abstract def domainsTopLevelValue(h: Partial, domains: NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]): TopLevelValue[NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]]
- Attributes
- protected
- abstract val environment: Env
the underlying Canton runtime environment
- abstract def health: CantonHealthAdministration[Status]
- abstract def localDomainHelpItems(scope: Set[FeatureFlag], localDomain: DomainLocalRef): Seq[Item]
Generate implementation specific help items for local domains
Generate implementation specific help items for local domains
- Attributes
- protected
- abstract def localDomainTopLevelValue(h: Partial, d: DomainLocalRef): TopLevelValue[DomainLocalRef]
Supply the local domain value used by the implementation
Supply the local domain value used by the implementation
- Attributes
- protected
- abstract def remoteDomainHelpItems(scope: Set[FeatureFlag], remoteDomain: DomainRemoteRef): Seq[Item]
Generate implementation specific help items for remote domains
Generate implementation specific help items for remote domains
- Attributes
- protected
- abstract def remoteDomainTopLevelValue(h: Partial, d: DomainRemoteRef): TopLevelValue[DomainRemoteRef]
Supply the remote domain value used by the implementation
Supply the remote domain value used by the implementation
- Attributes
- protected
- abstract def startupOrderPrecedence(instance: LocalInstanceReferenceCommon): Int
Definition of the startup order of local instances.
Definition of the startup order of local instances. Nodes support starting up in any order however to avoid delays/warnings we opt to start in the most desirable order for simple execution. (e.g. domains started before participants). Implementations should just return a int for the instance (typically just a static value based on type), and then the console will start these instances for lower to higher values.
- Attributes
- protected
Concrete 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- lazy val bindings: Either[RuntimeException, IndexedSeq[Bind[_]]]
Bindings for ammonite Add a reference to this instance to resolve implicit references within the console
- def cancelShutdownTask(token: Long): Unit
Removes a shutdown task from the list using a token returned by runOnShutdown
Removes a shutdown task from the list using a token returned by runOnShutdown
- Definition Classes
- OnShutdownRunner
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → OnShutdownRunner → AutoCloseable
- def closeChannels(): Unit
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def commandTimeouts: ConsoleCommandTimeout
- returns
maximum runtime of a console command
- def consoleLogger: Logger
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- lazy val domains: NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- val errorHandler: ConsoleErrorHandler
determines the control exception thrown on errors
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def featureSet: Set[FeatureFlag]
returns the currently enabled feature sets
- val genericNodeReferencesDoc: String
- Attributes
- protected
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- lazy val grpcAdminCommandRunner: ConsoleGrpcAdminCommandRunner
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def help(cmd: String): Unit
Print detailed help for a top-level item in the top level scope.
- def help(): Unit
Print help for items in the top level scope.
- def helpItems: Seq[Item]
- def helpText(typeName: String, name: String): String
- Attributes
- protected
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfOpenFutures: Boolean
track running futures on shutdown
track running futures on shutdown
set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ConsoleEnvironment → NamedLogging
- def maxSleepMillis: Long
How often to poll to check that all tasks have completed.
How often to poll to check that all tasks have completed.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def mergeLocalInstances(locals: Seq[LocalInstanceReferenceCommon]*): Seq[LocalInstanceReferenceCommon]
- def mergeRemoteInstances(remotes: Seq[InstanceReferenceCommon]*): Seq[InstanceReferenceCommon]
- 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
- lazy val nodes: NodeReferences[InstanceReferenceCommon, InstanceReferenceCommon, LocalInstanceReferenceCommon]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- ConsoleEnvironment → PerformUnlessClosing
- final def onFirstClose(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
- lazy val participantsX: NodeReferences[ParticipantReferenceX, RemoteParticipantReferenceX, LocalParticipantReferenceX]
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part off, because it will result in a deadlock.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, but other tasks may execute concurrently withetf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, but other tasks may execute concurrently withf, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.closeas part off, because it will result in a deadlock.- f
The task to perform
- returns
The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def run[A](result: => ConsoleCommandResult[A]): A
Run a console command.
Run a console command.
- Annotations
- @SuppressWarnings()
- def runE[E, A](result: => Either[E, A]): A
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
- Definition Classes
- OnShutdownRunner
- def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task to run when shutdown is initiated.
Register a task to run when shutdown is initiated.
You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".
- Definition Classes
- OnShutdownRunner
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- def selfAlias(): Bind[_]
So we can we make this available
So we can we make this available
- Attributes
- protected
- def setCommandTimeout(newTimeout: NonNegativeDuration): Unit
- def setLedgerCommandTimeout(newTimeout: NonNegativeDuration): Unit
- def startAll(): Unit
- final val startupOrdering: Ordering[LocalInstanceReferenceCommon]
The order that local nodes would ideally be started in.
- def stopAll(): Unit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- ConsoleEnvironment → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def topLevelValues: Seq[TopLevelValue[_]]
Assemble top level values with their identifier name, value binding, and help description.
Assemble top level values with their identifier name, value binding, and help description.
- Attributes
- protected
- val topicGenericNodeReferences: String
- Attributes
- protected
- val topicNodeReferences: String
- Attributes
- protected
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- def updateFeatureSet(flag: FeatureFlag, include: Boolean): 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])
- object TopLevelValue extends Serializable