Struct libp2p_networking::network::def::NetworkDef
source · pub struct NetworkDef<K: SignatureKey + 'static> {
gossipsub: Behaviour,
pub dht: Behaviour<ValidatedStore<MemoryStore, K>>,
identify: Behaviour,
pub direct_message: Behaviour<Vec<u8>, Vec<u8>>,
pub autonat: Behaviour,
}
Expand description
Overarching network behaviour performing:
- network topology discovoery
- 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<ValidatedStore<MemoryStore, K>>
purpose: peer routing purpose: storing pub key <-> peer id bijection
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 publically reachable and by which address
Implementations§
source§impl<K: SignatureKey + 'static> NetworkDef<K>
impl<K: SignatureKey + 'static> NetworkDef<K>
sourcepub fn new(
gossipsub: GossipBehaviour,
dht: Behaviour<ValidatedStore<MemoryStore, K>>,
identify: IdentifyBehaviour,
direct_message: Behaviour<Vec<u8>, Vec<u8>>,
autonat: Behaviour,
) -> NetworkDef<K>
pub fn new( gossipsub: GossipBehaviour, dht: Behaviour<ValidatedStore<MemoryStore, K>>, identify: IdentifyBehaviour, direct_message: Behaviour<Vec<u8>, Vec<u8>>, autonat: Behaviour, ) -> NetworkDef<K>
Create a new instance of a NetworkDef
source§impl<K: SignatureKey + 'static> NetworkDef<K>
impl<K: SignatureKey + 'static> NetworkDef<K>
Address functions
sourcepub fn add_address(&mut self, peer_id: &PeerId, address: Multiaddr)
pub fn add_address(&mut self, peer_id: &PeerId, address: Multiaddr)
Add an address
source§impl<K: SignatureKey + 'static> NetworkDef<K>
impl<K: SignatureKey + 'static> NetworkDef<K>
Gossip functions
sourcepub fn publish_gossip(&mut self, topic: IdentTopic, contents: Vec<u8>)
pub fn publish_gossip(&mut self, topic: IdentTopic, contents: Vec<u8>)
Publish a given gossip
sourcepub fn subscribe_gossip(&mut self, t: &str)
pub fn subscribe_gossip(&mut self, t: &str)
Subscribe to a given topic
sourcepub fn unsubscribe_gossip(&mut self, t: &str)
pub fn unsubscribe_gossip(&mut self, t: &str)
Unsubscribe from a given topic
source§impl<K: SignatureKey + 'static> NetworkDef<K>
impl<K: SignatureKey + 'static> NetworkDef<K>
Request/response functions
sourcepub fn add_direct_request(
&mut self,
peer_id: PeerId,
data: Vec<u8>,
) -> OutboundRequestId
pub fn add_direct_request( &mut self, peer_id: PeerId, data: Vec<u8>, ) -> OutboundRequestId
Add a direct request for a given peer
sourcepub fn add_direct_response(
&mut self,
chan: ResponseChannel<Vec<u8>>,
msg: Vec<u8>,
)
pub fn add_direct_response( &mut self, chan: ResponseChannel<Vec<u8>>, msg: Vec<u8>, )
Add a direct response for a channel
Trait Implementations§
source§impl<K: SignatureKey + 'static> Debug for NetworkDef<K>
impl<K: SignatureKey + 'static> Debug for NetworkDef<K>
source§impl<K: SignatureKey + 'static> NetworkBehaviour for NetworkDef<K>where
Behaviour: NetworkBehaviour,
Behaviour<ValidatedStore<MemoryStore, K>>: NetworkBehaviour,
Behaviour: NetworkBehaviour,
Behaviour<Vec<u8>, Vec<u8>>: NetworkBehaviour,
Behaviour: NetworkBehaviour,
NetworkEventInternal: From<<Behaviour as NetworkBehaviour>::ToSwarm> + From<<Behaviour<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>,
impl<K: SignatureKey + 'static> NetworkBehaviour for NetworkDef<K>where
Behaviour: NetworkBehaviour,
Behaviour<ValidatedStore<MemoryStore, K>>: NetworkBehaviour,
Behaviour: NetworkBehaviour,
Behaviour<Vec<u8>, Vec<u8>>: NetworkBehaviour,
Behaviour: NetworkBehaviour,
NetworkEventInternal: From<<Behaviour as NetworkBehaviour>::ToSwarm> + From<<Behaviour<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>,
source§type ConnectionHandler = ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<<Behaviour as NetworkBehaviour>::ConnectionHandler, <Behaviour<ValidatedStore<MemoryStore, K>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>, <Behaviour<Cbor<Vec<u8>, Vec<u8>>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>
type ConnectionHandler = ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<ConnectionHandlerSelect<<Behaviour as NetworkBehaviour>::ConnectionHandler, <Behaviour<ValidatedStore<MemoryStore, K>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>, <Behaviour<Cbor<Vec<u8>, Vec<u8>>> as NetworkBehaviour>::ConnectionHandler>, <Behaviour as NetworkBehaviour>::ConnectionHandler>
source§type ToSwarm = NetworkEventInternal
type ToSwarm = NetworkEventInternal
NetworkBehaviour
and that the swarm will report back.source§fn handle_pending_inbound_connection(
&mut self,
connection_id: ConnectionId,
local_addr: &Multiaddr,
remote_addr: &Multiaddr,
) -> Result<(), ConnectionDenied>
fn handle_pending_inbound_connection( &mut self, connection_id: ConnectionId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>
source§fn handle_established_inbound_connection(
&mut self,
connection_id: ConnectionId,
peer: PeerId,
local_addr: &Multiaddr,
remote_addr: &Multiaddr,
) -> Result<THandler<Self>, ConnectionDenied>
fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>
source§fn handle_pending_outbound_connection(
&mut self,
connection_id: ConnectionId,
maybe_peer: Option<PeerId>,
addresses: &[Multiaddr],
effective_role: Endpoint,
) -> Result<Vec<Multiaddr>, ConnectionDenied>
fn handle_pending_outbound_connection( &mut self, connection_id: ConnectionId, maybe_peer: Option<PeerId>, addresses: &[Multiaddr], effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>
source§fn handle_established_outbound_connection(
&mut self,
connection_id: ConnectionId,
peer: PeerId,
addr: &Multiaddr,
role_override: Endpoint,
) -> Result<THandler<Self>, ConnectionDenied>
fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>
source§fn on_connection_handler_event(
&mut self,
peer_id: PeerId,
connection_id: ConnectionId,
event: THandlerOutEvent<Self>,
)
fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: THandlerOutEvent<Self>, )
ConnectionHandler
]
dedicated to the peer identified by peer_id
. for the behaviour. Read moresource§fn poll(
&mut self,
cx: &mut Context<'_>,
) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>
source§fn on_swarm_event(&mut self, event: FromSwarm<'_>)
fn on_swarm_event(&mut self, event: FromSwarm<'_>)
Swarm
.Auto Trait Implementations§
impl<K> Freeze for NetworkDef<K>
impl<K> !RefUnwindSafe for NetworkDef<K>
impl<K> Send for NetworkDef<K>
impl<K> Sync for NetworkDef<K>
impl<K> Unpin for NetworkDef<K>where
K: Unpin,
impl<K> !UnwindSafe for NetworkDef<K>
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Conv for T
impl<T> Conv for T
§impl<F, W, T, D> Deserialize<With<T, W>, D> for F
impl<F, W, T, D> Deserialize<With<T, W>, D> for F
§fn deserialize(
&self,
deserializer: &mut D,
) -> Result<With<T, W>, <D as Fallible>::Error>
fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.