[−][src]Struct libp2p_floodsub::Floodsub
Network behaviour that automatically identifies nodes periodically, and returns information about them.
Methods
impl<TSubstream> Floodsub<TSubstream>
[src]
pub fn new(local_peer_id: PeerId) -> Self
[src]
Creates a Floodsub
.
pub fn add_node_to_partial_view(&mut self, peer_id: PeerId)
[src]
Add a node to the list of nodes to propagate messages to.
pub fn remove_node_from_partial_view(&mut self, peer_id: &PeerId)
[src]
Remove a node from the list of nodes to propagate messages to.
impl<TSubstream> Floodsub<TSubstream>
[src]
pub fn subscribe(&mut self, topic: Topic) -> bool
[src]
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
[src]
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>>)
[src]
Publishes a message to the network, if we're subscribed to the topic only.
pub fn publish_any(
&mut self,
topic: impl Into<TopicHash>,
data: impl Into<Vec<u8>>
)
[src]
&mut self,
topic: impl Into<TopicHash>,
data: impl Into<Vec<u8>>
)
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<TopicHash>>,
data: impl Into<Vec<u8>>
)
[src]
&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.
pub fn publish_many_any(
&mut self,
topic: impl IntoIterator<Item = impl Into<TopicHash>>,
data: impl Into<Vec<u8>>
)
[src]
&mut self,
topic: impl IntoIterator<Item = impl Into<TopicHash>>,
data: impl Into<Vec<u8>>
)
Publishes a message with multiple topics to the network, even if we're not subscribed to any of the topics.
Trait Implementations
impl<TSubstream> NetworkBehaviour for Floodsub<TSubstream> where
TSubstream: AsyncRead + AsyncWrite,
[src]
TSubstream: AsyncRead + AsyncWrite,
type ProtocolsHandler = OneShotHandler<TSubstream, FloodsubConfig, 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.
fn new_handler(&mut self) -> Self::ProtocolsHandler
[src]
fn addresses_of_peer(&mut self, _: &PeerId) -> Vec<Multiaddr>
[src]
fn inject_connected(&mut self, id: PeerId, _: ConnectedPoint)
[src]
fn inject_disconnected(&mut self, id: &PeerId, _: ConnectedPoint)
[src]
fn inject_node_event(&mut self, propagation_source: PeerId, event: InnerMessage)
[src]
fn poll(
&mut self,
_: &mut impl PollParameters
) -> Async<NetworkBehaviourAction<<Self::ProtocolsHandler as ProtocolsHandler>::InEvent, Self::OutEvent>>
[src]
&mut self,
_: &mut impl PollParameters
) -> Async<NetworkBehaviourAction<<Self::ProtocolsHandler as ProtocolsHandler>::InEvent, Self::OutEvent>>
fn inject_replaced(
&mut self,
peer_id: PeerId,
closed_endpoint: ConnectedPoint,
new_endpoint: ConnectedPoint
)
[src]
&mut self,
peer_id: PeerId,
closed_endpoint: ConnectedPoint,
new_endpoint: ConnectedPoint
)
Indicates the behaviour that we replace the connection from the node with another. Read more
fn inject_addr_reach_failure(
&mut self,
_peer_id: Option<&PeerId>,
_addr: &Multiaddr,
_error: &dyn Error
)
[src]
&mut self,
_peer_id: Option<&PeerId>,
_addr: &Multiaddr,
_error: &dyn Error
)
Indicates to the behaviour that we tried to reach an address, but failed. Read more
fn inject_dial_failure(&mut self, _peer_id: &PeerId)
[src]
Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed. Read more
fn inject_new_listen_addr(&mut self, _addr: &Multiaddr)
[src]
Indicates to the behaviour that we have started listening on a new multiaddr.
fn inject_expired_listen_addr(&mut self, _addr: &Multiaddr)
[src]
Indicates to the behaviour that a new multiaddr we were listening on has expired, which means that we are no longer listening in it. Read more
fn inject_new_external_addr(&mut self, _addr: &Multiaddr)
[src]
Indicates to the behaviour that we have discovered a new external address for us.
fn inject_listener_error(
&mut self,
_id: ListenerId,
_err: &(dyn Error + 'static)
)
[src]
&mut self,
_id: ListenerId,
_err: &(dyn Error + 'static)
)
A listener experienced an error.
fn inject_listener_closed(&mut self, _id: ListenerId)
[src]
A listener closed.
Auto Trait Implementations
impl<TSubstream> Sync for Floodsub<TSubstream> where
TSubstream: Sync,
TSubstream: Sync,
impl<TSubstream> Send for Floodsub<TSubstream> where
TSubstream: Send,
TSubstream: Send,
impl<TSubstream> Unpin for Floodsub<TSubstream> where
TSubstream: Unpin,
TSubstream: Unpin,
impl<TSubstream> RefUnwindSafe for Floodsub<TSubstream> where
TSubstream: RefUnwindSafe,
TSubstream: RefUnwindSafe,
impl<TSubstream> UnwindSafe for Floodsub<TSubstream> where
TSubstream: UnwindSafe,
TSubstream: UnwindSafe,
Blanket Implementations
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Same<T> for T
type Output = T
Should always be Self