Packages

trait ConsoleEnvironment extends NamedLogging with AutoCloseable with NoTracing

The environment in which console commands are evaluated.

Annotations
@SuppressWarnings()
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsoleEnvironment
  2. NoTracing
  3. AutoCloseable
  4. NamedLogging
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type DomainLocalRef <: LocalDomainReference
  2. abstract type DomainRemoteRef <: RemoteDomainReference
  3. abstract type Env <: Environment
  4. abstract type Status <: CantonStatus
  5. 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 help is printed.

    Holder for top level values including their name, their value, and a description to display when help is printed.

    Attributes
    protected

Abstract Value Members

  1. abstract val consoleOutput: ConsoleOutput

    the console for user facing output

  2. 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
  3. abstract def createDomainReference(name: String): DomainLocalRef
    Attributes
    protected
  4. abstract def createRemoteDomainReference(name: String): DomainRemoteRef
    Attributes
    protected
  5. abstract def domainsTopLevelValue(h: Partial, domains: NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]): TopLevelValue[NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]]
    Attributes
    protected
  6. abstract val environment: Env

    the underlying Canton runtime environment

  7. abstract def health: CantonHealthAdministration[Status]
  8. 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
  9. 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
  10. 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
  11. 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
  12. 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

  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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. lazy val bindings: Seq[Bind[_]]

    Bindings for ammonite

    Bindings for ammonite

    Exceptions thrown

    com.digitalasset.canton.config.RequireTypes$.InstanceName$.InvalidInstanceName if nameUnsafe is not a valid instance name. It is up to the caller to fail more gracefully.

    java.lang.IllegalStateException if names are not unique.

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def close(): Unit
    Definition Classes
    ConsoleEnvironment → AutoCloseable
  8. def commandTimeouts: ConsoleCommandTimeout

    returns

    maximum runtime of a console command

  9. lazy val domains: NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. val errorHandler: ConsoleErrorHandler

    determines the control exception thrown on errors

  13. def featureSet: Set[FeatureFlag]

    returns the currently enabled feature sets

  14. val genericNodeReferencesDoc: String
    Attributes
    protected
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. lazy val grpcAdminCommandRunner: ConsoleGrpcAdminCommandRunner
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def help(cmd: String): Unit

    Print detailed help for a top-level item in the top level scope.

  19. def help(): Unit

    Print help for items in the top level scope.

  20. def helpItems: Seq[Item]
  21. def helpText(typeName: String, name: String): String
    Attributes
    protected
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ConsoleEnvironmentNamedLogging
  25. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. def mergeLocalInstances(locals: Seq[LocalInstanceReference]*): Seq[LocalInstanceReference]
  27. def mergeRemoteInstances(remotes: Seq[InstanceReference]*): Seq[InstanceReference]
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. lazy val nodes: NodeReferences[InstanceReference, InstanceReference, LocalInstanceReference]
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
  34. def run[A](result: => ConsoleCommandResult[A]): A

    Run a console command.

    Run a console command.

    Annotations
    @SuppressWarnings()
  35. def selfAlias(): Bind[_]

    So we can we make this available

    So we can we make this available

    Attributes
    protected
  36. def setCommandTimeout(newTimeout: TimeoutDuration): Unit
  37. def startAll(): Unit
  38. final val startupOrdering: Ordering[LocalInstanceReference]

    The order that local nodes would ideally be started in.

  39. def stopAll(): Unit
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. 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
  43. val topicGenericNodeReferences: String
    Attributes
    protected
  44. val topicNodeReferences: String
    Attributes
    protected
  45. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  46. def updateFeatureSet(flag: FeatureFlag, include: Boolean): Unit
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  50. object TopLevelValue extends Serializable

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from NoTracing

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped