c

com.digitalasset.canton.environment

CommunityConsoleEnvironment

class CommunityConsoleEnvironment extends ConsoleEnvironment

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommunityConsoleEnvironment
  2. ConsoleEnvironment
  3. NoTracing
  4. FlagCloseable
  5. PerformUnlessClosing
  6. OnShutdownRunner
  7. AutoCloseable
  8. NamedLogging
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CommunityConsoleEnvironment(environment: CommunityEnvironment, consoleOutput: ConsoleOutput = StandardConsoleOutput)

Type Members

  1. 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
    Definition Classes
    ConsoleEnvironment
  2. type DomainLocalRef = CommunityLocalDomainReference
  3. type DomainRemoteRef = CommunityRemoteDomainReference
  4. type Env = CommunityEnvironment
  5. type Status = CommunityCantonStatus

Value Members

  1. object TopLevelValue extends Serializable
    Definition Classes
    ConsoleEnvironment
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. lazy val bindings: Either[RuntimeException, IndexedSeq[Bind[_]]]

    Bindings for ammonite Add a reference to this instance to resolve implicit references within the console

    Bindings for ammonite Add a reference to this instance to resolve implicit references within the console

    Definition Classes
    ConsoleEnvironment
  7. 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
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  9. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  10. def closeChannels(): Unit
    Definition Classes
    ConsoleEnvironment
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  12. def commandTimeouts: ConsoleCommandTimeout

    returns

    maximum runtime of a console command

    Definition Classes
    ConsoleEnvironment
  13. val consoleEnvironmentBindings: ConsoleEnvironmentBinding
    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  14. def consoleLogger: Logger
    Definition Classes
    ConsoleEnvironment
  15. val consoleOutput: ConsoleOutput

    the console for user facing output

    the console for user facing output

    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  16. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  17. def createAdminCommandRunner(consoleEnvironment: ConsoleEnvironment, apiName: String): ConsoleGrpcAdminCommandRunner

    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
    Definition Classes
    ConsoleEnvironment
  18. def createDomainReference(name: String): DomainLocalRef
    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  19. def createRemoteDomainReference(name: String): DomainRemoteRef
    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  20. lazy val domains: NodeReferences[DomainReference, DomainRemoteRef, DomainLocalRef]
    Definition Classes
    ConsoleEnvironment
  21. def domainsTopLevelValue(h: Partial, domains: NodeReferences[DomainReference, CommunityRemoteDomainReference, CommunityLocalDomainReference]): TopLevelValue[NodeReferences[DomainReference, CommunityRemoteDomainReference, CommunityLocalDomainReference]]
    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  22. val environment: CommunityEnvironment

    the underlying Canton runtime environment

    the underlying Canton runtime environment

    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. val errorHandler: ConsoleErrorHandler

    determines the control exception thrown on errors

    determines the control exception thrown on errors

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

    returns the currently enabled feature sets

    returns the currently enabled feature sets

    Definition Classes
    ConsoleEnvironment
  28. val genericNodeReferencesDoc: String
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  30. lazy val grpcAdminCommandRunner: ConsoleGrpcAdminCommandRunner
    Definition Classes
    ConsoleEnvironment
  31. lazy val grpcDomainCommandRunner: ConsoleGrpcAdminCommandRunner
    Definition Classes
    ConsoleEnvironment
  32. lazy val grpcLedgerCommandRunner: ConsoleGrpcAdminCommandRunner
    Definition Classes
    ConsoleEnvironment
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  34. def health: CantonHealthAdministration[Status]
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
    Annotations
    @Summary(s = "Environment health inspection", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Health")
  35. def help(cmd: String): Unit

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

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

    Definition Classes
    ConsoleEnvironment
  36. def help(): Unit

    Print help for items in the top level scope.

    Print help for items in the top level scope.

    Definition Classes
    ConsoleEnvironment
  37. def helpItems: Seq[Item]
    Definition Classes
    ConsoleEnvironment
  38. def helpText(typeName: String, name: String): String
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment
  39. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  40. 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 performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  41. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  42. 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
  43. def localDomainHelpItems(scope: Set[FeatureFlag], localDomain: CommunityLocalDomainReference): Seq[Item]

    Generate implementation specific help items for local domains

    Generate implementation specific help items for local domains

    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  44. def localDomainTopLevelValue(h: Partial, d: CommunityLocalDomainReference): TopLevelValue[CommunityLocalDomainReference]

    Supply the local domain value used by the implementation

    Supply the local domain value used by the implementation

    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  45. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  46. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    ConsoleEnvironmentNamedLogging
  47. 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
  48. def mergeLocalInstances(locals: Seq[LocalInstanceReferenceCommon]*): Seq[LocalInstanceReferenceCommon]
    Definition Classes
    ConsoleEnvironment
  49. def mergeRemoteInstances(remotes: Seq[InstanceReferenceCommon]*): Seq[InstanceReferenceCommon]
    Definition Classes
    ConsoleEnvironment
  50. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  53. lazy val nodes: NodeReferences[InstanceReferenceCommon, InstanceReferenceCommon, LocalInstanceReferenceCommon]
    Definition Classes
    ConsoleEnvironment
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  56. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  57. def onClosed(): Unit
  58. 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  59. lazy val participants: NodeReferences[ParticipantReference, RemoteParticipantReference, LocalParticipantReference]
    Definition Classes
    ConsoleEnvironment
  60. 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
    PerformUnlessClosing
  61. 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
  62. 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
    PerformUnlessClosing
  63. 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
  64. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  65. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  66. 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
    PerformUnlessClosing
  67. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  68. def remoteDomainHelpItems(scope: Set[FeatureFlag], remoteDomain: CommunityRemoteDomainReference): Seq[Item]

    Generate implementation specific help items for remote domains

    Generate implementation specific help items for remote domains

    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  69. def remoteDomainTopLevelValue(h: Partial, d: CommunityRemoteDomainReference): TopLevelValue[CommunityRemoteDomainReference]

    Supply the remote domain value used by the implementation

    Supply the remote domain value used by the implementation

    Attributes
    protected
    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  70. def run[A](result: => ConsoleCommandResult[A]): A

    Run a console command.

    Run a console command.

    Definition Classes
    ConsoleEnvironment
    Annotations
    @SuppressWarnings()
  71. def runE[E, A](result: => Either[E, A]): A
    Definition Classes
    ConsoleEnvironment
  72. 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
  73. 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
  74. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  75. def selfAlias(): Bind[_]

    So we can we make this available

    So we can we make this available

    Attributes
    protected
    Definition Classes
    ConsoleEnvironment
  76. def setCommandTimeout(newTimeout: NonNegativeDuration): Unit
    Definition Classes
    ConsoleEnvironment
  77. def setLedgerCommandTimeout(newTimeout: NonNegativeDuration): Unit
    Definition Classes
    ConsoleEnvironment
  78. def startAll(): Unit
    Definition Classes
    ConsoleEnvironment
  79. 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.

    Definition Classes
    CommunityConsoleEnvironmentConsoleEnvironment
  80. final val startupOrdering: Ordering[LocalInstanceReferenceCommon]

    The order that local nodes would ideally be started in.

    The order that local nodes would ideally be started in.

    Definition Classes
    ConsoleEnvironment
  81. def stopAll(): Unit
    Definition Classes
    ConsoleEnvironment
  82. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  83. def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    ConsoleEnvironmentFlagCloseable
  84. def toString(): String
    Definition Classes
    AnyRef → Any
  85. 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
    Definition Classes
    ConsoleEnvironment
  86. val topicGenericNodeReferences: String
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment
  87. val topicNodeReferences: String
    Attributes
    protected
    Definition Classes
    ConsoleEnvironment
  88. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  89. def updateFeatureSet(flag: FeatureFlag, include: Boolean): Unit
    Definition Classes
    ConsoleEnvironment
  90. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  91. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  92. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from ConsoleEnvironment

Inherited from NoTracing

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped