Struct rings_node::native::cli::Client

pub struct Client { /* private fields */ }

Wrap json_client send request between nodes or browsers.

Implementations

impl Client

pub fn new(endpoint_url: &str, session_sk: SessionSk) -> Result<Self>

Creates a new Client instance with the specified endpoint URL and signature.

pub async fn connect_peer_via_http( &mut self, http_url: &str ) -> Result<ClientOutput<String>>

Establishes a WebRTC connection with a remote peer using HTTP as the signaling channel.

This function allows two peers to establish a WebRTC connection using HTTP, which can be useful in scenarios where a direct peer-to-peer connection is not possible due to firewall restrictions or other network issues. The function sends ICE candidates and Session Description Protocol (SDP) messages over HTTP as a form of signaling to establish the connection.

Takes a URL for an HTTP server that will be used as the signaling channel to exchange ICE candidates and SDP with the remote peer. Returns a Did that can be used to refer to this connection in subsequent WebRTC operations.

pub async fn connect_with_seed( &mut self, source: &str ) -> Result<ClientOutput<()>>

Attempts to connect to a peer using a seed file located at the specified source path.

pub async fn connect_with_did(&mut self, did: &str) -> Result<ClientOutput<()>>

Attempts to connect to a peer using a DID stored in a Distributed Hash Table (DHT).

pub async fn list_peers(&mut self) -> Result<ClientOutput<()>>

Lists all connected peers and their status.

Returns an Output containing a formatted string representation of the list of peers if successful, or an anyhow::Error if an error occurred.

pub async fn disconnect(&mut self, did: &str) -> Result<ClientOutput<()>>

Disconnects from the peer with the specified DID.

pub async fn send_message( &self, did: &str, text: &str ) -> Result<ClientOutput<()>>

Sends a message to the specified peer.

pub async fn send_custom_message( &self, did: &str, message_type: u16, data: &str ) -> Result<ClientOutput<()>>

Sends a custom message to the specified peer.

pub async fn send_http_request_message( &self, did: &str, name: &str, method: Method, url: &str, timeout: Timeout, headers: &[(&str, &str)], body: Option<String> ) -> Result<ClientOutput<()>>

Sends an HTTP request message to the specified peer.

pub async fn send_simple_text_message( &self, did: &str, text: &str ) -> Result<ClientOutput<()>>

Sends a simple text message to the specified peer.

pub async fn register_service(&self, name: &str) -> Result<ClientOutput<()>>

Registers a new service with the given name.

pub async fn lookup_service(&self, name: &str) -> Result<ClientOutput<()>>

Looks up the DIDs of services registered with the given name.

pub async fn publish_message_to_topic( &self, topic: &str, data: &str ) -> Result<ClientOutput<()>>

Publishes a message to the specified topic.

pub async fn subscribe_topic<'a, 'b>( &'a self, topic: String ) -> impl Stream<Item = String> + 'bwhere 'a: 'b,

Subscribes to the specified topic and returns a stream of messages published to the topic.

pub async fn inspect(&self) -> Result<ClientOutput<SwarmInspect>>

Query for swarm inspect info.