Struct Node

pub struct Node { /* private fields */ }

Implementation of a network node on Subspace Network.

Implementations

impl Node

pub fn id(&self) -> PeerId

Node’s own local ID.

pub async fn get_value( &self, key: Multihash, ) -> Result<impl Stream<Item = PeerRecord>, GetValueError>

Return a value from the Kademlia network of the DSN.

pub async fn put_value( &self, key: Multihash, value: Vec<u8>, ) -> Result<impl Stream<Item = ()>, PutValueError>

Puts a value into the Kademlia network of the DSN.

pub async fn subscribe( &self, topic: Sha256Topic, ) -> Result<TopicSubscription, SubscribeError>

Subscribe to some topic on the DSN.

pub async fn publish( &self, topic: Sha256Topic, message: Vec<u8>, ) -> Result<(), PublishError>

Subscribe a messgo to some topic on the DSN.

pub async fn send_generic_request<Request>( &self, peer_id: PeerId, addresses: Vec<Multiaddr>, request: Request, ) -> Result<Request::Response, SendRequestError>

where Request: GenericRequest,

Sends the generic request to the peer and awaits the result.

Optional addresses will be used for dialing if connection to peer isn’t established yet.

pub async fn get_closest_peers( &self, key: Multihash, ) -> Result<impl Stream<Item = PeerId>, GetClosestPeersError>

Get closest peers by multihash key using Kademlia DHT.

pub async fn get_closest_local_peers( &self, key: Multihash, source: Option<PeerId>, ) -> Result<Vec<(PeerId, Vec<Multiaddr>)>, GetClosestLocalPeersError>

Get closest peers by multihash key using Kademlia DHT’s local view without any network requests.

Optional source is peer for which results will be sent as a response. Defaults to local peer ID.

pub async fn get_providers( &self, key: RecordKey, ) -> Result<impl Stream<Item = PeerId>, GetProvidersError>

Get item providers by its key. Initiate ‘providers’ Kademlia operation.

pub async fn ban_peer(&self, peer_id: PeerId) -> Result<(), SendError>

Ban peer with specified peer ID.

pub fn listeners(&self) -> Vec<Multiaddr>

Node’s own addresses where it listens for incoming requests.

pub fn external_addresses(&self) -> Vec<Multiaddr>

Node’s own addresses observed remotely.

pub fn on_new_listener( &self, callback: Arc<dyn Fn(&Multiaddr) + Send + Sync + 'static>, ) -> HandlerId

Callback is called when node starts listening on new address.

pub fn on_num_established_peer_connections_change( &self, callback: Arc<dyn Fn(&usize) + Send + Sync + 'static>, ) -> HandlerId

Callback is called when number of established peer connections changes.

pub async fn connected_peers(&self) -> Result<Vec<PeerId>, ConnectedPeersError>

Returns a collection of currently connected peers.

pub async fn connected_servers( &self, ) -> Result<Vec<PeerId>, ConnectedPeersError>

Returns a collection of currently connected servers (typically farmers).

pub async fn bootstrap(&self) -> Result<(), BootstrapError>

Bootstraps Kademlia network

pub fn on_connected_peer( &self, callback: Arc<dyn Fn(&PeerId) + Send + Sync + 'static>, ) -> HandlerId

Callback is called when a peer is connected.

pub fn on_disconnected_peer( &self, callback: Arc<dyn Fn(&PeerId) + Send + Sync + 'static>, ) -> HandlerId

Callback is called when a peer is disconnected.

pub fn on_discovered_peer( &self, callback: Arc<dyn Fn(&PeerDiscovered) + Send + Sync + 'static>, ) -> HandlerId

Callback is called when a routable or unraoutable peer is discovered.

pub async fn get_requests_batch_handle(&self) -> NodeRequestsBatchHandle

Returns the request batch handle with common “connection permit” slot from the shared pool.

pub fn downgrade(&self) -> WeakNode

Downgrade to WeakNode

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.