Packages

object resources extends Helpful

Annotations
@Summary(s = "Functionality for managing resources", flag = console.this.Help.Summary.<init>$default$2) @Group(name = "Resource Management")
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. resources
  2. Helpful
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

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. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  11. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def resource_limits(): ResourceLimits
    Annotations
    @Summary(s = "Get the resource limits of the participant.", flag = console.this.Help.Summary.<init>$default$2)
  17. def set_resource_limits(limits: ResourceLimits): Unit
    Annotations
    @Summary(s = "Set resource limits for the participant.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """While a resource limit is attained or exceeded, the participant will reject any additional submission with GRPC status ABORTED.
    |Most importantly, a submission will be rejected **before** it consumes a significant amount of resources.
    |
    |There are two kinds of limits: `max_dirty_requests` and `max_rate`.
    |The number of dirty requests of a participant P covers (1) requests initiated by P as well as
    |(2) requests initiated by participants other than P that need to be validated by P.
    |Compared to the maximum rate, the maximum number of dirty requests reflects the load on the participant more accurately.
    |However, the maximum number of dirty requests alone does not protect the system from "bursts":
    |If an application submits a huge number of commands at once, the maximum number of dirty requests will likely be exceeded.
    |
    |The maximum rate is a hard limit on the rate of commands submitted to this participant through the ledger API.
    |As the rate of commands is checked and updated immediately after receiving a new command submission,
    |an application cannot exceed the maximum rate, even when it sends a "burst" of commands.
    |
    |To determine a suitable value for `max_dirty_requests`, you should test the system under high load.
    |If you choose a higher value, throughput may increase, as more commands are validated in parallel.
    |If you observe a high latency (time between submission and observing a command completion)
    |or even command timeouts, you should choose a lower value.
    |Once a suitable value for `max_dirty_requests` has been found, you should include "bursts" into the tests
    |to also find a suitable value for `max_rate`.
    |
    |Resource limits can only be changed, if the server runs Canton enterprise.
    |In the community edition, the server uses fixed limits that cannot be changed."""
    )
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  22. 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

Inherited from Helpful

Inherited from AnyRef

Inherited from Any

Ungrouped