object RootHashMessage extends VersioningCompanionContext[RootHashMessage[RootHashMessagePayload], (ByteString) => ParsingResult[RootHashMessagePayload]] with Serializable
- Alphabetic
- By Inheritance
- RootHashMessage
- Serializable
- VersioningCompanionContext2
- BaseVersioningCompanion
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type Codec = ProtoCodec[RootHashMessage[RootHashMessagePayload], (ByteString) => ParsingResult[RootHashMessagePayload], RootHashMessage[RootHashMessagePayload], RootHashMessage.this.type, Unit]
- Definition Classes
- BaseVersioningCompanion
- type Deserializer = ((ByteString) => ParsingResult[RootHashMessagePayload], OriginalByteString, DataByteString) => ParsingResult[RootHashMessage[RootHashMessagePayload]]
- Definition Classes
- BaseVersioningCompanion
- type Invariants = Seq[Invariant[RootHashMessage[RootHashMessagePayload], RootHashMessage.this.type]]
- Attributes
- protected
- Definition Classes
- BaseVersioningCompanion
- trait RootHashMessagePayloadCast[+Payload <: RootHashMessagePayload] extends AnyRef
- type ThisRepresentativeProtocolVersion = RepresentativeProtocolVersion[RootHashMessage.this.type]
- Attributes
- protected
- Definition Classes
- BaseVersioningCompanion
- type VersioningTable = SupportedProtoVersions[RootHashMessage[RootHashMessagePayload], (ByteString) => ParsingResult[RootHashMessagePayload], RootHashMessage[RootHashMessagePayload], RootHashMessage.this.type, Unit]
- Definition Classes
- BaseVersioningCompanion
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 apply[Payload <: RootHashMessagePayload](rootHash: RootHash, synchronizerId: SynchronizerId, protocolVersion: ProtocolVersion, viewType: ViewType, submissionTopologyTime: CantonTimestamp, payload: Payload): RootHashMessage[Payload]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- def converterFor(protocolVersion: RepresentativeProtocolVersion[RootHashMessage.this.type]): ParsingResult[Codec]
- Definition Classes
- BaseVersioningCompanion
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromByteString(expectedProtocolVersion: ProtocolVersionValidation, bytes: OriginalByteString)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Alias of fromByteString that can be used when there is no context.
Alias of fromByteString that can be used when there is no context.
- Definition Classes
- BaseVersioningCompanion
- def fromByteString(expectedProtocolVersion: ProtocolVersion, bytes: OriginalByteString)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Alias of fromByteString that can be used when there is no context.
Alias of fromByteString that can be used when there is no context.
- Definition Classes
- BaseVersioningCompanion
- def fromByteString(expectedProtocolVersion: ProtocolVersion, context: (ByteString) => ParsingResult[RootHashMessagePayload])(bytes: OriginalByteString): ParsingResult[RootHashMessage[RootHashMessagePayload]]
- Definition Classes
- BaseVersioningCompanion
- def fromByteString(expectedProtocolVersion: ProtocolVersionValidation, context: (ByteString) => ParsingResult[RootHashMessagePayload], bytes: OriginalByteString): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Main deserialization method to parse a byte string
Main deserialization method to parse a byte string
- expectedProtocolVersion
Protocol version used by the synchronizer
- context
Context for the deserialization (() if there is no context)
- bytes
Byte string to be deserialized
- returns
Deserialized value class (as a Right) or a ProtoDeserializationError (as a left) Variants of this method (e.g., when Context=unit) are provided below for convenience.
- Definition Classes
- BaseVersioningCompanion
- def fromByteStringPV(expectedProtocolVersion: ProtocolVersion, bytes: OriginalByteString)(implicit ev: =:=[ProtocolVersion, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Alias of fromByteString that can be used when the Context is a com.digitalasset.canton.version.ProtocolVersion.
Alias of fromByteString that can be used when the Context is a com.digitalasset.canton.version.ProtocolVersion.
- Definition Classes
- BaseVersioningCompanion
- def fromByteStringPVV(expectedProtocolVersion: ProtocolVersionValidation, bytes: OriginalByteString)(implicit ev: =:=[ProtocolVersionValidation, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Alias of fromByteString that can be used when the Context is a com.digitalasset.canton.version.ProtocolVersionValidation.
Alias of fromByteString that can be used when the Context is a com.digitalasset.canton.version.ProtocolVersionValidation.
- Definition Classes
- BaseVersioningCompanion
- def fromProtoV30[Payload <: RootHashMessagePayload](payloadDeserializer: (ByteString) => ParsingResult[Payload])(rootHashMessageP: v30.RootHashMessage): ParsingResult[RootHashMessage[Payload]]
- def fromTrustedByteArray(bytes: Array[Byte])(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
- Definition Classes
- BaseVersioningCompanion
- def fromTrustedByteArray(context: (ByteString) => ParsingResult[RootHashMessagePayload], bytes: Array[Byte]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Deserializes the given bytes without validation.
Deserializes the given bytes without validation.
Unsafe! Do NOT use this method unless you can justify that the given bytes originate from a trusted source. For example, this should be the case for deserialization of data that originates from a database.
- bytes
trusted bytes with an embedded proto version
- Definition Classes
- BaseVersioningCompanion
- def fromTrustedByteString(bytes: OriginalByteString)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Alias of fromTrustedByteString that can be used when there is no context.
Alias of fromTrustedByteString that can be used when there is no context.
- Definition Classes
- BaseVersioningCompanion
- def fromTrustedByteString(context: (ByteString) => ParsingResult[RootHashMessagePayload])(bytes: OriginalByteString): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Deserializes the given bytes without validation.
Deserializes the given bytes without validation.
Unsafe! Do NOT use this method unless you can justify that the given bytes originate from a trusted source. For example, this should be the case for deserialization of data that originates from a database.
- bytes
trusted bytes with an embedded proto version
- Definition Classes
- BaseVersioningCompanion
- def fromTrustedByteStringPVV(bytes: OriginalByteString)(implicit ev: =:=[ProtocolVersionValidation, (ByteString) => ParsingResult[RootHashMessagePayload]]): ParsingResult[RootHashMessage[RootHashMessagePayload]]
Since dependency on the ProtocolVersionValidation is encoded in the context, one still has to provide
ProtocolVersionValidation.NoValidationeven when callingfromTrustedByteString, which is counterintuitive.Since dependency on the ProtocolVersionValidation is encoded in the context, one still has to provide
ProtocolVersionValidation.NoValidationeven when callingfromTrustedByteString, which is counterintuitive. This method allows a simpler call if the Context is a com.digitalasset.canton.version.ProtocolVersionValidation- Definition Classes
- BaseVersioningCompanion
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def invariants: Seq[Invariant[RootHashMessage[RootHashMessagePayload], RootHashMessage.this.type]]
- Definition Classes
- BaseVersioningCompanion
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def name: String
The name of the class as used for pretty-printing and error reporting
The name of the class as used for pretty-printing and error reporting
- Definition Classes
- RootHashMessage → BaseVersioningCompanion
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def parseDelimitedFromTrusted(input: InputStream)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): Option[ParsingResult[RootHashMessage[RootHashMessagePayload]]]
- Definition Classes
- BaseVersioningCompanion
- def parseDelimitedFromTrusted(input: InputStream, context: (ByteString) => ParsingResult[RootHashMessagePayload]): Option[ParsingResult[RootHashMessage[RootHashMessagePayload]]]
Deserializes a message using a delimiter (the message length) from the given input stream.
Deserializes a message using a delimiter (the message length) from the given input stream.
Unsafe! No deserialization validation is performed.
Do NOT use this method unless you can justify that the given bytes originate from a trusted source.
This method works in conjunction with com.digitalasset.canton.version.HasProtocolVersionedWrapper.writeDelimitedTo which should have been used to serialize the message. It is useful for deserializing multiple messages from a single input stream through repeated invocations.
Deserialization is only supported for com.digitalasset.canton.version.VersionedMessage.
- input
the source from which a message is deserialized
- returns
an Option that is None when there are no messages left anymore, otherwise it wraps an Either where left represents a deserialization error (exception) and right represents the successfully deserialized message
- Definition Classes
- BaseVersioningCompanion
- def protoVersionFor(protocolVersion: ProtocolVersion): ProtoVersion
Return the Proto version corresponding to the protocol version
Return the Proto version corresponding to the protocol version
- Definition Classes
- BaseVersioningCompanion
- def protoVersionFor(protocolVersion: RepresentativeProtocolVersion[RootHashMessage.this.type]): ProtoVersion
Return the Proto version corresponding to the representative protocol version
Return the Proto version corresponding to the representative protocol version
- Definition Classes
- BaseVersioningCompanion
- def protocolVersionRepresentativeFor(protoVersion: ProtoVersion): ParsingResult[RepresentativeProtocolVersion[RootHashMessage.this.type]]
- Definition Classes
- BaseVersioningCompanion
- def protocolVersionRepresentativeFor(protocolVersion: ProtocolVersion): RepresentativeProtocolVersion[RootHashMessage.this.type]
- Definition Classes
- BaseVersioningCompanion
- def readFromTrustedFile(inputFile: String)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): Either[String, RootHashMessage[RootHashMessagePayload]]
- Definition Classes
- BaseVersioningCompanion
- def readFromTrustedFile(context: (ByteString) => ParsingResult[RootHashMessagePayload], inputFile: String): Either[String, RootHashMessage[RootHashMessagePayload]]
Deserializes the data from the given file without validation.
Deserializes the data from the given file without validation.
Unsafe! Do NOT use this method unless you can justify that the data originates from a trusted source.
- Definition Classes
- BaseVersioningCompanion
- def readFromTrustedFilePVV(inputFile: String)(implicit ev: =:=[ProtocolVersionValidation, (ByteString) => ParsingResult[RootHashMessagePayload]]): Either[String, RootHashMessage[RootHashMessagePayload]]
- Definition Classes
- BaseVersioningCompanion
- implicit def rootHashMessageProtocolMessageContentCast[Payload <: RootHashMessagePayload](implicit cast: RootHashMessagePayloadCast[Payload]): ProtocolMessageContentCast[RootHashMessage[Payload]]
- def select[Payload <: RootHashMessagePayload](message: RootHashMessage[RootHashMessagePayload])(implicit cast: RootHashMessagePayloadCast[Payload]): Option[RootHashMessage[Payload]]
- def supportedProtoVersion[Proto <: GeneratedMessage](p: GeneratedMessageCompanion[Proto])(fromProto: ((ByteString) => ParsingResult[RootHashMessagePayload], Proto) => ParsingResult[RootHashMessage[RootHashMessagePayload]]): Deserializer
- Attributes
- protected
- Definition Classes
- VersioningCompanionContext2
- Annotations
- @nowarn()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toKind[Payload <: RootHashMessagePayload](payload: RootHashMessagePayload)(implicit cast: RootHashMessagePayloadCast[Payload]): Option[Payload]
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryReadFromTrustedFile(inputFile: String)(implicit ev: =:=[Unit, (ByteString) => ParsingResult[RootHashMessagePayload]]): RootHashMessage[RootHashMessagePayload]
- Definition Classes
- BaseVersioningCompanion
- def tryReadFromTrustedFile(context: (ByteString) => ParsingResult[RootHashMessagePayload], inputFile: String): RootHashMessage[RootHashMessagePayload]
- Definition Classes
- BaseVersioningCompanion
- def validateInstance(instance: RootHashMessage[RootHashMessagePayload], representativeProtocolVersion: ThisRepresentativeProtocolVersion): Either[String, Unit]
Will check that default value rules defined in invariants hold.
Will check that default value rules defined in invariants hold.
- Definition Classes
- BaseVersioningCompanion
- val versioningTable: VersioningTable
Proto versions that are supported by
fromByteStringSee the helpersupportedProtoVersionbelow to define aParser.Proto versions that are supported by
fromByteStringSee the helpersupportedProtoVersionbelow to define aParser.- Definition Classes
- RootHashMessage → BaseVersioningCompanion
- 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])
- object VersioningTable
- Definition Classes
- BaseVersioningCompanion