class SequencerClientImpl extends SequencerClient with FlagCloseableAsync with NamedLogging with HasFlushFuture with Spanning with HasCloseContext

The sequencer client facilitates access to the individual domain sequencer. A client centralizes the message signing operations, as well as the handling and storage of message receipts and delivery proofs, such that this functionality does not have to be duplicated throughout the participant node.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SequencerClientImpl
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. Spanning
  5. HasFlushFuture
  6. NamedLogging
  7. FlagCloseableAsync
  8. SequencerClient
  9. FlagCloseable
  10. PerformUnlessClosing
  11. OnShutdownRunner
  12. AutoCloseable
  13. SequencerClientSend
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SequencerClientImpl(domainId: DomainId, member: Member, sequencerTransports: SequencerTransports, config: SequencerClientConfig, testingConfig: TestingConfigInternal, protocolVersion: ProtocolVersion, domainParametersLookup: DomainParametersLookup[SequencerDomainParameters], timeouts: ProcessingTimeout, eventValidatorFactory: SequencedEventValidatorFactory, clock: Clock, requestSigner: RequestSigner, sequencedEventStore: SequencedEventStore, sendTracker: SendTracker, metrics: SequencerClientMetrics, recorderO: Option[SequencerClientRecorder], replayEnabled: Boolean, cryptoPureApi: CryptoPureApi, loggingConfig: LoggingConfig, loggerFactory: NamedLoggerFactory, futureSupervisor: FutureSupervisor, initialCounterLowerBound: SequencerCounter)(implicit executionContext: ExecutionContext, tracer: Tracer)

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 acknowledgeSigned(timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
    Definition Classes
    SequencerClientImplSequencerClient
  5. def addToFlushAndLogError(name: String)(future: Future[_])(implicit loggingContext: ErrorLoggingContext): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. Logs an error if the future fails with an exception.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  6. def addToFlushWithoutLogging(name: String)(future: Future[_]): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. The caller is responsible for logging any exceptions thrown inside the future.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. 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
  9. def changeTransport(sequencerTransports: SequencerTransports)(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    SequencerClientImplSequencerClient
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  11. 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
  12. def closeAsync(): Seq[AsyncOrSyncCloseable]

    closeAsync asynchronously releases resources held by a future

    closeAsync asynchronously releases resources held by a future

    returns

    an ordered sequence of async and sync closeables with async closeables made up of future and timeout

    Attributes
    protected
    Definition Classes
    SequencerClientImplFlagCloseableAsync
  13. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  14. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  15. def completion: Future[CloseReason]

    Future which is completed when the client is not functional any more and is ready to be closed.

    Future which is completed when the client is not functional any more and is ready to be closed. The value with which the future is completed will indicate the reason for completion.

    Definition Classes
    SequencerClientImplSequencerClient
  16. val config: SequencerClientConfig
  17. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  18. def doFlush(): Future[Unit]

    Returns a future that completes after all added futures have completed.

    Returns a future that completes after all added futures have completed. The returned future never fails.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  19. val domainId: DomainId
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. def flush(): Future[Unit]

    Returns a future that completes after asynchronous processing has completed for all events whose synchronous processing has been completed prior to this call.

    Returns a future that completes after asynchronous processing has completed for all events whose synchronous processing has been completed prior to this call. May complete earlier if event processing has failed.

    Definition Classes
    SequencerClientImplSequencerClient
    Annotations
    @VisibleForTesting()
  24. def flushCloseable(name: String, timeout: NonNegativeDuration): SyncCloseable
    Attributes
    protected
    Definition Classes
    HasFlushFuture
  25. def generateMaxSequencingTime: CantonTimestamp

    Provides a value for max-sequencing-time to use for sendAsync if no better application provided timeout is available.

    Provides a value for max-sequencing-time to use for sendAsync if no better application provided timeout is available. Is currently a configurable offset from our clock.

    Definition Classes
    SequencerClientImplSequencerClientSend
  26. def generateMessageId: MessageId

    Generates a message id.

    Generates a message id. The message id is only for correlation within this client and does not need to be globally unique.

    Definition Classes
    SequencerClientImplSequencerClientSend
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  28. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  29. val healthComponent: CloseableHealthComponent
    Definition Classes
    SequencerClientImplSequencerClient
  30. val initialCounterLowerBound: SequencerCounter

    The sequencer counter at which the first subscription starts

    The sequencer counter at which the first subscription starts

    Attributes
    protected
    Definition Classes
    SequencerClientImplSequencerClient
  31. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  32. 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
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. 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
  35. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. val loggerFactory: NamedLoggerFactory
    Definition Classes
    SequencerClientImplNamedLogging
  37. 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
  38. val member: Member
  39. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  40. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  45. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  46. final def onClosed(): Unit
  47. 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()
  48. 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
  49. 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
  50. 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
  51. 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
  52. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  53. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  54. 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
  55. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  56. val protocolVersion: ProtocolVersion
  57. val requestSigner: RequestSigner
  58. 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
  59. 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
  60. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  61. def sendAsync(batch: Batch[DefaultOpenEnvelope], sendType: SendType = SendType.Other, timestampOfSigningKey: Option[CantonTimestamp] = None, maxSequencingTime: CantonTimestamp = generateMaxSequencingTime, messageId: MessageId = generateMessageId, callback: SendCallback = SendCallback.empty)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]

    Sends a request to sequence a deliver event to the sequencer.

    Sends a request to sequence a deliver event to the sequencer. If we fail to make the request to the sequencer and are certain that it was not received by the sequencer an error is returned. In this circumstance it is safe for the caller to retry the request without causing a duplicate request. A successful response however does not mean that the request will be successfully sequenced. Instead the caller must subscribe to the sequencer and can observe one of the following outcomes:

    1. A deliver event is sequenced with a messageId matching this send. 2. A deliver error is sequenced with a messageId matching this send. 3. The sequencing time progresses beyond the provided max-sequencing-time. The caller can assume that the send will now never be sequenced. Callers should be aware that a message-id can be reused once one of these outcomes is observed so cannot assume that an event with a matching message-id at any point in the future matches their send. Use the sendTracker to aid tracking timeouts for events (if useful this could be enriched in the future to provide send completion callbacks alongside the existing timeout notifications). For convenience callers can provide a callback that the SendTracker will invoke when the outcome of the send is known. However this convenience comes with significant limitations that a caller must understand:
    • the callback has no ability to be persisted so will be lost after a restart or recreation of the SequencerClient
    • the callback is called by the send tracker while handling an event from a SequencerSubscription. If the callback returns an error this will be returned to the underlying subscription handler and shutdown the sequencer client. If handlers do not want to halt the sequencer subscription errors should be appropriately handled (particularly logged) and a successful value returned from the callback.
    • If witnessing an event causes many prior sends to timeout there is no guaranteed order in which the callbacks of these sends will be notified.
    • If replay is enabled, the callback will be called immediately with a fake SendResult. For more robust send result tracking callers should persist metadata about the send they will make and monitor the sequenced events when read, so actions can be taken even if in-memory state is lost.
    Definition Classes
    SequencerClientImplSequencerClientSend
  62. def sendAsyncUnauthenticated(batch: Batch[DefaultOpenEnvelope], sendType: SendType = SendType.Other, maxSequencingTime: CantonTimestamp = generateMaxSequencingTime, messageId: MessageId = generateMessageId, callback: SendCallback = SendCallback.empty)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]

    Does the same as sendAsync, except that this method is supposed to be used only by unauthenticated members for very specific operations that do not require authentication such as requesting that a participant's topology data gets accepted by the topology manager

    Does the same as sendAsync, except that this method is supposed to be used only by unauthenticated members for very specific operations that do not require authentication such as requesting that a participant's topology data gets accepted by the topology manager

    Definition Classes
    SequencerClientImplSequencerClient
  63. def sendAsyncUnauthenticatedOrNot(batch: Batch[DefaultOpenEnvelope], sendType: SendType = SendType.Other, timestampOfSigningKey: Option[CantonTimestamp] = None, maxSequencingTime: CantonTimestamp = generateMaxSequencingTime, messageId: MessageId = generateMessageId, callback: SendCallback = SendCallback.empty)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]

    Sends a request to sequence a deliver event to the sequencer.

    Sends a request to sequence a deliver event to the sequencer. This method merely dispatches to one of the other methods (sendAsync or sendAsyncUnauthenticated) depending if member is Authenticated or Unauthenticated.

    Definition Classes
    SequencerClientImplSequencerClient
  64. def snapshotIncomplete: Seq[String]

    Returns the list of currently incomplete tasks.

    Returns the list of currently incomplete tasks. Use only for inspection and debugging.

    Definition Classes
    HasFlushFuture
  65. def subscribeAfter(priorTimestamp: CantonTimestamp, cleanPreheadTsO: Option[CantonTimestamp], eventHandler: PossiblyIgnoredApplicationHandler[ClosedEnvelope], timeTracker: DomainTimeTracker, fetchCleanTimestamp: FetchCleanTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    Create a subscription for sequenced events for this member, starting after the last event in the com.digitalasset.canton.store.SequencedEventStore up to priorTimestamp.

    Create a subscription for sequenced events for this member, starting after the last event in the com.digitalasset.canton.store.SequencedEventStore up to priorTimestamp. A sequencer client can only have a single subscription - additional subscription attempts will throw an exception. When an event is received, we will check the pending sends and invoke the provided call-backs with the send result (which can be deliver or timeout) before invoking the eventHandler.

    If the com.digitalasset.canton.store.SequencedEventStore contains events after priorTimestamp, the handler is first fed with these events before the subscription is established, starting at the last event found in the com.digitalasset.canton.store.SequencedEventStore.

    priorTimestamp

    The timestamp of the event prior to where the event processing starts. If scala.None$, the subscription starts at the com.digitalasset.canton.data.CounterCompanion.Genesis.

    cleanPreheadTsO

    The timestamp of the clean prehead sequencer counter, if known.

    eventHandler

    A function handling the events.

    timeTracker

    Tracker for operations requiring the current domain time. Only updated with received events and not previously stored events.

    fetchCleanTimestamp

    A function for retrieving the latest clean timestamp to use for periodic acknowledgements

    returns

    The future completes after the subscription has been established or when an error occurs before that. In particular, synchronous processing of events from the com.digitalasset.canton.store.SequencedEventStore runs before the future completes.

    Definition Classes
    SequencerClientImplSequencerClient
  66. def subscribeAfterUnauthenticated(priorTimestamp: CantonTimestamp, eventHandler: PossiblyIgnoredApplicationHandler[ClosedEnvelope], timeTracker: DomainTimeTracker)(implicit traceContext: TraceContext): Future[Unit]

    Does the same as subscribeAfter, except that this method is supposed to be used only by unauthenticated members

    Does the same as subscribeAfter, except that this method is supposed to be used only by unauthenticated members

    The method does not verify the signature of the server.

    Definition Classes
    SequencerClientImplSequencerClient
  67. def subscribeTracking(sequencerCounterTrackerStore: SequencerCounterTrackerStore, eventHandler: PossiblyIgnoredApplicationHandler[ClosedEnvelope], timeTracker: DomainTimeTracker, onCleanHandler: (Traced[SequencerCounterCursorPrehead]) => Unit = _ => ())(implicit traceContext: TraceContext): Future[Unit]

    Create a subscription for sequenced events for this member, starting after the prehead in the sequencerCounterTrackerStore.

    Create a subscription for sequenced events for this member, starting after the prehead in the sequencerCounterTrackerStore.

    The eventHandler is monitored by com.digitalasset.canton.sequencing.handlers.CleanSequencerCounterTracker so that the sequencerCounterTrackerStore advances the prehead when (a batch of) events has been successfully processed by the eventHandler (synchronously and asynchronously).

    Definition Classes
    SequencerClientImplSequencerClient
    See also

    subscribe for the description of the eventHandler and the timeTracker

  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. val timeouts: ProcessingTimeout
    Definition Classes
    SequencerClientImplFlagCloseable
  70. def toString(): String
    Definition Classes
    AnyRef → Any
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  73. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. def waitForHandlerToComplete(): Unit
  75. def withNewTrace[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  76. def withSpan[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit traceContext: TraceContext, tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning
  77. def withSpanFromGrpcContext[A](description: String)(f: (TraceContext) => (SpanWrapper) => A)(implicit tracer: Tracer): A
    Attributes
    protected
    Definition Classes
    Spanning

Deprecated Value Members

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

Inherited from HasCloseContext

Inherited from Spanning

Inherited from HasFlushFuture

Inherited from NamedLogging

Inherited from FlagCloseableAsync

Inherited from SequencerClient

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from SequencerClientSend

Inherited from AnyRef

Inherited from Any

Ungrouped