Packages

class DirectSequencerClientTransport extends SequencerClientTransport with SequencerClientTransportPekko with NamedLogging

This transport is meant to be used to create a sequencer client that connects directly to an in-process sequencer. Needed for cases when the sequencer node itself needs to listen to specific events such as identity events.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DirectSequencerClientTransport
  2. NamedLogging
  3. SequencerClientTransportPekko
  4. SequencerClientTransport
  5. SequencerClientTransportCommon
  6. FlagCloseable
  7. PerformUnlessClosing
  8. HasSynchronizeWithReaders
  9. HasSynchronizeWithClosing
  10. OnShutdownRunner
  11. HasRunOnClosing
  12. HasUnlessClosing
  13. AutoCloseable
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DirectSequencerClientTransport(sequencer: Sequencer, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory, protocolVersion: ProtocolVersion)(implicit materializer: Materializer, ec: ExecutionContext)

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(request: SignedContent[AcknowledgeRequest])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Boolean]

    Acknowledge that we have successfully processed all events up to and including the given timestamp.

    Acknowledge that we have successfully processed all events up to and including the given timestamp. The client should then never subscribe for events from before this point.

    returns

    True if acknowledgement succeeded, false if sequencer was unavailable

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransportCommon
  5. def addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. 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
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  10. def downloadTopologyStateForInit(request: TopologyStateForInitRequest)(implicit traceContext: TraceContext): EitherT[Future, String, TopologyStateForInitResponse]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. def getTrafficStateForMember(request: GetTrafficStateForMemberRequest)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, GetTrafficStateForMemberResponse]
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. 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
    OnShutdownRunnerHasUnlessClosing
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  20. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DirectSequencerClientTransportNamedLogging
  22. def logout()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, Status, Unit]

    Revoke all the authentication tokens on this sequencer and close the connection.

    Revoke all the authentication tokens on this sequencer and close the connection.

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransportCommon
  23. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  24. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  28. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  29. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  30. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  31. 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
  32. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  33. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  34. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  35. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  36. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  37. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  38. def sendAsyncSigned(request: SignedContent[SubmissionRequest], timeout: Duration)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SendAsyncClientResponseError, Unit]

    Sends a signed submission request to the sequencer.

    Sends a signed submission request to the sequencer. If we failed to make the request, an error will be returned. If the sequencer accepted (or may have accepted) the request this call will return successfully.

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransportCommon
  39. def subscribe(request: SubscriptionRequest)(implicit traceContext: TraceContext): SequencerSubscriptionPekko[SubscriptionError]

    Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request.

    Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request. The transport is not expected to provide retries of subscriptions.

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransportPekko
  40. def subscribe[E](request: SubscriptionRequest, handler: SequencedEventHandler[E])(implicit traceContext: TraceContext): SequencerSubscription[E]

    Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request.

    Create a single subscription to read events from the Sequencer for this member starting from the counter defined in the request. Transports are currently responsible for calling the supplied handler. The handler must not be called concurrently and must receive events in-order. If the handler fails with an exception the subscription should close with a com.digitalasset.canton.sequencing.client.SubscriptionCloseReason.HandlerError. If the subscription fails for a technical reason it should close with a com.digitalasset.canton.sequencing.client.SubscriptionCloseReason.SubscriptionError. The transport is not expected to provide retries of subscriptions.

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransport
  41. def subscriptionRetryPolicy: SubscriptionErrorRetryPolicy

    The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription

    The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransport
  42. def subscriptionRetryPolicyPekko: SubscriptionErrorRetryPolicyPekko[SubscriptionError]

    The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription

    The transport can decide which errors will cause the sequencer client to not try to reestablish a subscription

    Definition Classes
    DirectSequencerClientTransportSequencerClientTransportPekko
  43. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  44. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  45. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  46. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  47. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  48. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  49. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  50. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DirectSequencerClientTransportFlagCloseable
  51. def toString(): String
    Definition Classes
    AnyRef → Any
  52. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  53. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  54. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

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

    (Since version 9)

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped