Struct Behaviour

pub struct Behaviour { /* private fields */ }

Implementations

impl Behaviour

pub fn new(config: Config) -> Self

pub fn new_with_metrics(config: Config, registry: &mut Registry) -> Self

pub fn subscribed(&self) -> impl Iterator<Item = &Topic> + '_

pub fn peers(&self, topic: &Topic) -> Option<impl Iterator<Item = &PeerId> + '_>

pub fn topics(&self, peer: &PeerId) -> Option<impl Iterator<Item = &Topic> + '_>

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

pub fn unsubscribe(&mut self, topic: &Topic)

pub fn broadcast(&mut self, topic: &Topic, msg: Bytes)

Trait Implementations

impl Debug for Behaviour

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

Formats the value using the given formatter.

impl Default for Behaviour

fn default() -> Behaviour

Returns the “default value” for a type.

impl NetworkBehaviour for Behaviour

type ConnectionHandler = OneShotHandler<Config, Message, HandlerEvent>

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: 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: PeerId, _addr: &Multiaddr, _role_override: Endpoint, _port_use: PortUse, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

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

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, peer: PeerId, _: ConnectionId, msg: <Self::ConnectionHandler as ConnectionHandler>::ToBehaviour, )

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, _: &mut Context<'_>) -> Poll<ToSwarm<Event, Message>>

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.