Struct GossipApi

pub struct GossipApi { /* private fields */ }

Available on crate features net or rpc only.

API to control a Gossip instance.

This has methods to subscribe and join gossip topics, which return handles to publish and receive messages on topics.

Gossip derefs to GossipApi, so all functions on GossipApi are directly callable from Gossip.

Additionally, a GossipApi can be created by connecting to an RPC server. See Gossip::listen and GossipApi::connect (*requires the rpc feature).

Implementations

impl GossipApi

pub fn connect(endpoint: Endpoint, addr: SocketAddr) -> Self

Available on crate feature rpc only.

Connect to a remote as a RPC client.

pub async fn subscribe_with_opts( &self, topic_id: TopicId, opts: JoinOptions, ) -> Result<GossipTopic, ApiError>

Join a gossip topic with options.

Returns a GossipTopic instantly. To wait for at least one connection to be established, you can await GossipTopic::joined.

Messages will be queued until a first connection is available. If the internal channel becomes full, the oldest messages will be dropped from the channel.

pub async fn subscribe_and_join( &self, topic_id: TopicId, bootstrap: Vec<NodeId>, ) -> Result<GossipTopic, ApiError>

Join a gossip topic with the default options and wait for at least one active connection.

pub async fn subscribe( &self, topic_id: TopicId, bootstrap: Vec<NodeId>, ) -> Result<GossipTopic, ApiError>

Join a gossip topic with the default options.

Note that this will not wait for any bootstrap node to be available. To ensure the topic is connected to at least one node, use GossipTopic::joined or Self::subscribe_and_join

Trait Implementations

impl Clone for GossipApi

fn clone(&self) -> GossipApi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GossipApi

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

Formats the value using the given formatter.