Struct rings_core::swarm::Swarm

pub struct Swarm { /* private fields */ }

The transport and dht management.

Implementations

impl Swarm

pub fn did(&self) -> Did

Get did of self.

pub fn dht(&self) -> Arc<PeerRing>

Get DHT(Distributed Hash Table) of self.

pub fn set_callback(&self, callback: SharedSwarmCallback) -> Result<()>

Set callback for swarm.

pub fn stabilizer(&self) -> Stabilizer

Create Stabilizer for swarm.

pub async fn disconnect(&self, peer: Did) -> Result<()>

Disconnect a connection. There are three steps:

1. remove from DHT;
2. remove from Transport;
3. close the connection;

pub async fn connect(&self, peer: Did) -> Result<()>

Connect a given Did. If the did is already connected, return directly, else try prepare offer and establish connection by dht. This function may returns a pending connection or connected connection.

pub async fn send_message(&self, msg: Message, destination: Did) -> Result<Uuid>

Send Message to peer.

pub fn peers(&self) -> Vec<ConnectionInspect>

List peers and their connection status.

pub async fn inspect(&self) -> SwarmInspect

Check the status of swarm

impl Swarm

pub async fn create_offer(&self, peer: Did) -> Result<MessagePayload>

Creaet new connection and its answer. This function will wrap the offer inside a payload with verification.

pub async fn answer_offer( &self, offer_payload: MessagePayload ) -> Result<MessagePayload>

Answer the offer of remote connection. This function will verify the answer payload and will wrap the answer inside a payload with verification.

pub async fn accept_answer(&self, answer_payload: MessagePayload) -> Result<()>

Accept the answer of remote connection. This function will verify the answer payload and will return its did with the connection.

Trait Implementations

impl<const REDUNDANT: u16> ChordStorageInterface<REDUNDANT> for Swarm

fn storage_fetch<'life0, 'async_trait>( &'life0 self, vid: Did ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch virtual node, if exist in localstoreage, copy it to the cache, else Query Remote Node

fn storage_store<'life0, 'async_trait>( &'life0 self, vnode: VirtualNode ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Store VirtualNode, TryInto<VirtualNode> is implemented for alot of types

fn storage_append_data<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, data: Encoded ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

append data to Data type virtual node

fn storage_touch_data<'life0, 'life1, 'async_trait>( &'life0 self, topic: &'life1 str, data: Encoded ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

append data to Data type virtual node uniquely

impl ChordStorageInterfaceCacheChecker for Swarm

fn storage_check_cache<'life0, 'async_trait>( &'life0 self, vid: Did ) -> Pin<Box<dyn Future<Output = Option<VirtualNode>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check local cache

impl<const REDUNDANT: u16> SubringInterface<REDUNDANT> for Swarm

fn subring_join<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

add did into current chord subring. send direct message with JoinSubring type, which will handled by next node.