Struct libp2p_networking::network::def::NetworkDef

pub struct NetworkDef<K: SignatureKey + 'static> {
    gossipsub: Behaviour,
    pub dht: Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>,
    identify: Behaviour,
    pub direct_message: Behaviour<Vec<u8>, Vec<u8>>,
    pub autonat: Behaviour,
}

Overarching network behaviour performing:

• network topology discovery
• direct messaging
• p2p broadcast
• connection management

Fields

gossipsub: Behaviour

purpose: broadcasting messages to many peers NOTE gossipsub works ONLY for sharing messages right now in the future it may be able to do peer discovery and routing https://github.com/libp2p/rust-libp2p/issues/2398

dht: Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>

The DHT store. We use a FileBackedStore to occasionally save the DHT to a file on disk and a ValidatedStore to validate the records stored.

identify: Behaviour

purpose: identifying the addresses from an outside POV

direct_message: Behaviour<Vec<u8>, Vec<u8>>

purpose: directly messaging peer

autonat: Behaviour

Auto NAT behaviour to determine if we are publicly reachable and by which address

Implementations

impl<K: SignatureKey + 'static> NetworkDef<K>

pub fn new( gossipsub: GossipBehaviour, dht: Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>, identify: IdentifyBehaviour, direct_message: Behaviour<Vec<u8>, Vec<u8>>, autonat: Behaviour, ) -> NetworkDef<K>

Create a new instance of a NetworkDef

impl<K: SignatureKey + 'static> NetworkDef<K>

Address functions

pub fn add_address(&mut self, peer_id: &PeerId, address: Multiaddr)

Add an address

impl<K: SignatureKey + 'static> NetworkDef<K>

Gossip functions

pub fn publish_gossip(&mut self, topic: IdentTopic, contents: Vec<u8>)

Publish a given gossip

pub fn subscribe_gossip(&mut self, t: &str)

Subscribe to a given topic

pub fn unsubscribe_gossip(&mut self, t: &str)

Unsubscribe from a given topic

impl<K: SignatureKey + 'static> NetworkDef<K>

Request/response functions

pub fn add_direct_request( &mut self, peer_id: PeerId, data: Vec<u8>, ) -> OutboundRequestId

Add a direct request for a given peer

pub fn add_direct_response( &mut self, chan: ResponseChannel<Vec<u8>>, msg: Vec<u8>, )

Add a direct response for a channel

Trait Implementations

impl<K: SignatureKey + 'static> Debug for NetworkDef<K>

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

Formats the value using the given formatter.

impl<K: SignatureKey + 'static> NetworkBehaviour for NetworkDef<K>

where Behaviour: NetworkBehaviour, Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>>: NetworkBehaviour, Behaviour: NetworkBehaviour, Behaviour<Vec<u8>, Vec<u8>>: NetworkBehaviour, Behaviour: NetworkBehaviour, NetworkEventInternal: From<<Behaviour as NetworkBehaviour>::ToSwarm> + From<<Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>> as NetworkBehaviour>::ToSwarm> + From<<Behaviour as NetworkBehaviour>::ToSwarm> + From<<Behaviour<Vec<u8>, Vec<u8>> as NetworkBehaviour>::ToSwarm> + From<<Behaviour as NetworkBehaviour>::ToSwarm>,

type ConnectionHandler = ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<<Behaviour as NetworkBehaviour>::ConnectionHandler, <Behaviour<FileBackedStore<ValidatedStore<MemoryStore, K>>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>, <Behaviour<Cbor<Vec<u8>, Vec<u8>>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

type ToSwarm = NetworkEventInternal

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

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

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_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<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

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

Informs the behaviour about an event from the Swarm.