com.digitalasset.canton.sequencing.client.transports.replay
ReplayingSendsSequencerClientTransportImpl
class ReplayingSendsSequencerClientTransportImpl extends ReplayingSendsSequencerClientTransportCommon with SequencerClientTransport with SequencerClientTransportPekko
- Alphabetic
- By Inheritance
- ReplayingSendsSequencerClientTransportImpl
- SequencerClientTransportPekko
- SequencerClientTransport
- ReplayingSendsSequencerClientTransportCommon
- FlagCloseableAsync
- NoTracing
- NamedLogging
- ReplayingSendsSequencerClientTransport
- SequencerClientTransportCommon
- FlagCloseable
- PerformUnlessClosing
- HasSynchronizeWithReaders
- OnShutdownRunner
- HasRunOnClosing
- HasUnlessClosing
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ReplayingSendsSequencerClientTransportImpl(protocolVersion: ProtocolVersion, recordedPath: Path, replaySendsConfig: SequencerSends, member: Member, underlyingTransport: SequencerClientTransport with SequencerClientTransportPekko, requestSigner: RequestSigner, metrics: SequencerClientMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext, materializer: Materializer)
Type Members
- type SubscriptionError = (underlyingTransport)#SubscriptionError
- Definition Classes
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransportPekko
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- 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
- ReplayingSendsSequencerClientTransportCommon → SequencerClientTransportCommon
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- 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
- FlagCloseable → OnShutdownRunner → AutoCloseable
- 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
- ReplayingSendsSequencerClientTransportCommon → FlagCloseableAsync
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def downloadTopologyStateForInit(request: TopologyStateForInitRequest)(implicit traceContext: TraceContext): EitherT[Future, String, TopologyStateForInitResponse]
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → SequencerClientTransportCommon
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getTrafficStateForMember(request: GetTrafficStateForMemberRequest)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, GetTrafficStateForMemberResponse]
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → SequencerClientTransportCommon
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- 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 → HasUnlessClosing
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- PerformUnlessClosing → HasSynchronizeWithReaders
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → NamedLogging
- 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
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransportCommon
- 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
- def metricReport(snapshot: Seq[MetricData]): String
Dump the submission related metrics into a string for periodic reporting during the replay test
Dump the submission related metrics into a string for periodic reporting during the replay test
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → ReplayingSendsSequencerClientTransport
- def nameInternal: String
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- final def onClosed(): Unit
- Definition Classes
- FlagCloseableAsync → PerformUnlessClosing
- 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
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- PerformUnlessClosing
- 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
- def performUnlessClosingCheckedUST[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[FutureUnlessShutdown, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[FutureUnlessShutdown, A, N, R]
- Definition Classes
- PerformUnlessClosing
- 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. Bothetf
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 afteretf
completes, but other tasks may execute concurrently withetf
, 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 ofetf
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSFAsync[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(asyncResultToWaitForF: (R) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.
Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.
- etf
closing of this object will wait for all such spawned Futures to finish
- asyncResultToWaitForF
closing of this object will wait also wait for all such asynchronous Futures to finish too
- returns
the future spawned by etf
- Definition Classes
- PerformUnlessClosing
- 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 afterf
completes, but other tasks may execute concurrently withf
, 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 off
, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef
.- 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
- def performUnlessClosingOptionUSF[R](name: String)(otf: => OptionT[FutureUnlessShutdown, R])(implicit ec: ExecutionContext, traceContext: TraceContext): OptionT[FutureUnlessShutdown, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingUSFAsync[A](name: String)(f: => FutureUnlessShutdown[A])(asyncResultToWaitForF: (A) => FutureUnlessShutdown[_])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.
Use this method if closing/shutdown of the object should wait for asynchronous computation to finish too.
- f
closing of this object will wait for all such spawned Futures to finish
- asyncResultToWaitForF
closing of this object will wait also wait for all such asynchronous Futures to finish too
- returns
the future spawned by f
- Definition Classes
- PerformUnlessClosing
- def remainingReaders(): Seq[String]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- 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
- def replay(sendParallelism: Int): Future[SendReplayReport]
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → ReplayingSendsSequencerClientTransport
- 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
'scloseAsync
method completes or whenAutoCloseable
'sclose
method returns, unless the returnedLifeCycleRegistrationHandle
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
- OnShutdownRunner → HasRunOnClosing
- 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
'scloseAsync
method completes orAutoCloseable
'sclose
returns. This is because the task is run immediately if the component has already been closed.- Definition Classes
- HasRunOnClosing
- final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.
- Definition Classes
- HasRunOnClosing
- def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
- Attributes
- protected[this]
- Definition Classes
- OnShutdownRunner → HasRunOnClosing
- def sendAsyncSigned(request: SignedContent[SubmissionRequest], timeout: Duration)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, SendAsyncClientResponseError, Unit]
We're replaying sends so shouldn't allow the app to send any new ones
We're replaying sends so shouldn't allow the app to send any new ones
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → SequencerClientTransportCommon
- def subscribe(request: SubscriptionRequestV2)(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
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransportPekko
- def subscribe(request: SubscriptionRequestV2, handler: SequencedEventHandler[NotUsed]): AutoCloseable
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransportImpl → ReplayingSendsSequencerClientTransportCommon
- def subscribe[E](request: SubscriptionRequestV2, 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
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransport
- 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
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransport
- 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
- ReplayingSendsSequencerClientTransportImpl → SequencerClientTransportPekko
- def synchronizeWithClosingPatience: FiniteDuration
- Attributes
- protected[this]
- Definition Classes
- PerformUnlessClosing → HasSynchronizeWithReaders
- def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- val underlyingTransport: SequencerClientTransport with SequencerClientTransportPekko
- 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 inHasSynchronizeWithClosing
. 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()
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def waitForIdle(duration: FiniteDuration, startFromTimestamp: Option[CantonTimestamp] = None): Future[EventsReceivedReport]
- Definition Classes
- ReplayingSendsSequencerClientTransportCommon → ReplayingSendsSequencerClientTransport
- def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
- protected[this]
- Definition Classes
- HasSynchronizeWithReaders