Struct libp2p_networking :: network :: NetworkNodeHandle Copy item path

impl<T: NodeType> NetworkNodeHandle<T>

pub async fn shutdown(&self) -> Result<(), NetworkError>

Cleanly shuts down a swarm node This is done by sending a message to the swarm itself to spin down

pub fn begin_bootstrap(&self) -> Result<(), NetworkError>

Notify the network to begin the bootstrap process

§Errors

If unable to send via send_network. This should only happen if the network is shut down.

pub fn listen_addr(&self) -> Multiaddr

Get a reference to the network node handle’s listen addr.

pub async fn print_routing_table(&self) -> Result<(), NetworkError>

Print out the routing table used by kademlia NOTE: only for debugging purposes currently

§Errors

if the client has stopped listening for a response

pub async fn wait_to_connect( &self, num_required_peers: usize, node_id: usize, ) -> Result<(), NetworkError>

Wait until at least num_peers have connected

§Errors

If the channel closes before the result can be sent back

pub async fn lookup_pid(&self, peer_id: PeerId) -> Result<(), NetworkError>

Look up a peer’s addresses in kademlia NOTE: this should always be called before any request_response is initiated

§Errors

if the client has stopped listening for a response

pub async fn lookup_node( &self, key: &[u8], dht_timeout: Duration, ) -> Result<PeerId, NetworkError>

Looks up a node’s PeerId by its staking key. Is authenticated through get_record assuming each record should be signed.

§Errors

If the DHT lookup fails

pub async fn put_record( &self, key: RecordKey, value: RecordValue<T::SignatureKey>, ) -> Result<(), NetworkError>

Insert a record into the kademlia DHT

§Errors

Will return NetworkError::FailedToSerialize when unable to serialize the key or value

pub async fn get_record( &self, key: RecordKey, retry_count: u8, ) -> Result<Vec<u8>, NetworkError>

Receive a record from the kademlia DHT if it exists. Must be replicated on at least 2 nodes

§Errors

Will return NetworkError::FailedToSerialize when unable to serialize the key
Will return NetworkError::FailedToDeserialize when unable to deserialize the returned value

pub async fn get_record_timeout( &self, key: RecordKey, timeout_duration: Duration, ) -> Result<Vec<u8>, NetworkError>

Get a record from the kademlia DHT with a timeout

§Errors

Will return NetworkError::Timeout when times out
Will return NetworkError::FailedToSerialize when unable to serialize the key or value
Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

pub async fn put_record_timeout( &self, key: RecordKey, value: RecordValue<T::SignatureKey>, timeout_duration: Duration, ) -> Result<(), NetworkError>

Insert a record into the kademlia DHT with a timeout

§Errors

Will return NetworkError::Timeout when times out
Will return NetworkError::FailedToSerialize when unable to serialize the key or value
Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

Subscribe to a topic

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

pub async fn unsubscribe(&self, topic: String) -> Result<(), NetworkError>

Unsubscribe from a topic

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

pub fn ignore_peers(&self, peers: Vec<PeerId>) -> Result<(), NetworkError>

Ignore peers when pruning e.g. maintain their connection

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

pub fn direct_request( &self, pid: PeerId, msg: &[u8], ) -> Result<(), NetworkError>

Make a direct request to peer_id containing msg

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed
Will return NetworkError::FailedToSerialize when unable to serialize msg

pub fn direct_request_no_serialize( &self, pid: PeerId, contents: Vec<u8>, ) -> Result<(), NetworkError>

Make a direct request to peer_id containing msg without serializing

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed
Will return NetworkError::FailedToSerialize when unable to serialize msg

pub fn direct_response( &self, chan: ResponseChannel<Vec<u8>>, msg: &[u8], ) -> Result<(), NetworkError>

Reply with msg to a request over chan

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed
Will return NetworkError::FailedToSerialize when unable to serialize msg

pub fn prune_peer(&self, pid: PeerId) -> Result<(), NetworkError>

Forcefully disconnect from a peer

§Errors

If the channel is closed somehow Shouldnt’ happen.

§Panics

If channel errors out shouldn’t happen.

pub fn gossip(&self, topic: String, msg: &[u8]) -> Result<(), NetworkError>

Gossip a message to peers

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed
Will return NetworkError::FailedToSerialize when unable to serialize msg

pub fn gossip_no_serialize( &self, topic: String, msg: Vec<u8>, ) -> Result<(), NetworkError>

Gossip a message to peers without serializing

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed
Will return NetworkError::FailedToSerialize when unable to serialize msg

pub fn add_known_peers( &self, known_peers: Vec<(PeerId, Multiaddr)>, ) -> Result<(), NetworkError>

Tell libp2p about known network nodes

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

fn send_request(&self, req: ClientRequest) -> Result<(), NetworkError>

Send a client request to the network

§Errors

Will return NetworkError::ChannelSendError when underlying NetworkNode has been killed

pub async fn num_connected(&self) -> Result<usize, NetworkError>

Returns number of peers this node is connected to

§Errors

If the channel is closed somehow Shouldnt’ happen.

§Panics

If channel errors out shouldn’t happen.

pub async fn connected_pids(&self) -> Result<HashSet<PeerId>, NetworkError>

return hashset of PIDs this node is connected to

§Errors

If the channel is closed somehow Shouldnt’ happen.

§Panics

If channel errors out shouldn’t happen.

pub fn id(&self) -> usize

Get a reference to the network node handle’s id.

pub fn peer_id(&self) -> PeerId

Get a reference to the network node handle’s peer id.

pub fn config(&self) -> &NetworkNodeConfig<T>

Return a reference to the network config

Trait Implementations§

impl<T: Clone + NodeType> Clone for NetworkNodeHandle<T>

fn clone(&self) -> NetworkNodeHandle<T>

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<T: Debug + NodeType> Debug for NetworkNodeHandle<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for NetworkNodeHandle<T>
where <T as NodeType>::Membership: Freeze,

impl<T> RefUnwindSafe for NetworkNodeHandle<T>
where <T as NodeType>::Membership: RefUnwindSafe,

impl<T> Send for NetworkNodeHandle<T>

impl<T> Sync for NetworkNodeHandle<T>

impl<T> Unpin for NetworkNodeHandle<T>
where <T as NodeType>::Membership: Unpin,

impl<T> UnwindSafe for NetworkNodeHandle<T>
where <T as NodeType>::Membership: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> ArchivePointee for T

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dst. Read more

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<F, W, T, D> Deserialize<With<T, W>, D> for F
where W: DeserializeWith<F, T, D>, D: Fallible + ?Sized, F: ?Sized,

fn deserialize( &self, deserializer: &mut D, ) -> Result<With<T, W>, <D as Fallible>::Error>

Deserializes using the given deserializer

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Gets the layout of the type.

impl<T> Pipe for T
where T: ?Sized,

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows 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) -> R
where R: 'a,

Mutably borrows 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
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows 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
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows 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
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Pointee for T

type Metadata = ()

The type for metadata in pointers and references to Self.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .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
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

impl<T> ErasedDestructor for T
where T: 'static,