pub struct Node<Q: Message, R: Message> { /* private fields */ }Expand description
A running node.
Implementations§
Source§impl<Q: Message, R: Message> Node<Q, R>
impl<Q: Message, R: Message> Node<Q, R>
Sourcepub fn start(
profile: &'static Profile,
key: Keypair,
cfg: NodeConfig,
handler: Arc<dyn Handler<Q, R>>,
) -> Result<Self>
pub fn start( profile: &'static Profile, key: Keypair, cfg: NodeConfig, handler: Arc<dyn Handler<Q, R>>, ) -> Result<Self>
Start a node speaking profile; returns once its listeners are up (or failed).
pub fn peer_id(&self) -> PeerId
pub fn status(&self) -> Status
Sourcepub fn reachable_addrs(&self) -> Vec<String>
pub fn reachable_addrs(&self) -> Vec<String>
Addresses others can use to reach this node (with /p2p/ID).
Sourcepub fn request(&self, peer: PeerId, addrs: &[Multiaddr], wire: Q) -> Result<R>
pub fn request(&self, peer: PeerId, addrs: &[Multiaddr], wire: Q) -> Result<R>
Send a request and wait for the answer. addrs are tried if not connected yet.
Sourcepub fn names_request(
&self,
server: PeerId,
addrs: &[Multiaddr],
req: NamesRequest,
) -> Result<NamesResponse>
pub fn names_request( &self, server: PeerId, addrs: &[Multiaddr], req: NamesRequest, ) -> Result<NamesResponse>
Ask a names server (a relay, usually) something; addrs are tried if not connected.
Sourcepub fn register(
&self,
server: PeerId,
addrs: &[Multiaddr],
entry: Entry,
) -> Result<()>
pub fn register( &self, server: PeerId, addrs: &[Multiaddr], entry: Entry, ) -> Result<()>
Register a record or withdrawal on a names server.
Sourcepub fn discover(
&self,
server: PeerId,
addrs: &[Multiaddr],
user: &str,
) -> Result<Option<Entry>>
pub fn discover( &self, server: PeerId, addrs: &[Multiaddr], user: &str, ) -> Result<Option<Entry>>
A user’s entry on one names server.
Sourcepub fn put_entry(&self, entry: Entry) -> Result<()>
pub fn put_entry(&self, entry: Entry) -> Result<()>
Put a record or withdrawal in the DHT (checked first, like every storing node does). Records belong in the DHT only while the device hosts something public or private.
Sourcepub fn get_entries(&self, user: &str) -> Result<Vec<Entry>>
pub fn get_entries(&self, user: &str) -> Result<Vec<Entry>>
Every entry the DHT returns for a user (unchecked; see Profile::newest).
Sourcepub fn find_peer(&self, peer: PeerId) -> Result<Vec<Multiaddr>>
pub fn find_peer(&self, peer: PeerId) -> Result<Vec<Multiaddr>>
Where a peer is, by its key alone: what the DHT knows of it.
Sourcepub fn register_everywhere(&self, entry: &Entry) -> usize
pub fn register_everywhere(&self, entry: &Entry) -> usize
Register an entry with every names server this node uses (its relays and the configured ones); returns how many took it.
Sourcepub fn lookup(&self, user: &str) -> Lookup
pub fn lookup(&self, user: &str) -> Lookup
Find a user’s freshest valid record: on this node’s names servers, then in the DHT.
Sourcepub fn request_key(&self, peer: PeerId, wire: Q) -> Result<R>
pub fn request_key(&self, peer: PeerId, wire: Q) -> Result<R>
Send a request to a peer known only by its key: when not connected, find its addresses in the DHT and try circuits through this node’s relays and names servers.
Sourcepub fn request_user(&self, user: &str, wire: Q) -> Result<(PeerId, R)>
pub fn request_user(&self, user: &str, wire: Q) -> Result<(PeerId, R)>
Send a request to a user’s node: look up its record and dial its addresses (circuits and direct ones together). Returns the node that answered.
Sourcepub fn dial(&self, addr: Multiaddr) -> Result<PeerId>
pub fn dial(&self, addr: Multiaddr) -> Result<PeerId>
Connect to an address; returns the peer there.
Sourcepub fn listen(&self, addr: Multiaddr) -> Result<Multiaddr>
pub fn listen(&self, addr: Multiaddr) -> Result<Multiaddr>
Listen on one more address; returns the address it got.
Sourcepub fn add_relay(&self, addr: Multiaddr) -> Result<()>
pub fn add_relay(&self, addr: Multiaddr) -> Result<()>
Reserve a slot on a relay (…/p2p/RELAY).
pub fn stop(self)
Trait Implementations§
Auto Trait Implementations§
impl<Q, R> !RefUnwindSafe for Node<Q, R>
impl<Q, R> !UnwindSafe for Node<Q, R>
impl<Q, R> Forget for Node<Q, R>
impl<Q, R> Freeze for Node<Q, R>where
UnboundedSender<Cmd<Q, R>>: Freeze,
impl<Q, R> Move for Node<Q, R>
impl<Q, R> Send for Node<Q, R>where
UnboundedSender<Cmd<Q, R>>: Send,
impl<Q, R> Sync for Node<Q, R>where
UnboundedSender<Cmd<Q, R>>: Sync,
impl<Q, R> Unpin for Node<Q, R>where
UnboundedSender<Cmd<Q, R>>: Unpin,
impl<Q, R> UnsafeUnpin for Node<Q, R>where
UnboundedSender<Cmd<Q, R>>: UnsafeUnpin,
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§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
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§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 moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§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 moreSource§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 moreSource§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
Source§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
Source§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.Source§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.Source§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.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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 moreSource§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.Source§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.Source§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.Source§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.Source§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.Source§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.Source§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.