Packages

abstract class ParticipantDriver extends BaseDriver

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParticipantDriver
  2. BaseDriver
  3. Factory
  4. HasFlushFuture
  5. NoTracing
  6. FlagCloseable
  7. AutoCloseable
  8. NamedLogging
  9. Flusher
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ParticipantDriver(connectivity: Connectivity, partyLf: LfPartyId, masterLf: LfPartyId, role: ActivePartyRole, registerGenerator: Boolean, prefix: MetricName, registry: MetricRegistry, loggerFactory: NamedLoggerFactory, control: DriverControl)(implicit ec: ExecutionContextExecutor, actorSystem: ActorSystem, executionSequencerFactory: ExecutionSequencerFactory)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Abstract Value Members

  1. abstract def flush(): Boolean
    Definition Classes
    Flusher
  2. abstract def subscribeToTemplates: Seq[TemplateId[_]]
    Attributes
    protected
    Definition Classes
    BaseDriver

Concrete Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. def addToFlushAndLogError(name: String)(future: Future[_])(implicit loggingContext: ErrorLoggingContext): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. Logs an error if the future fails with an exception.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  6. def addToFlushWithoutLogging(name: String)(future: Future[_]): Unit

    Adds the task future to the flush future so that doFlush completes only after future has completed.

    Adds the task future to the flush future so that doFlush completes only after future has completed. The caller is responsible for logging any exceptions thrown inside the future.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  7. val applicationId: String
    Attributes
    protected
    Definition Classes
    BaseDriver
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val backoff: AtomicInteger
    Attributes
    protected
    Definition Classes
    BaseDriver
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. 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()
  12. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  13. val commandIdGen: AtomicInteger
    Attributes
    protected
    Definition Classes
    BaseDriver
  14. val conn: LedgerConnection with NamedLogging
    Attributes
    protected
    Definition Classes
    BaseDriver
  15. def counter(name: MetricName): CounterM
    Definition Classes
    Factory
  16. val currentStatus: AtomicReference[Option[DriverStatus]]
    Attributes
    protected
    Definition Classes
    BaseDriver
  17. def doFlush(): Future[Unit]

    Returns a future that completes after all added futures have completed.

    Returns a future that completes after all added futures have completed. The returned future never fails.

    Attributes
    protected
    Definition Classes
    HasFlushFuture
  18. def doInitExisting(): Boolean
    Attributes
    protected
  19. def done(): Future[Unit]
    Definition Classes
    BaseDriver
  20. val done_: Promise[Unit]
    Attributes
    protected
    Definition Classes
    BaseDriver
  21. def driver(): (BotUpdate[Transaction]) => Boolean
    Definition Classes
    Flusher
  22. def ensureFlag(flag: ParticipantFlag): Unit
    Attributes
    protected
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. def finished(): Unit
    Attributes
    protected
    Definition Classes
    BaseDriver
  27. def flushCloseable(name: String, timeout: NonNegativeDuration): SyncCloseable
    Attributes
    protected
    Definition Classes
    HasFlushFuture
  28. val generator: ContractStore[Generator, Unit]
    Attributes
    protected
  29. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def histogram(name: MetricName): HistogramM
    Definition Classes
    Factory
  32. val httpClient: OkHttpClient
    Attributes
    protected
    Definition Classes
    BaseDriver
  33. final def initExisting(): Unit
    Attributes
    protected
  34. def intGauge(name: MetricName, initial: Integer): GaugeM[IntGauge, Integer]
    Definition Classes
    Factory
  35. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  36. def isActive: Boolean
    Definition Classes
    BaseDriverFlusher
  37. 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
  38. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  39. val jsonApiAuthToken: String
    Attributes
    protected
    Definition Classes
    BaseDriver
  40. 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
  41. def latencyMonitor: Option[LatencyMonitor]
    Definition Classes
    ParticipantDriverBaseDriver
  42. val listeners: ListBuffer[ContractObserver]
    Attributes
    protected
    Definition Classes
    BaseDriver
  43. def loadGauge(name: MetricName, interval: FiniteDuration, timer: Timer): GaugeM[TimedLoadGauge, Double]
    Definition Classes
    Factory
  44. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  45. val loggerFactory: NamedLoggerFactory
    Definition Classes
    BaseDriverNamedLogging
  46. def mapCommand(fut: Future[CommandResult]): EitherT[Future, String, Unit]
    Attributes
    protected
    Definition Classes
    BaseDriver
  47. val masterContract: ContractStore[TestRun, Unit]
    Attributes
    protected
    Definition Classes
    BaseDriver
  48. def masterCreated(create: Contract[TestRun]): Unit
    Attributes
    protected
    Definition Classes
    BaseDriver
  49. val masterParty: @@[String, PartyTag]
    Attributes
    protected
    Definition Classes
    BaseDriver
  50. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  51. def meter(name: MetricName): MeterM
    Definition Classes
    Factory
  52. val monitor: LatencyMonitor
    Attributes
    protected
  53. def name: String
    Definition Classes
    ParticipantDriverFlusher
  54. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  55. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  56. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  57. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  58. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  59. def onClosed(): Unit
    Definition Classes
    BaseDriverFlagCloseable
  60. val participantRequest: ContractStore[ParticipationRequest, Unit]
    Attributes
    protected
  61. val party: @@[String, PartyTag]
    Attributes
    protected
    Definition Classes
    BaseDriver
  62. val pendingCommands: TrieMap[String, Instant]
    Attributes
    protected
    Definition Classes
    BaseDriver
  63. 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
    FlagCloseable
  64. 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
    FlagCloseable
  65. 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
    FlagCloseable
  66. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  67. 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
    FlagCloseable
  68. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  69. def postToJsonApi(path: String, postBody: String): Future[(Int, String)]
    Attributes
    protected
    Definition Classes
    BaseDriver
  70. val prefix: MetricName
    Definition Classes
    BaseDriverFactory
  71. val rate: I
    Attributes
    protected
  72. def refGauge[T](name: MetricName, empty: T): GaugeM[RefGauge[T], T]
    Definition Classes
    Factory
  73. def registerIfNecessary(): EitherT[Future, String, Unit]
    Attributes
    protected
  74. val registry: MetricRegistry
    Definition Classes
    BaseDriverFactory
  75. 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
  76. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  77. val running: AtomicBoolean
    Attributes
    protected
    Definition Classes
    BaseDriver
  78. def setPending[T <: Template[T], L](cs: ContractStore[T, L], cid: ContractId[T], fut: Future[CommandResult])(implicit arg0: ValueDecoder[T]): Unit
    Attributes
    protected
    Definition Classes
    BaseDriver
  79. def settings: RateSettings
  80. def start(): Future[Either[String, Unit]]
    Definition Classes
    ParticipantDriverBaseDriver
  81. def status(): Option[DriverStatus]
    Definition Classes
    BaseDriver
  82. def submitBatched(commands: Seq[SubCommand], batchSize: Int, submissionRate: SubmissionRate): Unit
    Attributes
    protected
    Definition Classes
    BaseDriver
  83. def submitCommand(baseDescription: String, command: Seq[Command], reference: String, failed: () => Unit = () => ()): Future[CommandResult]
    Attributes
    protected
    Definition Classes
    BaseDriver
  84. def submitSubCommands(commands: Seq[SubCommand]): Future[CommandResult]
    Attributes
    protected
    Definition Classes
    BaseDriver
  85. def submitViaJsonApi(command: Command, commandId: String): Future[CommandResult]
    Attributes
    protected
    Definition Classes
    BaseDriver
  86. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  87. val testResult: ContractStore[TestParticipant, Unit]
    Attributes
    protected
  88. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    BaseDriverFlagCloseable
  89. def timer(name: MetricName): TimerM
    Definition Classes
    Factory
  90. def toString(): String
    Definition Classes
    AnyRef → Any
  91. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  92. def update(transaction: List[Transaction]): Boolean
    Definition Classes
    BaseDriverFlusher
  93. def updateFlag(participant: Contract[TestParticipant], newFlag: ParticipantFlag): Unit
    Attributes
    protected
  94. def updateRateSettings(update: (RateSettings) => RateSettings): Unit
    Definition Classes
    ParticipantDriverBaseDriver
  95. def varGauge[T](name: MetricName, initial: T): GaugeM[VarGauge[T], T]
    Definition Classes
    Factory
  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  98. 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 BaseDriver

Inherited from Factory

Inherited from HasFlushFuture

Inherited from NoTracing

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from NamedLogging

Inherited from Flusher[Transaction]

Inherited from AnyRef

Inherited from Any

Ungrouped