Packages

trait ConsoleEnvironment extends NamedLogging with FlagCloseable with NoTracing

The environment in which console commands are evaluated.

Annotations
@SuppressWarnings()
Linear Supertypes
NoTracing, FlagCloseable, AutoCloseable, NamedLogging, AnyRef, Any
Known Subclasses
EnterpriseConsoleEnvironment, CommunityConsoleEnvironment
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsoleEnvironment
  2. NoTracing
  3. FlagCloseable
  4. AutoCloseable
  5. NamedLogging
  6. AnyRef
  7. 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
  6. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Abstract Value Members

  1. abstract def consoleEnvironmentBindings: ConsoleEnvironmentBinding
    Attributes
    protected
  2. abstract val consoleOutput: ConsoleOutput

    the console for user facing output

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

    the underlying Canton runtime environment

  8. abstract def health: CantonHealthAdministration[Status]
  9. 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
  10. 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
  11. 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
  12. 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
  13. 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.CantonRequireTypes$.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. 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 → AutoCloseable
    Annotations
    @SuppressWarnings()
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  9. def commandTimeouts: ConsoleCommandTimeout

    returns

    maximum runtime of a console command

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

    determines the control exception thrown on errors

  15. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  16. def featureSet: Set[FeatureFlag]

    returns the currently enabled feature sets

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

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

  22. def help(): Unit

    Print help for items in the top level scope.

  23. def helpItems: Seq[Item]
  24. def helpText(typeName: String, name: String): String
    Attributes
    protected
  25. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  26. 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 performUnlessClosing and friends.

    Definition Classes
    FlagCloseable
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. 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
    FlagCloseable
  29. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  30. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment → NamedLogging
  31. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  32. def mergeLocalInstances(locals: Seq[LocalInstanceReference]*): Seq[LocalInstanceReference]
  33. def mergeRemoteInstances(remotes: Seq[InstanceReference]*): Seq[InstanceReference]
  34. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. lazy val nodes: NodeReferences[InstanceReference, InstanceReference, LocalInstanceReference]
  38. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. def onClosed(): Unit
    Definition Classes
    ConsoleEnvironment → FlagCloseable
  41. lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
  42. def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, 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.close as part of f, 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
    FlagCloseable
  43. 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
    FlagCloseable
  44. 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 etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, 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.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  45. 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
    FlagCloseable
  46. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  47. def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, 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.close as part of f, 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
    FlagCloseable
  48. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  49. def run[A](result: => ConsoleCommandResult[A]): A

    Run a console command.

    Run a console command.

    Annotations
    @SuppressWarnings()
  50. 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
    FlagCloseable
  51. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  52. def selfAlias(): Bind[_]

    So we can we make this available

    So we can we make this available

    Attributes
    protected
  53. def setCommandTimeout(newTimeout: NonNegativeDuration): Unit
  54. def setLedgerCommandTimeout(newTimeout: NonNegativeDuration): Unit
  55. def startAll(): Unit
  56. final val startupOrdering: Ordering[LocalInstanceReference]

    The order that local nodes would ideally be started in.

  57. def stopAll(): Unit
  58. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  59. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment → FlagCloseable
  60. def toString(): String
    Definition Classes
    AnyRef → Any
  61. 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
  62. val topicGenericNodeReferences: String
    Attributes
    protected
  63. val topicNodeReferences: String
    Attributes
    protected
  64. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  65. def updateFeatureSet(flag: FeatureFlag, include: Boolean): Unit
  66. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  67. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  68. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. object TopLevelValue extends Serializable
  70. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable

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 FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped