com.digitalasset.canton.participant.store
SerializableLedgerSyncEvent
Companion object SerializableLedgerSyncEvent
final case class SerializableLedgerSyncEvent(ledgerSyncEvent: LedgerSyncEvent)(representativeProtocolVersion: RepresentativeProtocolVersion[SerializableLedgerSyncEvent]) extends HasProtocolVersionedWrapper[SerializableLedgerSyncEvent] with Product with Serializable
Wrapper for converting a LedgerSyncEvent to its protobuf companion. Currently only Intended only for storage due to the unusual exceptions which are thrown that are only permitted in a storage context.
- Exceptions thrown
canton.store.db.DbDeserializationException
if transactions or contracts fail to deserializecanton.store.db.DbSerializationException
if transactions or contracts fail to serialize
- Alphabetic
- By Inheritance
- SerializableLedgerSyncEvent
- Serializable
- Product
- Equals
- HasProtocolVersionedWrapper
- HasRepresentativeProtocolVersion
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new SerializableLedgerSyncEvent(ledgerSyncEvent: LedgerSyncEvent)(representativeProtocolVersion: RepresentativeProtocolVersion[SerializableLedgerSyncEvent])
- Exceptions thrown
canton.store.db.DbDeserializationException
if transactions or contracts fail to deserializecanton.store.db.DbSerializationException
if transactions or contracts fail to serialize
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def companionObj: HasProtocolVersionedWrapperCompanion[SerializableLedgerSyncEvent]
- Attributes
- protected
- Definition Classes
- SerializableLedgerSyncEvent → HasProtocolVersionedWrapper
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
- Definition Classes
- HasProtocolVersionedWrapper
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val ledgerSyncEvent: LedgerSyncEvent
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def protoVersion: ProtoVersion
Yields the Proto version that this class will be serialized to
Yields the Proto version that this class will be serialized to
- Definition Classes
- HasProtocolVersionedWrapper
- val representativeProtocolVersion: RepresentativeProtocolVersion[SerializableLedgerSyncEvent]
We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions.
We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions. The representative is one instance of this list, usually the smallest value. In other words, the Proto versions induce an equivalence relation on the list of protocol version, thus use of
representative
.The method
protocolVersionRepresentativeFor
below allows to query the representative for an equivalence class.- Definition Classes
- SerializableLedgerSyncEvent → HasProtocolVersionedWrapper → HasRepresentativeProtocolVersion
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toByteArray: Array[Byte]
Yields a byte array representation of the corresponding
UntypedVersionedMessage
wrapper of this instance.Yields a byte array representation of the corresponding
UntypedVersionedMessage
wrapper of this instance.- Definition Classes
- HasProtocolVersionedWrapper
- def toByteString: ByteString
Yields a byte string representation of the corresponding
UntypedVersionedMessage
wrapper of this instance.Yields a byte string representation of the corresponding
UntypedVersionedMessage
wrapper of this instance.- Definition Classes
- HasProtocolVersionedWrapper
- def toProtoV0: protocol.v0.LedgerSyncEvent
- def toProtoVersioned: VersionedMessage[SerializableLedgerSyncEvent]
Yields the proto representation of the class inside an
UntypedVersionedMessage
wrapper.Yields the proto representation of the class inside an
UntypedVersionedMessage
wrapper.Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).
Be aware that if calling on a class that defines a LegacyProtoConverter, this method will still return a VersionedMessage. If the current protocol version maps to the legacy converter, deserialization will then fail (as it will try to deserialize to the raw protobuf instead of the VersionedMessage wrapper this was serialized to. Prefer using toByteString which handles this use case correctly.
- Definition Classes
- HasProtocolVersionedWrapper
- 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])
- def writeToFile(outputFile: String): Unit
- Definition Classes
- HasProtocolVersionedWrapper