trait ConsoleEnvironment extends NamedLogging with AutoCloseable with NoTracing
The environment in which console commands are evaluated.
- Annotations
- @SuppressWarnings()
- Alphabetic
- By Inheritance
- ConsoleEnvironment
- NoTracing
- 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 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: LocalInstanceReference): 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: Seq[Bind[_]]
Bindings for ammonite
Bindings for ammonite
- Exceptions thrown
com.digitalasset.canton.config.RequireTypes$.InstanceName$.InvalidInstanceNameifnameUnsafeis not a valid instance name. It is up to the caller to fail more gracefully.java.lang.IllegalStateExceptionif names are not unique.
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def close(): Unit
- Definition Classes
- ConsoleEnvironment → AutoCloseable
- def commandTimeouts: ConsoleCommandTimeout
- returns
maximum runtime of a console command
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ConsoleEnvironment → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def mergeLocalInstances(locals: Seq[LocalInstanceReference]*): Seq[LocalInstanceReference]
- def mergeRemoteInstances(remotes: Seq[InstanceReference]*): Seq[InstanceReference]
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
- def run[A](result: => ConsoleCommandResult[A]): A
Run a console command.
Run a console command.
- Annotations
- @SuppressWarnings()
- def selfAlias(): Bind[_]
So we can we make this available
So we can we make this available
- Attributes
- protected
- def setCommandTimeout(newTimeout: TimeoutDuration): Unit
- def startAll(): Unit
- final val startupOrdering: Ordering[LocalInstanceReference]
The order that local nodes would ideally be started in.
- def stopAll(): Unit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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