Enum safe_network::messaging::system::SystemMsg

pub enum SystemMsg {
    AntiEntropyRetry {
        section_auth: SectionAuthorityProvider,
        section_signed: KeyedSig,
        proof_chain: SecuredLinkedList,
        bounced_msg: Bytes,
    },
    AntiEntropyRedirect {
        section_auth: SectionAuthorityProvider,
        section_signed: KeyedSig,
        bounced_msg: Bytes,
    },
    AntiEntropyUpdate {
        section_auth: SectionAuthorityProvider,
        section_signed: KeyedSig,
        proof_chain: SecuredLinkedList,
        members: Option<SectionPeers>,
    },
    Relocate(RelocateDetails),
    RelocatePromise(RelocatePromise),
    JoinRequest(Box<JoinRequest>),
    JoinResponse(Box<JoinResponse>),
    JoinAsRelocatedRequest(Box<JoinAsRelocatedRequest>),
    JoinAsRelocatedResponse(Box<JoinAsRelocatedResponse>),
    BouncedUntrustedMessage {
        msg: Box<SystemMsg>,
        dst_section_pk: BlsPublicKey,
    },
    DkgStart {
        dkg_key: DkgKey,
        elder_candidates: ElderCandidates,
    },
    DkgMessage {
        dkg_key: DkgKey,
        message: DkgMessage,
    },
    DkgFailureObservation {
        dkg_key: DkgKey,
        sig: DkgFailureSig,
        failed_participants: BTreeSet<XorName>,
    },
    DkgFailureAgreement(DkgFailureSigSet),
    Propose {
        content: Proposal,
        sig_share: SigShare,
    },
    StartConnectivityTest(XorName),
    NodeCmd(NodeCmd),
    NodeQuery(NodeQuery),
    NodeQueryResponse {
        response: NodeQueryResponse,
        correlation_id: MessageId,
        user: EndUser,
    },
    NodeMsgError {
        error: Error,
        correlation_id: MessageId,
    },
}

Message sent over the among nodes

Variants

AntiEntropyRetry

Message sent to a peer when a message with outdated section information was received, attaching the bounced message so the peer can resend it with up to date destination information.

Fields of AntiEntropyRetry

section_auth: SectionAuthorityProvider

Current SectionAuthorityProvider of the sender’s section.

section_signed: KeyedSig

Sender’s section signature over the SectionAuthorityProvider.

proof_chain: SecuredLinkedList

Sender’s section chain truncated from the dest section key found in the bounced_msg.

bounced_msg: Bytes

Message bounced due to outdated destination section information.

AntiEntropyRedirect

Message sent to a peer when a message needs to be sent to a different and/or closest section, attaching the bounced message so the peer can resend it to the correct section with up to date destination information.

Fields of AntiEntropyRedirect

section_auth: SectionAuthorityProvider

Current SectionAuthorityProvider of a closest section.

section_signed: KeyedSig

Section signature over the SectionAuthorityProvider of the closest section the bounced message shall be resent to.

bounced_msg: Bytes

Message bounced that shall be resent by the peer.

AntiEntropyUpdate

Message to update a section when they bounced a message as untrusted back at us. That section must be behind our current knowledge.

Fields of AntiEntropyUpdate

section_auth: SectionAuthorityProvider

Current SectionAuthorityProvider of our section.

section_signed: KeyedSig

Section signature over the SectionAuthorityProvider of our section the bounced message shall be resent to.

proof_chain: SecuredLinkedList

Our section chain truncated from the triggering msg’s dst section_key (or genesis key for full proof)

members: Option<SectionPeers>

Optional section members if we’re updating our own section adults

Relocate(RelocateDetails)

Send from a section to the node to be immediately relocated.

Tuple Fields of Relocate

0: RelocateDetails

RelocatePromise(RelocatePromise)

Send:

• from a section to a current elder to be relocated after they are demoted.
• from the node to be relocated back to its section after it was demoted.

Tuple Fields of RelocatePromise

0: RelocatePromise

JoinRequest(Box<JoinRequest>)

Sent from a bootstrapping peer to the section requesting to join as a new member

Tuple Fields of JoinRequest

0: Box<JoinRequest>

JoinResponse(Box<JoinResponse>)

Response to a JoinRequest

Tuple Fields of JoinResponse

0: Box<JoinResponse>

JoinAsRelocatedRequest(Box<JoinAsRelocatedRequest>)

Sent from a peer to the section requesting to join as relocated from another section

Tuple Fields of JoinAsRelocatedRequest

0: Box<JoinAsRelocatedRequest>

JoinAsRelocatedResponse(Box<JoinAsRelocatedResponse>)

Response to a JoinAsRelocatedRequest

Tuple Fields of JoinAsRelocatedResponse

0: Box<JoinAsRelocatedResponse>

BouncedUntrustedMessage

Sent from a node that can’t establish the trust of the contained message to its original source in order for them to provide new proof that the node would trust.

Fields of BouncedUntrustedMessage

msg: Box<SystemMsg>

Untrsuted Node message

dst_section_pk: BlsPublicKey

Currently known section pk of the source

DkgStart

Sent to the new elder candidates to start the DKG process.

Fields of DkgStart

dkg_key: DkgKey

The identifier of the DKG session to start.

elder_candidates: ElderCandidates

The DKG particpants.

DkgMessage

Message exchanged for DKG process.

Fields of DkgMessage

dkg_key: DkgKey

The identifier of the DKG session this message is for.

message: DkgMessage

The DKG message.

DkgFailureObservation

Broadcast to the other DKG participants when a DKG failure is observed.

Fields of DkgFailureObservation

dkg_key: DkgKey

The DKG key

sig: DkgFailureSig

Signature over the failure

failed_participants: BTreeSet<XorName>

Nodes that failed to participate

DkgFailureAgreement(DkgFailureSigSet)

Sent to the current elders by the DKG participants when at least majority of them observe a DKG failure.

Tuple Fields of DkgFailureAgreement

0: DkgFailureSigSet

Propose

Message containing a single Proposal to be aggregated in the proposal aggregator.

Fields of Propose

content: Proposal

The content of the proposal

sig_share: SigShare

BLS signature share

StartConnectivityTest(XorName)

Message that notifies a section to test the connectivity to a node

Tuple Fields of StartConnectivityTest

0: XorName

NodeCmd(NodeCmd)

Cmds only sent internally in the network.

Tuple Fields of NodeCmd

0: NodeCmd

NodeQuery(NodeQuery)

Queries is a read-only operation.

Tuple Fields of NodeQuery

0: NodeQuery

NodeQueryResponse

The response to a query, containing the query result.

Fields of NodeQueryResponse

response: NodeQueryResponse

QueryResponse.

correlation_id: MessageId

ID of causing query.

user: EndUser

TEMP: Add user here as part of return flow. Remove this as we have chunk routing etc

NodeMsgError

The returned error, from any msg handling on recipient node.

Fields of NodeMsgError

error: Error

The error.

correlation_id: MessageId

ID of causing cmd.

Trait Implementations

impl Clone for SystemMsg

fn clone(&self) -> SystemMsg

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SystemMsg

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemMsg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<SystemMsg> for SystemMsg

fn eq(&self, other: &SystemMsg) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SystemMsg) -> bool

This method tests for !=.

impl Serialize for SystemMsg

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for SystemMsg

impl StructuralEq for SystemMsg

impl StructuralPartialEq for SystemMsg