Struct libp2p::gossipsub::Gossipsub

pub struct Gossipsub { /* fields omitted */ }

Network behaviour that handles the gossipsub protocol.

NOTE: Initialisation requires a MessageAuthenticity and GossipsubConfig instance. If message signing is disabled, the ValidationMode in the config should be adjusted to an appropriate level to accept unsigned messages.

Implementations

impl Gossipsub

pub fn new(privacy: MessageAuthenticity, config: GossipsubConfig) -> Gossipsub

Creates a Gossipsub struct given a set of parameters specified via a GossipsubConfig.

pub fn topics(&self) -> impl Iterator<Item = &TopicHash>

Lists the hashes of the topics we are currently subscribed to.

pub fn peers(&self, topic_hash: &TopicHash) -> impl Iterator<Item = &PeerId>

Lists peers for a certain topic hash.

pub fn all_peers(&self) -> impl Iterator<Item = &PeerId>

Lists all peers for any topic.

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

Subscribe 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.

Returns true if we were subscribed to this topic.

pub fn publish(
    &mut self,
    topic: &Topic,
    data: impl Into<Vec<u8, Global>>
) -> Result<(), PublishError>

Publishes a message to the network.

pub fn publish_many(
    &mut self,
    topics: impl IntoIterator<Item = Topic>,
    data: impl Into<Vec<u8, Global>>
) -> Result<(), PublishError>

Publishes a message with multiple topics to the network.

pub fn validate_message(
    &mut self,
    message_id: &MessageId,
    propagation_source: &PeerId
) -> bool

This function should be called when config.validate_messages is true in order to validate and propagate messages. Messages are stored in the [‘Memcache’] and validation is expected to be fast enough that the messages should still exist in the cache.

Calling this function will propagate a message stored in the cache, if it still exists. If the message still exists in the cache, it will be forwarded and this function will return true, otherwise it will return false.

The propagation_source parameter indicates who the message was received by and will not be forwarded back to that peer.

This should only be called once per message.

Trait Implementations

impl Debug for Gossipsub

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl NetworkBehaviour for Gossipsub

type ProtocolsHandler = GossipsubHandler

Handler for all the protocols the network behaviour supports.

type OutEvent = GossipsubEvent

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

pub fn new_handler(
    &mut self
) -> <Gossipsub 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)

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

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

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

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

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,
    cx: &mut Context<'_>,
    &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<<Gossipsub as NetworkBehaviour>::ProtocolsHandler as ProtocolsHandler>::InEvent, <Gossipsub as NetworkBehaviour>::OutEvent>>

Polls for things that swarm should do.

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

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

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

Informs the behaviour about a closed connection to a peer.

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

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

pub 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.

pub 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.

pub fn inject_new_listen_addr(&mut self, _addr: &Multiaddr)

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

pub 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.

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

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

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

A listener experienced an error.

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

A listener closed.