Packages

class ReferenceSequencerDriverFactory extends SequencerDriverFactory

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReferenceSequencerDriverFactory
  2. SequencerDriverFactory
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ReferenceSequencerDriverFactory()

Type Members

  1. type ConfigType = Config

    The Scala type holding the driver-specific configuration

    The Scala type holding the driver-specific configuration

    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  6. def configParser: ConfigReader[ConfigType]

    Parser for the driver-specific configuration.

    Parser for the driver-specific configuration.

    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory
  7. def configWriter(confidential: Boolean): ConfigWriter[ConfigType]

    Serializer for the driver-specific configuration.

    Serializer for the driver-specific configuration.

    confidential

    Indicates whether confidential information (e.g. passwords) should be written in a shaded form without disclosing the actual plain information.

    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory
  8. def create(config: ConfigType, nonStandardConfig: Boolean, timeProvider: TimeProvider, firstBlockHeight: Option[Long], domainTopologyManagerId: String, loggerFactory: NamedLoggerFactory)(implicit executionContext: ExecutionContext, materializer: Materializer): SequencerDriver

    Creates a new ledger driver instance

    Creates a new ledger driver instance

    config

    The driver-specific configuration.

    nonStandardConfig

    Whether to be lax in enforcing certain configuration constraints such as required external component versions.

    timeProvider

    Time provider to obtain time readings from. If usesTimeProvider returns true, must be used instead of system time so that we can modify time in tests.

    firstBlockHeight

    Initial block from which the driver will start serving the block subscription. It will be valued when a sequencer is restarted or dynamically onboarded based on the state of a running sequencer. In the case of a newly started sequencer, it will be None and the driver will start serving from whichever block it considers the beginning. Given a specific firstBlockHeight, the sequence of blocks served by a driver must be always exactly the same and the blocks must be consecutively numbered.

    domainTopologyManagerId

    The Canton identifier of the Topology Manager for the domain being supported.

    loggerFactory

    A logger factory through which all logging should be done. Useful in tests as we can capture log entries and check them.

    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory
  9. val delegate: Factory[ReferenceBlockOrdererFactory]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def name: String

    The name of the ledger driver Used in Canton configurations to specify the ledger driver as in type = name.

    The name of the ledger driver Used in Canton configurations to specify the ledger driver as in type = name.

    sequencer {
      type = "foobar"
      config = { config specific to driver foobar }
    }
    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def usesTimeProvider: Boolean

    Returns whether the driver produced by create will use the com.digitalasset.canton.time.TimeProvider for generating timestamps on com.digitalasset.canton.domain.block.RawLedgerBlock.RawBlockEvent.Send events.

    Returns whether the driver produced by create will use the com.digitalasset.canton.time.TimeProvider for generating timestamps on com.digitalasset.canton.domain.block.RawLedgerBlock.RawBlockEvent.Send events.

    This information is used to prevent using the driver in an environment that needs to control time, e.g., for testing.

    Definition Classes
    ReferenceSequencerDriverFactorySequencerDriverFactory
  22. def version: Int
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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 SequencerDriverFactory

Inherited from AnyRef

Inherited from Any

Ungrouped