Struct libp2p::floodsub::Floodsub

pub struct Floodsub<TSubstream> { /* fields omitted */ }

Network behaviour that automatically identifies nodes periodically, and returns information about them.

Methods

impl<TSubstream> Floodsub<TSubstream>

pub fn new(local_peer_id: PeerId) -> Floodsub<TSubstream>

Creates a Floodsub.

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.

impl<TSubstream> Floodsub<TSubstream>

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<impl AsRef>(
    &mut self,
    topic: impl AsRef
) -> bool where
    impl AsRef: AsRef<TopicHash>, 

Unsubscribes from a topic.

Note that this only requires a TopicHash and not a full Topic.

Returns true if we were subscribed to this topic.

pub fn publish<impl Into, impl Into>>(
    &mut self,
    topic: impl Into,
    data: impl Into>
) where
    impl Into: Into<TopicHash>,
    impl Into>: Into<Vec<u8>>, 

Publishes a message to the network.

Note: Doesn't do anything if we're not subscribed to the topic.

pub fn publish_many<impl Into, impl IntoIterator>, impl Into>>(
    &mut self,
    topic: impl IntoIterator>,
    data: impl Into>
) where
    impl Into: Into<TopicHash>,
    impl Into>: Into<Vec<u8>>,
    impl IntoIterator>: IntoIterator<Item = impl Into>, 

Publishes a message with multiple topics to the network.

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

Trait Implementations

impl<TSubstream> NetworkBehaviour for Floodsub<TSubstream> where
    TSubstream: AsyncRead + AsyncWrite, 

type ProtocolsHandler = OneShotHandler<TSubstream, FloodsubConfig, FloodsubRpc, InnerMessage>

Handler for all the protocols the network supports.

type OutEvent = FloodsubEvent

Event generated by the swarm.

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

Creates a new ProtocolsHandler for a connection with a peer.

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

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

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

Indicates the behaviour that we connected to the node with the given peer id through the given endpoint.

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

Indicates the behaviour that we disconnected from the node with the given peer id. The endpoint is the one we used to be connected to.

fn inject_node_event(&mut self, propagation_source: PeerId, event: InnerMessage)

Indicates the behaviour that the node with the given peer id has generated an event for us.

fn poll(
    &mut self,
    &mut PollParameters
) -> Async<NetworkBehaviourAction<<<Floodsub<TSubstream> as NetworkBehaviour>::ProtocolsHandler as ProtocolsHandler>::InEvent, <Floodsub<TSubstream> as NetworkBehaviour>::OutEvent>>

Polls for things that swarm should do.

fn inject_replaced(
    &mut self,
    peer_id: PeerId,
    closed_endpoint: ConnectedPoint,
    new_endpoint: ConnectedPoint
)

Indicates the behaviour that we replace the connection from the node with another.

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_listen_addr(&mut self, _addr: &Multiaddr)

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

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

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

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

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