package protocol
- Alphabetic
- Public
- Protected
Type Members
- case class AcknowledgeRequest(member: Member, timestamp: CantonTimestamp) extends HasProtoV0[domain.api.v0.AcknowledgeRequest] with Product with Serializable
- case class Batch[+Env <: Envelope[_]] extends HasVersionedWrapper[VersionedMessage[Batch[Env]]] with HasProtoV0WithVersion[CompressedBatch] 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 NoCopy 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
- case class DeliverError extends SequencedEvent[Nothing] with NoCopy with Product with Serializable
- sealed trait DeliverErrorReason extends HasProtoV0[protocol.v0.DeliverErrorReason] with PrettyPrinting
Why was the sequencer unable to sequence the requested send
- trait Envelope[+M] extends HasProtoV0WithVersion[protocol.v0.Envelope] with 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 HasProtoV0[Request] with Product with Serializable
- sealed trait HandshakeResponse extends HasProtoV0[Response]
- 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) 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
- case class Recipients extends PrettyPrinting with HasProtoV0[protocol.v0.Recipients] 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 HasProtoV0[protocol.v0.RecipientsTree] 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 HasProtoV0[Error] with PrettyPrinting
Synchronous error returned by a sequencer.
- case class SendAsyncResponse(error: Option[SendAsyncError]) extends HasProtoV0[domain.api.v0.SendAsyncResponse] with Product with Serializable
- sealed trait SequencedEvent[+Env] extends Product with Serializable with ProtocolVersionedMemoizedEvidence with PrettyPrinting with HasProtocolVersionedWrapper[VersionedMessage[SequencedEvent[Env]]]
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[VersionedMessage[SignedContent[A]]] with HasProtoV0[protocol.v0.SignedContent] with Product with Serializable
- case class SubmissionRequest extends HasVersionedWrapper[VersionedMessage[SubmissionRequest]] with HasProtoV0WithVersion[domain.api.v0.SubmissionRequest] with Product with Serializable
- case class SubscriptionRequest(member: Member, counter: Long) extends HasProtoV0[domain.api.v0.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 HasProtoV0[domain.api.v0.SubscriptionResponse] with Product with Serializable
- final case class VerifyActiveRequest() extends HasProtoV0[Request] with 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 Serializable
- object Batch extends Serializable
- object ClosedEnvelope extends Serializable
- object Deliver extends Serializable
- object DeliverError extends Serializable
- object DeliverErrorReason
- object HandshakeRequest extends Serializable
- object HandshakeResponse
- 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 Serializable
- object SignedContent extends Serializable
- object SubmissionRequest extends HasVersionedMessageCompanion[SubmissionRequest] with Serializable
- object SubscriptionRequest extends Serializable
- object SubscriptionResponse extends Serializable
- object VerifyActiveResponse
- object WithRecipients extends Serializable