Struct Behaviour

pub struct Behaviour<P: Protocol> { /* private fields */ }

Implementations

impl<P: Protocol> Behaviour<P>

Public API.

pub fn new(config: Config, protocol: P) -> Self

Creates a new Behaviour from the given configuration and protocol.

pub fn connections(&self) -> &ConnectionsService

Get a reference to the connections service.

pub fn subscriptions(&self) -> &BTreeSet<TopicHash>

Get local node topic subscriptions.

pub fn peer_subscriptions( &self, peer_id: &PeerId, ) -> Option<&BTreeSet<TopicHash>>

Get peer topic subscriptions.

pub fn subscribe(&mut self, sub: impl Into<Subscription>) -> Result<bool>

Subscribe to topic.

Returns Ok(true) if the subscription was successful, Ok(false) if we were already subscribed to the topic.

pub fn unsubscribe<H: Hasher>(&mut self, topic: &Topic<H>) -> Result<bool>

Unsubscribe from topic.

Returns Ok(true) if the unsubscription was successful, Ok(false) if we were not subscribed to the topic.

pub fn publish(&mut self, message: Message) -> Result<()>

Publish a message to the network.

Trait Implementations

impl<P> NetworkBehaviour for Behaviour<P>

where P: Protocol + 'static,

type ConnectionHandler = Handler<<P as Protocol>::Upgrade>

Handler for all the protocols the network behaviour supports.

type ToSwarm = Event

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

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer_id: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer_id: PeerId, remote_addr: &Multiaddr, _role_override: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, peer_id: PeerId, _connection_id: ConnectionId, event: THandlerOutEvent<Self>, )

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

fn poll( &mut self, cx: &mut Context<'_>, _params: &mut impl PollParameters, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, _maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.