Struct Floodsub

pub struct Floodsub { /* private fields */ }

Available on crate feature floodsub only.

Network behaviour that handles the floodsub protocol.

Implementations

impl Floodsub

pub fn new(local_peer_id: PeerId) -> Floodsub

Creates a Floodsub with default configuration.

pub fn from_config(config: FloodsubConfig) -> Floodsub

Creates a Floodsub with the given configuration.

pub fn add_node_to_partial_view(&mut self, peer_id: PeerId)

Add a node to the list of nodes to propagate messages to.

pub fn remove_node_from_partial_view(&mut self, peer_id: &PeerId)

Remove a node from the list of nodes to propagate messages to.

pub fn subscribe(&mut self, topic: Topic) -> bool

Subscribes to a topic.

Returns true if the subscription worked. Returns false if we were already subscribed.

pub fn unsubscribe(&mut self, topic: Topic) -> bool

Unsubscribes from a topic.

Note that this only requires the topic name.

Returns true if we were subscribed to this topic.

pub fn publish(&mut self, topic: impl Into<Topic>, data: impl Into<Bytes>)

Publishes a message to the network, if we’re subscribed to the topic only.

pub fn publish_any(&mut self, topic: impl Into<Topic>, data: impl Into<Bytes>)

Publishes a message to the network, even if we’re not subscribed to the topic.

pub fn publish_many( &mut self, topic: impl IntoIterator<Item = impl Into<Topic>>, data: impl Into<Bytes>, )

Publishes a message with multiple topics to the network.

Note: Doesn’t do anything if we’re not subscribed to any of the topics.

pub fn publish_many_any( &mut self, topic: impl IntoIterator<Item = impl Into<Topic>>, data: impl Into<Bytes>, )

Publishes a message with multiple topics to the network, even if we’re not subscribed to any of the topics.

Trait Implementations

impl NetworkBehaviour for Floodsub

type ConnectionHandler = OneShotHandler<FloodsubProtocol, FloodsubRpc, InnerMessage>

Handler for all the protocols the network behaviour supports.

type ToSwarm = FloodsubEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: &Multiaddr, ) -> Result<<Floodsub as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint, _: PortUse, ) -> Result<<Floodsub as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, propagation_source: PeerId, connection_id: ConnectionId, event: <<Floodsub as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour, )

Informs the behaviour about an event generated by the ConnectionHandler dedicated to the peer identified by peer_id. for the behaviour.

fn poll( &mut self, _: &mut Context<'_>, ) -> Poll<ToSwarm<<Floodsub as NetworkBehaviour>::ToSwarm, <<Floodsub as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>

Polls for things that swarm should do.

fn on_swarm_event(&mut self, event: FromSwarm<'_>)

Informs the behaviour about an event from the Swarm.

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, _maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.