Struct libp2p_floodsub::Floodsub

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

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

Implementations

impl<TSubstream> Floodsub<TSubstream>

pub fn new(local_peer_id: PeerId) -> Self

Creates a Floodsub.

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

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(&mut self, topic: impl Into<TopicHash>, data: impl 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(
    &mut self,
    topic: impl IntoIterator<Item = impl Into<TopicHash>>,
    data: impl Into<Vec<u8>>
)

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, TTopology> NetworkBehaviour<TTopology> for Floodsub<TSubstream>where
    TSubstream: AsyncRead + AsyncWrite,

type ProtocolsHandler = FloodsubHandler<TSubstream>

Handler for all the protocols the network supports.

type OutEvent = FloodsubEvent

Event generated by the swarm.

fn new_handler(&mut self) -> Self::ProtocolsHandler

Builds a new ProtocolsHandler.

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: FloodsubRpc)

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

fn poll(
    &mut self,
    _: &mut PollParameters<'_, TTopology>
) -> Async<NetworkBehaviourAction<<Self::ProtocolsHandler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.