class ConsoleEnvironment extends NamedLogging with FlagCloseable with NoTracing
The environment in which console commands are evaluated.
- Annotations
- @SuppressWarnings()
- Alphabetic
- By Inheritance
- ConsoleEnvironment
- NoTracing
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- HasSynchronizeWithClosing
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ConsoleEnvironment(environment: Environment, consoleOutput: ConsoleOutput = StandardConsoleOutput)
Type Members
- case class TopLevelValue[T](nameUnsafe: String, summary: String, value: T, topic: Seq[String] = Seq())(implicit evidence$1: 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
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 addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- val consoleOutput: ConsoleOutput
- def createAdminCommandRunner(consoleEnvironment: ConsoleEnvironment, apiName: String): GrpcAdminCommandRunner
allows for injecting a custom admin command runner during tests
allows for injecting a custom admin command runner during tests
- apiName
API name checked against and expected on the server-side
- Attributes
- protected
- val environment: Environment
- def environmentTimeouts: ProcessingTimeout
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- 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()
- lazy val global_secret_: GlobalSecretKeyAdministration
- lazy val grpcAdminCommandRunner: GrpcAdminCommandRunner
- lazy val grpcLedgerCommandRunner: GrpcAdminCommandRunner
- lazy val grpcSequencerCommandRunner: GrpcAdminCommandRunner
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def health: CantonHealthAdministration
- 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 isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosingand friends.- Definition Classes
- OnShutdownRunner → HasUnlessClosing
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepTrackOfReaderCallStack: Boolean
Set this to true to get detailed information about all futures that did not complete during shutdown.
Set this to true to get detailed information about all futures that did not complete during shutdown.
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ConsoleEnvironment → NamedLogging
- lazy val mediators: NodeReferences[MediatorReference, RemoteMediatorReference, LocalMediatorReference]
- def mergeLocalInstances(locals: Seq[LocalInstanceReference]*): Seq[LocalInstanceReference]
- def mergeRemoteInstances(remotes: Seq[InstanceReference]*): Seq[InstanceReference]
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- 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[InstanceReference, InstanceReference, LocalInstanceReference]
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
- def raiseError(error: String): Nothing
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- def removeReader(handle: ReaderHandle): Unit
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- 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 runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]
Schedules the given task to be run upon closing.
Schedules the given task to be run upon closing.
- returns
An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the
LifeCycleManager'scloseAsyncmethod completes or whenAutoCloseable'sclosemethod returns, unless the returnedLifeCycleRegistrationHandlewas used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.
Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the
LifeCycleManager'scloseAsyncmethod completes orAutoCloseable'sclosereturns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def selfAlias(): Bind[_]
So we can we make this available
So we can we make this available
- Attributes
- protected
- lazy val sequencers: NodeReferences[SequencerReference, RemoteSequencerReference, LocalSequencerReference]
- def setCommandTimeout(newTimeout: NonNegativeDuration): Unit
- def setLedgerCommandTimeout(newTimeout: NonNegativeDuration): Unit
- def startAll(): Unit
- final val startupOrdering: Ordering[LocalInstanceReference]
The order that local nodes would ideally be started in.
- def stopAll(): Unit
- def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise it is the result of runningf.
- Definition Classes
- HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns.Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
- PerformUnlessClosing
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas finished or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run.
- Definition Classes
- HasSynchronizeWithClosing
- Annotations
- @SuppressWarnings()
- See also
HasRunOnClosing.isClosing
- def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise the result of runningf.
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithClosing
- See also
HasRunOnClosing.isClosing
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val 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
- final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
faunless isClosing returns true.Runs the computation
faunless isClosing returns true.This method does not delay the closing while
fais running, unlike the methods inHasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.- returns
The result of
faor com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true
- Definition Classes
- HasUnlessClosing
- Annotations
- @inline()
- def updateFeatureSet(flag: FeatureFlag, include: Boolean): Unit
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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()
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders