Struct communication::behaviour::P2PNetworkBehaviour

pub struct P2PNetworkBehaviour<Req: MessageEvent, Res: MessageEvent> { /* fields omitted */ }

The P2PNetworkBehaviour determines the behaviour of the p2p-network. It combines the following protocols from libp2p

• mDNS for peer discovery within the local network
• identify-protocol to receive identifying information of the remote peer
• RequestResponse Protocol for sending generic request Req and response Res messages

The P2PNetworkBehaviour itself is only effective if a new [ExpandedSwarm] is created for it, this swarm is the entry point for all communication to remote peers, and contains the current state.

The P2PNetworkBehaviour implements a custom poll method that creates P2PEvents from the events of the different protocols, it can be polled with the next() or next_event() methods of the [ExpandedSwarm].

Implementations

impl<Req: MessageEvent, Res: MessageEvent> P2PNetworkBehaviour<Req, Res>

pub async fn init_swarm(
    local_keys: Keypair,
    config: BehaviourConfig
) -> Result<Swarm<P2PNetworkBehaviour<Req, Res>>, BehaviourError>

Creates a new P2PNetworkBehaviour and returns the swarm for it. The returned Swarm<P2PNetworkBehaviour> is the entry point for all communication with remote peers, i.g. to send requests and responses. Additionally to the methods of the P2PNetworkBehaviour there is a range of [libp2p::ExpandedSwarm] functions that can be used for swarm interaction like dialing a new peer.

Example

use async_std::task;
use communication::behaviour::{BehaviourConfig, P2PNetworkBehaviour};
use libp2p::identity::Keypair;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Request {
    Ping,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum Response {
    Pong,
}

let local_keys = Keypair::generate_ed25519();
let config = BehaviourConfig::default();
let mut swarm = task::block_on(P2PNetworkBehaviour::<Request, Response>::init_swarm(local_keys, config))
    .expect("Init swarm failed.");

pub fn add_peer_addr(&mut self, peer_id: PeerId, addr: Multiaddr)

pub fn remove_peer_addr(&mut self, peer_id: &PeerId, addr: &Multiaddr)

pub fn remove_peer(&mut self, peer_id: &PeerId) -> Option<Vec<Multiaddr>>

pub fn get_peer_addr(&self, peer_id: &PeerId) -> Option<&Vec<Multiaddr>>

pub fn get_all_peers(&self) -> Vec<&PeerId>

pub fn get_active_mdns_peers(&mut self) -> Vec<&PeerId>

Get the peers discovered by mdns

pub fn send_request(&mut self, peer_id: &PeerId, request: Req) -> RequestId

pub fn send_response(
    &mut self,
    request_id: &RequestId,
    response: Res
) -> Result<(), Res>

Trait Implementations

impl<Req: MessageEvent, Res: MessageEvent> NetworkBehaviour for P2PNetworkBehaviour<Req, Res> where
    Mdns: NetworkBehaviour,
    Self: NetworkBehaviourEventProcess<<Mdns as NetworkBehaviour>::OutEvent>,
    Identify: NetworkBehaviour,
    Self: NetworkBehaviourEventProcess<<Identify as NetworkBehaviour>::OutEvent>,
    RequestResponse<MessageCodec<Req, Res>>: NetworkBehaviour,
    Self: NetworkBehaviourEventProcess<<RequestResponse<MessageCodec<Req, Res>> as NetworkBehaviour>::OutEvent>,
    Relay: NetworkBehaviour,
    Self: NetworkBehaviourEventProcess<<Relay as NetworkBehaviour>::OutEvent>, 

type ProtocolsHandler = IntoProtocolsHandlerSelect<IntoProtocolsHandlerSelect<IntoProtocolsHandlerSelect<<Mdns as NetworkBehaviour>::ProtocolsHandler, <Identify as NetworkBehaviour>::ProtocolsHandler>, <RequestResponse<MessageCodec<Req, Res>> as NetworkBehaviour>::ProtocolsHandler>, <Relay as NetworkBehaviour>::ProtocolsHandler>

Handler for all the protocols the network behaviour supports.

type OutEvent = P2PEvent<Req, Res>

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

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

Creates a new ProtocolsHandler for a connection with a peer.

fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

fn inject_connected(&mut self, peer_id: &PeerId)

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

fn inject_disconnected(&mut self, peer_id: &PeerId)

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

fn inject_connection_established(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    endpoint: &ConnectedPoint
)

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

fn inject_address_change(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    old: &ConnectedPoint,
    new: &ConnectedPoint
)

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

fn inject_connection_closed(
    &mut self,
    peer_id: &PeerId,
    connection_id: &ConnectionId,
    endpoint: &ConnectedPoint
)

Informs the behaviour about a closed connection to a peer.

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.

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.

fn inject_new_listener(&mut self, id: ListenerId)

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

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

fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_new_external_addr(&mut self, addr: &Multiaddr)

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

fn inject_expired_external_addr(&mut self, addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.

fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))

A listener experienced an error.

fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)

A listener closed.

fn inject_event(
    &mut self,
    peer_id: PeerId,
    connection_id: ConnectionId,
    event: <<Self::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent
)

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

fn poll(
    &mut self,
    cx: &mut Context<'_>,
    poll_params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<<Self::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.

impl<Req: MessageEvent, Res: MessageEvent> NetworkBehaviourEventProcess<()> for P2PNetworkBehaviour<Req, Res>

fn inject_event(&mut self, _: ())

Called when one of the fields of the type you’re deriving NetworkBehaviour on generates an event.

impl<Req: MessageEvent, Res: MessageEvent> NetworkBehaviourEventProcess<IdentifyEvent> for P2PNetworkBehaviour<Req, Res>

fn inject_event(&mut self, event: IdentifyEvent)

Called when one of the fields of the type you’re deriving NetworkBehaviour on generates an event.

impl<Req: MessageEvent, Res: MessageEvent> NetworkBehaviourEventProcess<MdnsEvent> for P2PNetworkBehaviour<Req, Res>

fn inject_event(&mut self, event: MdnsEvent)

Called when one of the fields of the type you’re deriving NetworkBehaviour on generates an event.

impl<Req: MessageEvent, Res: MessageEvent> NetworkBehaviourEventProcess<RequestResponseEvent<Req, Res, Res>> for P2PNetworkBehaviour<Req, Res>

fn inject_event(&mut self, event: RequestResponseEvent<Req, Res>)

Called when one of the fields of the type you’re deriving NetworkBehaviour on generates an event.