Struct Client

pub struct Client<C = BoxedConnector<RpcService>> { /* private fields */ }

Available on crate feature rpc only.

Iroh gossip client.

Implementations

impl<C> Client<C>

where C: Connector<RpcService>,

pub fn new(rpc: RpcClient<RpcService, C>) -> Self

Creates a new gossip client.

pub async fn subscribe_with_opts( &self, topic: TopicId, opts: SubscribeOpts, ) -> Result<(impl Sink<SubscribeUpdate, Error = Error>, impl Stream<Item = Result<SubscribeResponse>>)>

Subscribes to a gossip topic.

Returns a sink to send updates to the topic and a stream of responses.

Updates are either Broadcast or BroadcastNeighbors.

Broadcasts are gossiped to the entire swarm, while BroadcastNeighbors are sent to just the immediate neighbors of the node.

Responses are either Gossip or Lagged.

Gossip events contain the actual message content, as well as information about the immediate neighbors of the node.

A Lagged event indicates that the gossip stream has not been consumed quickly enough. You can adjust the buffer size with the SubscribeOpts::subscription_capacity option.

pub async fn subscribe( &self, topic: impl Into<TopicId>, bootstrap: impl IntoIterator<Item = impl Into<NodeId>>, ) -> Result<(impl Sink<SubscribeUpdate, Error = Error>, impl Stream<Item = Result<SubscribeResponse>>)>

Subscribes to a gossip topic with default options.

Trait Implementations

impl<C: Clone> Clone for Client<C>

fn clone(&self) -> Client<C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for Client<C>

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

Formats the value using the given formatter.