package protocol
- Alphabetic
- Public
- Protected
Type Members
- case class AcknowledgeRequest extends HasProtocolVersionedWrapper[AcknowledgeRequest] with ProtocolVersionedMemoizedEvidence with Product with Serializable
- case class Batch[+Env <: Envelope[_]] extends HasProtocolVersionedWrapper[Batch[Envelope[_]]] with PrettyPrinting with Product with Serializable
A batch is a a list of
n
tuples(m
i, recipients
i), wherem
i is a message, andrecipients
i is the list of recipients of mi, for0 <= i < n
. - case class ClosedEnvelope(bytes: ByteString, recipients: Recipients) extends Envelope[ByteString] with Product with Serializable
A ClosedEnvelope's contents are serialized as a com.google.protobuf.ByteString.
- case class Deliver[+Env <: Envelope[_]] extends SequencedEvent[Env] with Product with Serializable
Intuitively, the member learns all envelopes addressed to it.
Intuitively, the member learns all envelopes addressed to it. It learns some recipients of these envelopes, as defined by com.digitalasset.canton.sequencing.protocol.Recipients.forMember
- sealed abstract case class DeliverError extends SequencedEvent[Nothing] with NoCopy with Product with Serializable
- sealed trait DeliverErrorReason extends PrettyPrinting
Why was the sequencer unable to sequence the requested send
- trait Envelope[+M] extends PrettyPrinting
An Envelope wraps an envelope content such as a com.digitalasset.canton.protocol.messages.ProtocolMessage together with the recipients.
An Envelope wraps an envelope content such as a com.digitalasset.canton.protocol.messages.ProtocolMessage together with the recipients.
- M
The type of the envelope content
- final case class HandshakeRequest(clientProtocolVersions: Seq[ProtocolVersion], minimumProtocolVersion: Option[ProtocolVersion]) extends Product with Serializable
- sealed trait HandshakeResponse extends AnyRef
- sealed trait MaxRequestSizeToDeserialize extends AnyRef
- case class MessageId(str: String73) extends LengthLimitedStringWrapper with PrettyPrinting with Product with Serializable
Identifier assigned by caller to a submission request.
- case class OpenEnvelope[+M <: ProtocolMessage](protocolMessage: M, recipients: Recipients, protocolVersion: ProtocolVersion) extends Envelope[M] with Product with Serializable
An OpenEnvelope contains a not serialized protocol message
An OpenEnvelope contains a not serialized protocol message
- M
The type of the protocol message
- final case class Recipients(trees: NonEmpty[Seq[RecipientsTree]]) extends PrettyPrinting with Product with Serializable
Recipients of a batch.
Recipients of a batch. Uses a list of com.digitalasset.canton.sequencing.protocol.RecipientsTrees that define the members receiving a batch, and which members see which other recipients.
- case class RecipientsTree(recipientGroup: NonEmpty[Set[Member]], children: Seq[RecipientsTree]) extends PrettyPrinting with Product with Serializable
A tree representation of the recipients for a batch.
A tree representation of the recipients for a batch. Each member receiving the batch should see only subtrees of recipients from a node containing the member. If a member is present in a subtree A and a sub-subtree of A then it should only see the top-level subtree A.
- sealed trait SendAsyncError extends PrettyPrinting
Synchronous error returned by a sequencer.
- case class SendAsyncResponse(error: Option[SendAsyncError]) extends Product with Serializable
- sealed trait SequencedEvent[+Env <: Envelope[_]] extends Product with Serializable with ProtocolVersionedMemoizedEvidence with PrettyPrinting with HasProtocolVersionedWrapper[SequencedEvent[Envelope[_]]]
The Deliver events are received as a consequence of a Send command, received by the recipients of the originating Send event.
- case class SignedContent[+A <: ProtocolVersionedMemoizedEvidence](content: A, signature: Signature, timestampOfSigningKey: Option[CantonTimestamp]) extends HasProtocolVersionedWrapper[SignedContent[ProtocolVersionedMemoizedEvidence]] with Serializable with Product
- timestampOfSigningKey
The timestamp of the topology snapshot that was used for signing the content. scala.None$ if the signing timestamp can be derived from the content.
- case class SubmissionRequest extends HasProtocolVersionedWrapper[SubmissionRequest] with ProtocolVersionedMemoizedEvidence with Product with Serializable
- final case class SubscriptionRequest(member: Member, counter: SequencerCounter)(representativeProtocolVersion: RepresentativeProtocolVersion[SubscriptionRequest]) extends HasProtocolVersionedWrapper[SubscriptionRequest] with Product with Serializable
A request to receive events from a given counter from a sequencer.
A request to receive events from a given counter from a sequencer.
- member
the member subscribing to the sequencer
- counter
the counter of the first event to receive.
- case class SubscriptionResponse(signedSequencedEvent: Traced[SignedContent[SequencedEvent[ClosedEnvelope]]]) extends Product with Serializable
- final case class VerifyActiveRequest() extends Product with Serializable
- sealed trait VerifyActiveResponse extends AnyRef
- final case class WithRecipients[+A](x: A, recipients: Recipients) extends Product with Serializable
Value Members
- object AcknowledgeRequest extends HasMemoizedProtocolVersionedWrapperCompanion[AcknowledgeRequest] with Serializable
- object Batch extends HasProtocolVersionedSerializerCompanion[Batch[Envelope[_]]] with Serializable
- object ClosedEnvelope extends Serializable
- object Deliver extends Serializable
- object DeliverError extends Serializable
- object DeliverErrorReason
- object HandshakeRequest extends Serializable
- object HandshakeResponse
- object MaxRequestSizeToDeserialize
- object MessageId extends LengthLimitedStringWrapperCompanion[String73, MessageId] with Serializable
- object OpenEnvelope extends Serializable
- object Recipients extends Serializable
- object RecipientsTree extends Serializable
- object SendAsyncError
- object SendAsyncResponse extends Serializable
- object SequencedEvent extends HasProtocolVersionedSerializerCompanion[SequencedEvent[Envelope[_]]] with Serializable
- object SignedContent extends Serializable
- object SubmissionRequest extends HasMemoizedProtocolVersionedWithContextCompanion[SubmissionRequest, MaxRequestSizeToDeserialize] with Serializable
- object SubscriptionRequest extends HasProtocolVersionedCompanion[SubscriptionRequest] with Serializable
- object SubscriptionResponse extends Serializable
- object VerifyActiveResponse
- object WithRecipients extends Serializable