trait PartyReplicationProcessor extends SequencerChannelProtocolProcessor
- Alphabetic
 - By Inheritance
 
- PartyReplicationProcessor
 - SequencerChannelProtocolProcessor
 - NamedLogging
 - FlagCloseable
 - PerformUnlessClosing
 - HasSynchronizeWithReaders
 - HasSynchronizeWithClosing
 - OnShutdownRunner
 - HasRunOnClosing
 - HasUnlessClosing
 - AutoCloseable
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - Protected
 
Abstract Value Members
-   implicit abstract  def executionContext: ExecutionContext
- Definition Classes
 - SequencerChannelProtocolProcessor
 
 -   abstract  def exitOnFatalFailures: Boolean
- Attributes
 - protected
 
 -   abstract  def futureSupervisor: FutureSupervisor
- Attributes
 - protected
 
 -   abstract  def handlePayload(payload: ByteString)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Handles payload from the channel.
Handles payload from the channel.
- Definition Classes
 - SequencerChannelProtocolProcessor
 
 -   abstract  def hasEndOfACSBeenReached: Boolean
- Attributes
 - protected
 
 -   abstract  def loggerFactory: NamedLoggerFactory
- Attributes
 - protected
 - Definition Classes
 - NamedLogging
 
 -   abstract  def name: String
- Attributes
 - protected
 
 -   abstract  def onAcsFullyReplicated: (TraceContext) => Unit
- Attributes
 - protected
 
 -   abstract  def onConnected()(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Notification that the processor is now connected and can begin sending and receiving messages.
Notification that the processor is now connected and can begin sending and receiving messages.
- Definition Classes
 - SequencerChannelProtocolProcessor
 
 -   abstract  def onDisconnect: (String, TraceContext) => Unit
- Attributes
 - protected
 
 -   abstract  def onError: (String) => Unit
- Attributes
 - protected
 
 -   abstract  def progressPartyReplication()(implicit traceContext: TraceContext): Unit
Single point of entry for progress monitoring and advancing party replication.
 -   abstract  def psid: PhysicalSynchronizerId
- Attributes
 - protected
 - Definition Classes
 - SequencerChannelProtocolProcessor
 
 -  abstract def replicatedContractsCount: NonNegativeInt
 -   abstract  def testOnlyInterceptor: PartyReplicationTestInterceptor
- Attributes
 - protected
 
 -   abstract  def timeouts: ProcessingTimeout
- Attributes
 - protected
 - Definition Classes
 - FlagCloseable
 
 
Concrete 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 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 closingTimeout: FiniteDuration
- Attributes
 - protected
 - Definition Classes
 - FlagCloseable → PerformUnlessClosing
 
 -   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 execute[T](operation: String)(code: => EitherT[FutureUnlessShutdown, String, T])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, T]
- Attributes
 - protected
 
 -   final  def executeAsync(operation: String)(code: => EitherT[FutureUnlessShutdown, String, Unit])(implicit traceContext: TraceContext): Unit
- Attributes
 - protected
 
 -    val executionQueue: SimpleExecutionQueue
- Attributes
 - protected
 
 -   final  def getClass(): Class[_ <: AnyRef]
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def hasChannelCompleted: Boolean
- Definition Classes
 - SequencerChannelProtocolProcessor
 
 -    def hashCode(): Int
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def isChannelConnected: Boolean
- Definition Classes
 - SequencerChannelProtocolProcessor
 
 -    def isChannelOpenForCommunication: Boolean
- Attributes
 - protected
 
 -    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
performUnlessClosingand 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
 
 -    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
 
 -    def onClosed(): Unit
- Definition Classes
 - PartyReplicationProcessor → PerformUnlessClosing
 
 -    def onDisconnected(status: Either[String, Unit])(implicit traceContext: TraceContext): Boolean
Let the PartyReplication know that the processor has gotten disconnected from the sequencer channel endpoint.
Let the PartyReplication know that the processor has gotten disconnected from the sequencer channel endpoint. Only notify if the disconnect has actually triggered a transition losing the endpoint and unless ACS replication has already completed (in which case the disconnect happens precisely because OnPR has completed).
- returns
 true iff the channel endpoint has been lost
- Definition Classes
 - PartyReplicationProcessor → SequencerChannelProtocolProcessor
 
 -   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
 
 -    def protocolVersion: ProtocolVersion
- Attributes
 - protected
 - Definition Classes
 - SequencerChannelProtocolProcessor
 
 -    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 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'scloseAsyncmethod completes or whenAutoCloseable'sclosemethod returns, unless the returnedLifeCycleRegistrationHandlewas 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'scloseAsyncmethod completes orAutoCloseable'sclosereturns. 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
 
 -   final  def sendCompleted(status: String)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Sends channel completion thereby ending the ability to send subsequent messages.
Sends channel completion thereby ending the ability to send subsequent messages.
- Attributes
 - protected
 - Definition Classes
 - SequencerChannelProtocolProcessor
 
 -   final  def sendError(error: String)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Sends channel error thereby ending the ability to send subsequent messages.
Sends channel error thereby ending the ability to send subsequent messages.
- Attributes
 - protected
 - Definition Classes
 - SequencerChannelProtocolProcessor
 
 -   final  def sendPayload(operation: String, payload: ByteString)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, String, Unit]
Sends payload to channel
Sends payload to channel
- Attributes
 - protected
 - Definition Classes
 - SequencerChannelProtocolProcessor
 
 -    def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise it is the result of runningf.
- Definition Classes
 - HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns.Convenience method for synchronizing on
Futures instead ofFutureUnlessShutdowns. Equivalent tosynchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
- Definition Classes
 - PerformUnlessClosing
 
 -    def synchronizeWithClosingPatience: FiniteDuration
- Attributes
 - protected[this]
 - Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithReaders
 
 -    def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas finished or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run.
- Definition Classes
 - HasSynchronizeWithClosing
 - Annotations
 - @SuppressWarnings()
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
Runs the computation
fonly if the component is not yet closing.Runs the computation
fonly if the component is not yet closing. If so, the component will delay releasing its resources untilfhas completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or thesynchronizeWithClosingPatiencehas elapsed.DO NOT CALL
this.closeas part off, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, insidef.- returns
 com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if
fhas not run. Otherwise the result of runningf.
- Definition Classes
 - PerformUnlessClosing → HasSynchronizeWithClosing
 - See also
 HasRunOnClosing.isClosing
 -    def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders
 
 -   final  def synchronized[T0](arg0: => T0): T0
- Definition Classes
 - AnyRef
 
 -    def toString(): String
- Definition Classes
 - AnyRef → Any
 
 -   final  def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]
Runs the computation
faunless isClosing returns true.Runs the computation
faunless isClosing returns true.This method does not delay the closing while
fais 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
faor 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])
 
 -   final  def wait(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -    def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
- Attributes
 - protected[this]
 - Definition Classes
 - HasSynchronizeWithReaders