class GrpcSequencerService extends SequencerService with NamedLogging with FlagCloseable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcSequencerService
  2. FlagCloseable
  3. PerformUnlessClosing
  4. OnShutdownRunner
  5. AutoCloseable
  6. NamedLogging
  7. SequencerService
  8. AbstractService
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GrpcSequencerService(sequencer: Sequencer, metrics: SequencerMetrics, loggerFactory: NamedLoggerFactory, authenticationCheck: AuthenticationCheck, subscriptionPool: SubscriptionPool[GrpcManagedSubscription[_]], directSequencerSubscriptionFactory: DirectSequencerSubscriptionFactory, domainParamsLookup: DomainParametersLookup[SequencerDomainParameters], parameters: SequencerParameters, topologyStateForInitializationService: Option[TopologyStateForInitializationService], protocolVersion: ProtocolVersion, enableBroadcastOfUnauthenticatedMessages: Boolean, maxItemsInTopologyResponse: PositiveInt = PositiveInt.tryCreate(100))(implicit ec: ExecutionContext)

    sequencer

    The underlying sequencer implementation

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 acknowledge(requestP: AcknowledgeRequest): Future[Empty]

    Allows a member to acknowledge that they have read all events up to and including the provided timestamp, and that they will never re-read these events again.

    Allows a member to acknowledge that they have read all events up to and including the provided timestamp, and that they will never re-read these events again. This information is currently only used for informational purposes and to provide a watermark for which it is safe to prune earlier events from the sequencer data stores. There is no requirement for every event to be individually acknowledged, and in fact callers are encouraged to only periodically record acknowledgements (at an interval of minutes is expected to be more than sufficient for pruning).

    Definition Classes
    GrpcSequencerServiceSequencerService
  5. def acknowledgeSigned(request: SignedContent): Future[Empty]

    Newer version of acknowledgements.

    Newer version of acknowledgements. To be active for protocol versions >= 4. The argument here is an AcknowledgeRequest wrapped in SignedContent. The signature is checked on the server side to avoid that malicious sequencers create fake acknowledgements in multi-writer architectures where writers don't fully trust each other.

    Allows a member to acknowledge that they have read all events up to and including the provided timestamp, and that they will never re-read these events again. This information is currently only used for informational purposes and to provide a watermark for which it is safe to prune earlier events from the sequencer data stores. There is no requirement for every event to be individually acknowledged, and in fact callers are encouraged to only periodically record acknowledgements (at an interval of minutes is expected to be more than sufficient for pruning).

    Definition Classes
    GrpcSequencerServiceSequencerService
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. 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
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  11. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  12. def disconnectAllMembers()(implicit traceContext: TraceContext): Unit
  13. def disconnectMember(member: Member)(implicit traceContext: TraceContext): Unit
  14. def downloadTopologyStateForInit(requestP: TopologyStateForInitRequest, responseObserver: StreamObserver[TopologyStateForInitResponse]): Unit

    Download the topology state for a member up to including the topology transaction that made the member known on the domain.

    Download the topology state for a member up to including the topology transaction that made the member known on the domain.

    Definition Classes
    GrpcSequencerServiceSequencerService
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  21. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    GrpcSequencerServiceNamedLogging
  26. 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
  27. def membersWithActiveSubscriptions: Seq[Member]
  28. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  34. def onClosed(): Unit
  35. 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()
  36. 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
  37. 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
  38. 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
  39. 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
  40. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  41. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  42. 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
  43. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  44. 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
  45. 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
  46. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  47. def sendAsync(requestP: SubmissionRequest): Future[SendAsyncResponse]

    Submit a send request to the sequencer for sequencing asynchronously.

    Submit a send request to the sequencer for sequencing asynchronously. The rpc request may return an error if the request cannot be processed at all - see SendAsyncResponse for these scenarios. The sequencer may emit a Deliver or DeliverError event from this send, if the subscriber witnesses an event greater or equal to the supplied maxSequencingTime, the sequencer guarantees not to publish a future Deliver event for this send. The sequencer implementation may however publish a future DeliverError (typically used to indicate maxSequencingTime exceeded). Used in protocol version 3

    Definition Classes
    GrpcSequencerServiceSequencerService
  48. def sendAsyncSigned(requestP: SignedContent): Future[SendAsyncSignedResponse]

    Newer version of request submission (for authenticated members).

    Newer version of request submission (for authenticated members). To be active for protocol versions 4. The argument here is a SubmissionRequest wrapped in SignedContent. The signature is checked on the server side to avoid that malicious sequencers create fake submission requests in multi-writer architectures where writers don't fully trust each other.

    Submit a send request to the sequencer for sequencing asynchronously. The rpc request may return an error if the request cannot be processed at all - see SendAsyncResponse for these scenarios. The sequencer may emit a Deliver or DeliverError event from this send, if the subscriber witnesses an event greater or equal to the supplied maxSequencingTime, the sequencer guarantees not to publish a future Deliver event for this send. The sequencer implementation may however publish a future DeliverError (typically used to indicate maxSequencingTime exceeded).

    Definition Classes
    GrpcSequencerServiceSequencerService
  49. def sendAsyncUnauthenticated(requestP: SubmissionRequest): Future[SendAsyncResponse]

    Submit a send request to the sequencer for sequencing asynchronously exactly like SendAsync, except that this meant 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 Used in protocol versions 3 and 4

    Submit a send request to the sequencer for sequencing asynchronously exactly like SendAsync, except that this meant 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 Used in protocol versions 3 and 4

    Definition Classes
    GrpcSequencerServiceSequencerService
  50. def sendAsyncUnauthenticatedVersioned(requestP: SendAsyncUnauthenticatedVersionedRequest): Future[SendAsyncResponse]

    Submit a send request to the sequencer for sequencing asynchronously exactly like SendAsyncVersioned, except that this meant 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

    Submit a send request to the sequencer for sequencing asynchronously exactly like SendAsyncVersioned, except that this meant 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

    Used in protocol version 5 or higher

    Definition Classes
    GrpcSequencerServiceSequencerService
  51. def sendAsyncVersioned(requestP: SendAsyncVersionedRequest): Future[SendAsyncSignedResponse]

    Submit a send request to the sequencer for sequencing asynchronously.

    Submit a send request to the sequencer for sequencing asynchronously. The rpc request may return an error if the request cannot be processed at all - see SendAsyncResponse for these scenarios. The sequencer may emit a Deliver or DeliverError event from this send. If the subscriber witnesses an event greater or equal to the supplied maxSequencingTime, the sequencer guarantees not to publish a future Deliver event for this send. The sequencer implementation may however publish a future DeliverError (typically used to indicate maxSequencingTime exceeded).

    The signature is checked on the server side to avoid that malicious sequencers create fake submission requests in multi-writer architectures where writers don't fully trust each other.

    Used in protocol version 5 or higher

    Definition Classes
    GrpcSequencerServiceSequencerService
  52. def serviceCompanion: ServiceCompanion[SequencerService]
    Definition Classes
    SequencerService → AbstractService
  53. def subscribe(request: SubscriptionRequest, responseObserver: StreamObserver[SubscriptionResponse]): Unit

    Establishes a stream with the server to receive sequenced events from the domain after the given counter.

    Establishes a stream with the server to receive sequenced events from the domain after the given counter. The delivered events will have a sequential counter and monotonically increasing timestamp. TBD: Message TTL - How far back should it go when the participant initiate a subscription ?

    Definition Classes
    GrpcSequencerServiceSequencerService
  54. def subscribeUnauthenticated(request: SubscriptionRequest, responseObserver: StreamObserver[SubscriptionResponse]): Unit

    Establishes a stream with the server to receive sequenced events exactly like Subscribe, except that this is supposed to be used only by unauthenticated members similarly to SendAsyncUnauthenticated

    Establishes a stream with the server to receive sequenced events exactly like Subscribe, except that this is supposed to be used only by unauthenticated members similarly to SendAsyncUnauthenticated

    Definition Classes
    GrpcSequencerServiceSequencerService
  55. def subscribeUnauthenticatedVersioned(request: SubscriptionRequest, responseObserver: StreamObserver[VersionedSubscriptionResponse]): Unit

    Same as SubscribeUnauthenticated(SubscriptionRequest) but delivers byte array rather than typed message to support multiple versions.

    Same as SubscribeUnauthenticated(SubscriptionRequest) but delivers byte array rather than typed message to support multiple versions.

    Definition Classes
    GrpcSequencerServiceSequencerService
  56. def subscribeVersioned(request: SubscriptionRequest, responseObserver: StreamObserver[VersionedSubscriptionResponse]): Unit

    Same as Subscribe(SubscriptionRequest) but delivers byte array rather than typed message to support multiple versions.

    Same as Subscribe(SubscriptionRequest) but delivers byte array rather than typed message to support multiple versions.

    Definition Classes
    GrpcSequencerServiceSequencerService
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    GrpcSequencerServiceFlagCloseable
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. def usingVersionedSubscription(protocolVersion: ProtocolVersion): Boolean
  61. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  63. 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 FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from SequencerService

Inherited from AbstractService

Inherited from AnyRef

Inherited from Any

Ungrouped