Struct libp2p::floodsub::Floodsub

pub struct Floodsub { /* fields omitted */ }

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<Vec<u8, Global>>
)

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<Vec<u8, Global>>
)

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<Vec<u8, Global>>
)

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<Vec<u8, Global>>
)

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 ProtocolsHandler = OneShotHandler<FloodsubProtocol, FloodsubRpc, InnerMessage>

Handler for all the protocols the network behaviour supports.

type OutEvent = FloodsubEvent

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

pub fn new_handler(
    &mut self
) -> <Floodsub as NetworkBehaviour>::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

pub fn addresses_of_peer(&mut self, &PeerId) -> Vec<Multiaddr, Global>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

pub fn inject_connected(&mut self, id: &PeerId)

Indicate to the behaviour that we connected to the node with the given peer id.

pub fn inject_disconnected(&mut self, id: &PeerId)

Indicates to the behaviour that we disconnected from the node with the given peer id.

pub fn inject_event(
    &mut self,
    propagation_source: PeerId,
    _connection: ConnectionId,
    event: InnerMessage
)

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

pub fn poll(
    &mut self,
    &mut Context<'_>,
    &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<<Floodsub as NetworkBehaviour>::ProtocolsHandler as ProtocolsHandler>::InEvent, <Floodsub as NetworkBehaviour>::OutEvent>>

Polls for things that swarm should do.

fn inject_connection_established(
    &mut self,
    &PeerId,
    &ConnectionId,
    &ConnectedPoint
)

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(&mut self, &PeerId, &ConnectionId, &ConnectedPoint)

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_addr_reach_failure(
    &mut self,
    _peer_id: Option<&PeerId>,
    _addr: &Multiaddr,
    _error: &dyn Error
)

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, _peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

fn inject_new_listener(&mut self, _id: ListenerId)

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_expired_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.