Packages

  • package root
    Definition Classes
    root
  • package com
    Definition Classes
    root
  • package digitalasset
    Definition Classes
    com
  • package canton
    Definition Classes
    digitalasset
  • package domain
    Definition Classes
    canton
  • package sequencing
    Definition Classes
    domain
  • package sequencer
    Definition Classes
    sequencing
  • package errors
    Definition Classes
    sequencer
  • object SequencerError extends SequencerErrorGroup
    Definition Classes
    errors
  • object ExceededMaxSequencingTime extends ErrorCode
    Definition Classes
    SequencerError
    Annotations
    @Explanation(explanation = """
    |This error indicates that a request was not sequenced because the sequencing time would exceed the
    |max-sequencing-time of the request. This error usually happens if either a participant or mediator node is too
    |slowly responding to requests, or if it is catching up after some downtime. In rare cases, it can happen
    |if the sequencer nodes are massively overloaded.
    |
    |If it happens repeatedly, this information might indicate that there is a problem with the respective participant
    |or mediator node.
    |"""
    )
    @Resolution(resolution = """Inspect the time difference between sequenced and max-sequencing-time. If the time difference is large,
    |then some remote node is catching up but sending messages during catch-up. If the difference is not too large,
    |then the submitting node or this sequencer node might be overloaded."""
    )
  • Error

final case class Error(ts: CantonTimestamp, maxSequencingTime: CantonTimestamp, message: String) extends Impl with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Error
  2. Serializable
  3. Product
  4. Equals
  5. Impl
  6. BaseCantonError
  7. BaseError
  8. LocationMixin
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Error(ts: CantonTimestamp, maxSequencingTime: CantonTimestamp, message: String)

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. def asGoogleGrpcStatus(implicit loggingContext: ErrorLoggingContext): Status
    Definition Classes
    BaseCantonError
  5. def asGrpcError(implicit loggingContext: ErrorLoggingContext): StatusRuntimeException
    Definition Classes
    BaseCantonError
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val cause: String

    A human readable string indicating the error

    A human readable string indicating the error

    Definition Classes
    ImplBaseError
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. implicit val code: ErrorCode

    The error code, usually passed in as implicit where the error class is defined

    The error code, usually passed in as implicit where the error class is defined

    Definition Classes
    ImplBaseError
  10. def context: Map[String, String]

    The context (declared fields) of this error

    The context (declared fields) of this error

    Definition Classes
    BaseCantonErrorBaseError
  11. def definiteAnswerO: Option[Boolean]

    Controls whether a definite_answer error detail is added to the gRPC status code

    Controls whether a definite_answer error detail is added to the gRPC status code

    Definition Classes
    BaseError
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. val location: Option[String]

    Contains the location where the error has been created.

    Contains the location where the error has been created.

    Definition Classes
    LocationMixin
  16. def log()(implicit loggingContext: ErrorLoggingContext): Unit
    Definition Classes
    BaseCantonError
  17. def logWithContext(extra: Map[String, String] = Map())(implicit contextualizedErrorLogger: ContextualizedErrorLogger): Unit
    Definition Classes
    BaseError
  18. val maxSequencingTime: CantonTimestamp
  19. val message: String
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. def resources: Seq[(ErrorResource, String)]

    The resources related to this error

    The resources related to this error

    We return the set of resources via com.google.rpc.ResourceInfo. Override this method in order to return resource information via com.google.rpc.Status

    Definition Classes
    BaseError
  25. def retryable: Option[ErrorCategoryRetry]

    Returns retryability information of this particular error

    Returns retryability information of this particular error

    In some cases, error instances would like to provide custom retry intervals. This can be achieved by locally overriding this method.

    Do not use this to change the contract of the error categories. Non-retryable errors shouldn't be made retryable. Only use it for adjusting the retry intervals.

    Definition Classes
    BaseError
  26. def rpcStatus(overrideCode: Option[Code] = None)(implicit loggingContext: ContextualizedErrorLogger): Status
    Definition Classes
    BaseError
  27. def rpcStatusWithoutLoggingContext(): Status
    Definition Classes
    BaseCantonError
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. val throwableO: Option[Throwable]

    An optional argument to log exceptions

    An optional argument to log exceptions

    If you want to log an exception as part of your error, then use the following example:

    object MyCode extends ErrorCode(id="SUPER_DUPER_ERROR") { case class MyError(someString: String, throwable: Throwable) extends SomeInternalError( cause = "Something failed with an exception bla", throwableO = Some(throwable) ) }

    NOTE: This throwable's details are not included the exception communicated to the gRPC clients so if you want them communicated, you need to explicitly add them to the e.g. context map or cause string.

    Definition Classes
    ImplBaseError
  30. val ts: CantonTimestamp
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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 Serializable

Inherited from Product

Inherited from Equals

Inherited from Impl

Inherited from BaseCantonError

Inherited from BaseError

Inherited from LocationMixin

Inherited from AnyRef

Inherited from Any

Ungrouped