c

com.digitalasset.canton.sequencing.client.transports

GrpcSequencerClientTransport

class GrpcSequencerClientTransport extends SequencerClientTransport with NamedLogging

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrpcSequencerClientTransport
  2. NamedLogging
  3. SequencerClientTransport
  4. SupportsHandshake
  5. FlagCloseable
  6. AutoCloseable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GrpcSequencerClientTransport(channel: ManagedChannel, clientAuth: GrpcSequencerClientAuth, metrics: SequencerClientMetrics, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit executionContext: 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 acknowledge(member: Member, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): Future[Unit]

    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.

    Definition Classes
    GrpcSequencerClientTransportSequencerClientTransport
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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 → AutoCloseable
    Annotations
    @SuppressWarnings()
  8. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def handshake(request: HandshakeRequest)(implicit traceContext: TraceContext): EitherT[Future, HandshakeRequestError, HandshakeResponse]

    Attempt to obtain a handshake response from the sequencer.

    Attempt to obtain a handshake response from the sequencer. Transports can indicate in the error if the error is transient and could be retried.

    Definition Classes
    GrpcSequencerClientTransportSupportsHandshake
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  15. 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
    FlagCloseable
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. 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
    FlagCloseable
  18. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    GrpcSequencerClientTransportNamedLogging
  20. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    GrpcSequencerClientTransportFlagCloseable
  26. def performUnlessClosing[A](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.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  27. def performUnlessClosingEitherT[E, R](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.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  28. def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  29. def performUnlessClosingF[A](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.

    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
    FlagCloseable
  30. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  31. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  32. def sendAsync(request: SubmissionRequest, timeout: Duration, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]

    Sends a submission request to the sequencer.

    Sends a 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
    GrpcSequencerClientTransportSequencerClientTransport
  33. def sendAsyncUnauthenticated(request: SubmissionRequest, timeout: Duration, protocolVersion: ProtocolVersion)(implicit traceContext: TraceContext): EitherT[Future, SendAsyncClientError, Unit]
  34. def sleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  35. def subscribe[E](subscriptionRequest: SubscriptionRequest, handler: SerializedEventHandler[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
    GrpcSequencerClientTransportSequencerClientTransport
  36. def subscribeUnauthenticated[E](request: SubscriptionRequest, handler: SerializedEventHandler[E])(implicit traceContext: TraceContext): SequencerSubscription[E]
  37. 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
    GrpcSequencerClientTransportSequencerClientTransport
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. val timeouts: ProcessingTimeout
  40. def toString(): String
    Definition Classes
    AnyRef → Any
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  43. 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

Inherited from NamedLogging

Inherited from SupportsHandshake

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped