object Batch extends HasProtocolVersionedCompanion2[Batch[Envelope[_]], Batch[ClosedEnvelope]]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Batch
  2. HasProtocolVersionedCompanion2
  3. HasProtocolVersionedWrapperWithoutContextCompanion
  4. HasProtocolVersionedWrapperCompanion
  5. Serializable
  6. HasSupportedProtoVersions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type DataByteString = ByteString
  2. type Deserializer = (DataByteString) => ParsingResult[Batch[ClosedEnvelope]]
  3. type OriginalByteString = ByteString
  4. type Serializer = (Batch[Envelope[_]]) => ByteString
    Definition Classes
    HasSupportedProtoVersions
  5. type ThisRepresentativeProtocolVersion = RepresentativeProtocolVersion[Batch.this.type]
    Attributes
    protected
    Definition Classes
    HasSupportedProtoVersions
  6. case class DefaultValueFromInclusive[T](attribute: (ValueClass) => T, attributeName: String, startInclusive: ThisRepresentativeProtocolVersion, defaultValue: T) extends DefaultValue[T] with Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  7. case class DefaultValueUntilExclusive[T](attribute: (ValueClass) => T, attributeName: String, untilExclusive: ThisRepresentativeProtocolVersion, defaultValue: T) extends DefaultValue[T] with Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  8. case class EmptyOptionExactlyUntilExclusive[T](attribute: (ValueClass) => Option[T], attributeName: String, untilExclusive: ThisRepresentativeProtocolVersion) extends DefaultValue[Option[T]] with Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  9. trait Invariant extends AnyRef
    Definition Classes
    HasSupportedProtoVersions
  10. case class LegacyProtoConverter extends ProtoCodec with PrettyPrinting with Product with Serializable

    Used to (de)serialize classes which for legacy reasons where not wrapped in VersionedMessage Chances are this is NOT the class you want to use, use VersionedProtoConverter instead when adding serialization to a new class

    Used to (de)serialize classes which for legacy reasons where not wrapped in VersionedMessage Chances are this is NOT the class you want to use, use VersionedProtoConverter instead when adding serialization to a new class

    Attributes
    protected[this]
    Definition Classes
    HasSupportedProtoVersions
  11. case class OneElementSeqExactlyUntilExclusive[T](attribute: (ValueClass) => Seq[T], attributeName: String, untilExclusive: ThisRepresentativeProtocolVersion) extends DefaultValue[Seq[T]] with Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  12. sealed trait ProtoCodec extends AnyRef

    Base class for (de)serializing from/to protobuf of ValueClass from a specific PV

    Base class for (de)serializing from/to protobuf of ValueClass from a specific PV

    Definition Classes
    HasSupportedProtoVersions
  13. case class SupportedProtoVersions extends Product with Serializable
    Definition Classes
    HasSupportedProtoVersions
  14. case class UnsupportedProtoCodec(fromInclusive: RepresentativeProtocolVersion[HasSupportedProtoVersions.this.type]) extends ProtoCodec with PrettyPrinting with Product with Serializable
    Attributes
    protected[this]
    Definition Classes
    HasSupportedProtoVersions
  15. case class VersionedProtoConverter extends ProtoCodec with PrettyPrinting with Product with Serializable

    Supported Proto version

    Supported Proto version

    Attributes
    protected[this]
    Definition Classes
    HasSupportedProtoVersions

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. def apply[Env <: Envelope[_]](envelopes: List[Env], protocolVersion: ProtocolVersion): Batch[Env]
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def closeEnvelopes[T <: ProtocolMessage](batch: Batch[OpenEnvelope[T]]): Batch[ClosedEnvelope]
  8. def deserializationErrorK(error: ProtoDeserializationError): (DataByteString) => ParsingResult[Batch[ClosedEnvelope]]
    Attributes
    protected
    Definition Classes
    HasProtocolVersionedCompanion2HasSupportedProtoVersions
  9. def deserializeForVersion(rpv: RepresentativeProtocolVersion[Batch.this.type], deserializeLegacyProto: (Deserializer) => ParsingResult[Batch[ClosedEnvelope]], deserializeVersionedProto: => ParsingResult[Batch[ClosedEnvelope]]): ParsingResult[Batch[ClosedEnvelope]]
    Attributes
    protected
    Definition Classes
    HasProtocolVersionedWrapperCompanion
  10. def empty[Env <: Envelope[_]](protocolVersion: ProtocolVersion): Batch[Env]

    Constructs a batch with no envelopes

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def filterClosedEnvelopesFor(batch: Batch[ClosedEnvelope], member: Member): Batch[ClosedEnvelope]
  14. def filterOpenEnvelopesFor[T <: ProtocolMessage](batch: Batch[OpenEnvelope[T]], member: Member): Batch[OpenEnvelope[T]]
  15. def fromByteArrayUnsafe(bytes: Array[Byte]): ParsingResult[Batch[ClosedEnvelope]]

    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 a database.

    bytes

    trusted bytes with an embedded proto version

    Definition Classes
    HasProtocolVersionedCompanion2
  16. def fromByteString(expectedProtocolVersion: ProtocolVersionValidation)(bytes: OriginalByteString): ParsingResult[Batch[ClosedEnvelope]]

    Variation of fromByteString that takes a ProtocolVersionValidation instead of a ProtocolVersion.

    Variation of fromByteString that takes a ProtocolVersionValidation instead of a ProtocolVersion.

    Use this method when sometimes no protocol version can be passed for the expectedProtocolVersion. For these cases use ProtocolVersionValidation.NoValidation.

    Definition Classes
    HasProtocolVersionedCompanion2HasProtocolVersionedWrapperWithoutContextCompanion
  17. def fromByteString(expectedProtocolVersion: ProtocolVersion)(bytes: OriginalByteString): ParsingResult[Batch[ClosedEnvelope]]

    Deserializes the given bytes and checks that the therein embedded proto version matches the expectedProtocolVersion.

    Deserializes the given bytes and checks that the therein embedded proto version matches the expectedProtocolVersion.

    Use this method whenever the origin of the given bytes cannot be trusted, and for example the proto version message field may be set maliciously. This should be your default choice for deserialization.

    expectedProtocolVersion

    the protocol version on which the sync domain is running on

    bytes

    an untrusted byte string with an embedded proto version

    Definition Classes
    HasProtocolVersionedCompanion2HasProtocolVersionedWrapperWithoutContextCompanion
  18. def fromByteStringLegacy(protocolVersion: ProtocolVersion)(bytes: OriginalByteString): ParsingResult[Batch[ClosedEnvelope]]

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the version to use for the deserialization.

    Use this method when deserializing bytes for classes that have a legacy proto converter to explicitly set the version to use for the deserialization.

    protocolVersion

    protocol version of the bytes to be deserialized

    bytes

    data

    Definition Classes
    HasProtocolVersionedCompanion2
  19. def fromByteStringUnsafe(bytes: OriginalByteString): ParsingResult[Batch[ClosedEnvelope]]

    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.

    bytes

    a trusted byte string with an embedded proto version

    Definition Classes
    HasProtocolVersionedCompanion2HasProtocolVersionedWrapperWithoutContextCompanion
  20. def fromClosed(protocolVersion: ProtocolVersion, envelopes: ClosedEnvelope*): Batch[ClosedEnvelope]
    Annotations
    @VisibleForTesting()
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. implicit def hasVersionedWrapperGetResult(implicit getResultByteArray: GetResult[Array[Byte]]): GetResult[Batch[ClosedEnvelope]]
  23. implicit def hasVersionedWrapperGetResultO(implicit getResultByteArray: GetResult[Option[Array[Byte]]]): GetResult[Option[Batch[ClosedEnvelope]]]
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  25. def invariants: Seq[Invariant]
    Definition Classes
    HasSupportedProtoVersions
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. 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
    BatchHasProtocolVersionedWrapperCompanionHasSupportedProtoVersions
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. def of[M <: ProtocolMessage](protocolVersion: ProtocolVersion, envs: (M, Recipients)*): Batch[OpenEnvelope[M]]
  32. def openEnvelopes(batch: Batch[ClosedEnvelope])(protocolVersion: ProtocolVersion, hashOps: HashOps): (Batch[OpenEnvelope[ProtocolMessage]], Seq[ProtoDeserializationError])
  33. def parseDelimitedFromUnsafe(input: InputStream): Option[ParsingResult[Batch[ClosedEnvelope]]]

    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
    HasProtocolVersionedCompanion2
  34. 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
    HasSupportedProtoVersions
  35. def protoVersionFor(protocolVersion: RepresentativeProtocolVersion[Batch.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
    HasSupportedProtoVersions
  36. def protocolVersionRepresentativeFor(protoVersion: ProtoVersion): ParsingResult[RepresentativeProtocolVersion[Batch.this.type]]

    Return the representative protocol version corresponding to the proto version

    Return the representative protocol version corresponding to the proto version

    Definition Classes
    HasSupportedProtoVersions
  37. def protocolVersionRepresentativeFor(protocolVersion: ProtocolVersion): RepresentativeProtocolVersion[Batch.this.type]
    Definition Classes
    HasSupportedProtoVersions
  38. def readFromFileUnsafe(inputFile: String): Either[String, Batch[ClosedEnvelope]]

    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
    HasProtocolVersionedCompanion2
  39. def supportedProtoVersion[Proto <: GeneratedMessage](p: GeneratedMessageCompanion[Proto])(fromProto: (Proto) => ParsingResult[Batch[ClosedEnvelope]]): Deserializer
    Attributes
    protected
    Definition Classes
    HasProtocolVersionedCompanion2
  40. val supportedProtoVersions: SupportedProtoVersions

    Proto versions that are supported by fromByteString See the helper supportedProtoVersion below to define a Parser.

    Proto versions that are supported by fromByteString See the helper supportedProtoVersion below to define a Parser.

    Definition Classes
    BatchHasSupportedProtoVersions
  41. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  42. def toString(): String
    Definition Classes
    AnyRef → Any
  43. def tryProtocolVersionRepresentativeFor(protoVersion: ProtoVersion): RepresentativeProtocolVersion[Batch.this.type]

    Returns the representative protocol version corresponding to the proto version, throws otherwise.

    Returns the representative protocol version corresponding to the proto version, throws otherwise.

    Definition Classes
    HasSupportedProtoVersions
  44. def tryReadFromFileUnsafe(inputFile: String): Batch[ClosedEnvelope]

    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
    HasProtocolVersionedCompanion2
  45. def validateInstance(instance: Batch[Envelope[_]], representativeProtocolVersion: ThisRepresentativeProtocolVersion): Either[String, Unit]

    Will check that default value rules defined in companionObj.defaultValues hold.

    Will check that default value rules defined in companionObj.defaultValues hold.

    Definition Classes
    HasProtocolVersionedWrapperCompanion
  46. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  47. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  48. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. object LegacyProtoConverter extends Serializable
    Definition Classes
    HasSupportedProtoVersions
  50. object SupportedProtoVersions extends Serializable
    Definition Classes
    HasSupportedProtoVersions
  51. object UnsupportedProtoCodec extends Serializable
    Definition Classes
    HasSupportedProtoVersions
  52. object VersionedProtoConverter extends Serializable
    Definition Classes
    HasSupportedProtoVersions

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Ungrouped