Enum P2pNetworkPubsubAction

pub enum P2pNetworkPubsubAction {
    NewStream {
        incoming: bool,
        peer_id: PeerId,
        addr: ConnectionAddr,
        stream_id: StreamId,
        protocol: BroadcastAlgorithm,
    },
    IncomingData {
        peer_id: PeerId,
        addr: ConnectionAddr,
        stream_id: StreamId,
        data: Data,
        seen_limit: usize,
    },
    ValidateIncomingMessages {
        peer_id: PeerId,
        seen_limit: usize,
        addr: ConnectionAddr,
    },
    IncomingMessage {
        peer_id: PeerId,
        message: Message,
        seen_limit: usize,
    },
    IncomingMessageCleanup {
        peer_id: PeerId,
    },
    Graft {
        peer_id: PeerId,
        topic_id: String,
    },
    Prune {
        peer_id: PeerId,
        topic_id: String,
    },
    WebRtcRebroadcast {
        message: GossipNetMessageV2,
    },
    Broadcast {
        message: GossipNetMessageV2,
    },
    Sign {
        seqno: u64,
        author: PeerId,
        data: Data,
        topic: String,
    },
    SignError {
        author: PeerId,
        topic: String,
    },
    BroadcastSigned {
        signature: Data,
    },
    OutgoingMessage {
        peer_id: PeerId,
    },
    OutgoingMessageClear {
        peer_id: PeerId,
    },
    OutgoingMessageError {
        msg: Rpc,
        peer_id: PeerId,
    },
    OutgoingData {
        data: Data,
        peer_id: PeerId,
    },
    HandleIncomingMessage {
        message: Message,
        message_content: GossipNetMessageV2,
        peer_id: PeerId,
    },
    ValidateIncomingMessage {
        message_id: P2pNetworkPubsubMessageCacheId,
    },
    PruneMessages {},
    RejectMessage {
        message_id: Option<BroadcastMessageId>,
        peer_id: Option<PeerId>,
        reason: String,
    },
    IgnoreMessage {
        message_id: Option<BroadcastMessageId>,
        reason: String,
    },
    BroadcastValidatedMessage {
        message_id: BroadcastMessageId,
    },
}

Actions that can occur within the P2P Network PubSub system.

Managing pubsub streams, handling incoming and outgoing messages, and maintaining the mesh network topology.

Common Fields:

• peer_id: The identifier of the peer associated with the action.
• addr: The connection address of the peer.
• stream_id: The unique identifier of the stream.
• topic_id: The identifier of the topic involved in the action.

Variants

NewStream

Create a new stream, either incoming or outgoing.

Fields:

• incoming: Indicates if the stream is incoming (true) or outgoing (false).
• protocol: The broadcast algorithm used for the stream.

Fields

incoming: bool

peer_id: PeerId

addr: ConnectionAddr

stream_id: StreamId

protocol: BroadcastAlgorithm

IncomingData

Process incoming raw data from a peer.

Fields:

• data: The raw data payload received.
• seen_limit: The limit for tracking seen messages to prevent duplication.

Fields

peer_id: PeerId

addr: ConnectionAddr

stream_id: StreamId

data: Data

seen_limit: usize

ValidateIncomingMessages

Validate a batch of decoded incoming messages.

Fields

peer_id: PeerId

seen_limit: usize

addr: ConnectionAddr

IncomingMessage

Handle a fully decoded and validated message received from a peer.

Fields:

• message: The decoded protobuf message.
• seen_limit: The limit for tracking seen messages to prevent duplication.

Fields

peer_id: PeerId

message: Message

seen_limit: usize

IncomingMessageCleanup

Clean up temporary states after processing an incoming message.

Fields

peer_id: PeerId

Graft

Add a peer to the mesh network for a specific topic.

Fields

peer_id: PeerId

topic_id: String

Prune

Remove a peer from the mesh network for a specific topic.

Fields

peer_id: PeerId

topic_id: String

WebRtcRebroadcast

Rebroadcast message received from WebRTC connection.

Expected to be dispatched after the message has been processed, in spite of whether it was received from libp2p or webrtc network.

If received from libp2p network, or if we have already broadcasted this message, the message will be in the mcache state, in which case the action won’t be enabled (will be filtered out).

Fields

message: GossipNetMessageV2

Broadcast

Initiate the broadcasting of a message to all subscribed peers.

Fields:

• message: The gossip network message to broadcast.

Fields

message: GossipNetMessageV2

Sign

Prepare a message for signing before broadcasting.

Fields:

• seqno: The sequence number of the message.
• author: The identifier of the peer authoring the message.
• data: The data payload of the message.
• topic: The topic under which the message is published.

Fields

seqno: u64

author: PeerId

data: Data

topic: String

SignError

An error occured during the signing process.

Fields

author: PeerId

topic: String

BroadcastSigned

Finalize the broadcasting of a signed message by attaching the signature.

Fields:

• signature: The cryptographic signature of the message.

Fields

signature: Data

OutgoingMessage

Prepare an outgoing message to send to a specific peer.

Fields

peer_id: PeerId

OutgoingMessageClear

Clear the outgoing message state for a specific peer after sending.

Fields

peer_id: PeerId

OutgoingMessageError

An error occured during the sending of an outgoing message.

Fields:

• msg: The protobuf message that failed to send.

Fields

msg: Rpc

peer_id: PeerId

OutgoingData

Send encoded data over an outgoing stream to a specific peer.

Fields:

• data: The encoded data to be sent.

Fields

data: Data

peer_id: PeerId

HandleIncomingMessage

Fields

message: Message

message_content: GossipNetMessageV2

peer_id: PeerId

ValidateIncomingMessage

Fields

message_id: P2pNetworkPubsubMessageCacheId

PruneMessages

Delete expired messages from state

RejectMessage

Fields

message_id: Option<BroadcastMessageId>

peer_id: Option<PeerId>

reason: String

IgnoreMessage

Fields

message_id: Option<BroadcastMessageId>

reason: String

BroadcastValidatedMessage

Fields

message_id: BroadcastMessageId

Trait Implementations

impl ActionEvent for P2pNetworkPubsubAction

fn action_event<T>(&self, context: &T)

where T: EventContext,

impl Clone for P2pNetworkPubsubAction

fn clone(&self) -> P2pNetworkPubsubAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for P2pNetworkPubsubAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for P2pNetworkPubsubAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnablingCondition<P2pState> for P2pNetworkPubsubAction

fn is_enabled(&self, state: &P2pState, _time: Timestamp) -> bool

Enabling condition for the Action.

impl From<P2pNetworkPubsubAction> for P2pAction

fn from(value: P2pNetworkPubsubAction) -> Self

Converts to this type from the input type.

impl From<P2pNetworkPubsubAction> for P2pNetworkAction

fn from(original: P2pNetworkPubsubAction) -> P2pNetworkAction

Converts to this type from the input type.

impl Serialize for P2pNetworkPubsubAction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.