abstract class BaseDriver extends Flusher[Transaction] with NamedLogging with FlagCloseable with NoTracing with HasFlushFuture with Factory
Shared implementation between master, trader and issuer roles.
The base driver contains the shared code between each role. In here, we setup the connection, read the ACS on startup, initialise the driver and provide a set of utilities that all roles will need (such as submitting and tracking submissions or dealing with pending contracts)
We also implement here the basic nanobot update logic.
- Annotations
- @nowarn()
- Alphabetic
- By Inheritance
- BaseDriver
- Factory
- HasFlushFuture
- NoTracing
- FlagCloseable
- AutoCloseable
- NamedLogging
- Flusher
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BaseDriver(connectivity: Connectivity, partyLf: LfPartyId, masterPartyLf: LfPartyId, commandClientConfiguration: CommandClientConfiguration, prefix: MetricName, registry: MetricRegistry, loggerFactory: NamedLoggerFactory, control: DriverControl)(implicit ec: ExecutionContextExecutor, actorSystem: ActorSystem, executionSequencerFactory: ExecutionSequencerFactory)
Abstract Value Members
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 addToFlushAndLogError(name: String)(future: Future[_])(implicit loggingContext: ErrorLoggingContext): Unit
Adds the task
futureto the flush future so that doFlush completes only afterfuturehas completed.Adds the task
futureto the flush future so that doFlush completes only afterfuturehas completed. Logs an error if thefuturefails with an exception.- Attributes
- protected
- Definition Classes
- HasFlushFuture
- def addToFlushWithoutLogging(name: String)(future: Future[_]): Unit
Adds the task
futureto the flush future so that doFlush completes only afterfuturehas completed.Adds the task
futureto the flush future so that doFlush completes only afterfuturehas completed. The caller is responsible for logging any exceptions thrown inside the future.- Attributes
- protected
- Definition Classes
- HasFlushFuture
- val applicationId: String
- Attributes
- protected
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val backoff: AtomicInteger
- Attributes
- protected
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val commandIdGen: AtomicInteger
- Attributes
- protected
- val conn: LedgerConnection with NamedLogging
- Attributes
- protected
- def counter(name: MetricName): CounterM
- Definition Classes
- Factory
- val currentStatus: AtomicReference[Option[DriverStatus]]
- Attributes
- protected
- 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
- def done(): Future[Unit]
- val done_: Promise[Unit]
- Attributes
- protected
- def driver(): (BotUpdate[Transaction]) => Boolean
- Definition Classes
- Flusher
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finished(): Unit
- Attributes
- protected
- def flushCloseable(name: String, timeout: TimeoutDuration): SyncCloseable
- Attributes
- protected
- Definition Classes
- HasFlushFuture
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def histogram(name: MetricName): HistogramM
- Definition Classes
- Factory
- val httpClient: OkHttpClient
- Attributes
- protected
- def intGauge(name: MetricName, initial: Integer): GaugeM[IntGauge, Integer]
- Definition Classes
- Factory
- def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def isActive: Boolean
- Definition Classes
- BaseDriver → Flusher
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val jsonApiAuthToken: String
- Attributes
- protected
- 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
- def latencyMonitor: Option[LatencyMonitor]
- Attributes
- protected
- val listeners: ListBuffer[ContractObserver]
- Attributes
- protected
- def loadGauge(name: MetricName, interval: FiniteDuration, timer: Timer): GaugeM[TimedLoadGauge, Double]
- Definition Classes
- Factory
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Definition Classes
- BaseDriver → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- def mapCommand(fut: Future[CommandResult]): EitherT[Future, String, Unit]
- Attributes
- protected
- val masterContract: ContractStore[TestRun, Unit]
- Attributes
- protected
- def masterCreated(create: Contract[TestRun]): Unit
- Attributes
- protected
- val masterParty: @@[String, PartyTag]
- Attributes
- protected
- def meter(name: MetricName): MeterM
- Definition Classes
- Factory
- 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
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onClosed(): Unit
- Definition Classes
- BaseDriver → FlagCloseable
- val party: @@[String, PartyTag]
- Attributes
- protected
- val pendingCommands: TrieMap[String, Instant]
- Attributes
- protected
- def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, 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.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- FlagCloseable
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, 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.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, 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.- 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
- def postToJsonApi(path: String, postBody: String): Future[(Int, String)]
- Attributes
- protected
- val prefix: MetricName
- Definition Classes
- BaseDriver → Factory
- def refGauge[T](name: MetricName, empty: T): GaugeM[RefGauge[T], T]
- Definition Classes
- Factory
- val registry: MetricRegistry
- Definition Classes
- BaseDriver → Factory
- 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
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- val running: AtomicBoolean
- Attributes
- protected
- def setPending[T <: Template[T], L](cs: ContractStore[T, L], cid: ContractId[T], fut: Future[CommandResult])(implicit arg0: ValueDecoder[T]): Unit
- Attributes
- protected
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def start(): Future[Either[String, Unit]]
- def status(): Option[DriverStatus]
- def submitBatched(commands: Seq[SubCommand], batchSize: Int, submissionRate: SubmissionRate): Unit
- Attributes
- protected
- def submitCommand(baseDescription: String, command: Seq[Command], reference: String, failed: () => Unit = () => ()): Future[CommandResult]
- Attributes
- protected
- def submitSubCommands(commands: Seq[SubCommand]): Future[CommandResult]
- Attributes
- protected
- def submitViaJsonApi(command: Command, commandId: String): Future[CommandResult]
- Attributes
- protected
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- BaseDriver → FlagCloseable
- def timer(name: MetricName): TimerM
- Definition Classes
- Factory
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- def update(transaction: List[Transaction]): Boolean
- Definition Classes
- BaseDriver → Flusher
- def updateRateSettings(update: (RateSettings) => RateSettings): Unit
- def varGauge[T](name: MetricName, initial: T): GaugeM[VarGauge[T], T]
- Definition Classes
- Factory
- 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])