Struct ClientConnection

pub struct ClientConnection { /* private fields */ }

A live connection to a relay, and all related state.

This connects when created, but may persist beyond disconnection, so we can’t say that it is always connected. Reconnection is not done here; if it becomes disconnected and you want to reconnect then you should drop and recreate to reconnect (and probably take the Incoming data to not lose it)

Implementations

impl ClientConnection

pub async fn new( relay_url: &str, timeout: Duration, ) -> Result<ClientConnection, Error>

Create a new ClientConnection by connecting.

pub async fn new_with_data( relay_url: &str, timeout: Duration, incoming: Arc<RwLock<Vec<RelayMessage>>>, ) -> Result<ClientConnection, Error>

Create a new ClientConnectdion by connecting, preserving data from a previous connection.

pub fn is_disconnected(&self) -> bool

Is disconnected

pub async fn disconnect(self) -> Result<(), Error>

Disconnect from the relay, consuming self

pub fn incoming(&self) -> Arc<RwLock<Vec<RelayMessage>>>

Copy an Arc reference to the Incoming relay messages.

pub async fn subscribe(&self, filter: Filter) -> Result<SubscriptionId, Error>

Subscribe to a filter. This does not wait for results.

pub async fn close_subscription( &self, sub_id: SubscriptionId, ) -> Result<(), Error>

Close a subscription

pub async fn send_message(&self, message: ClientMessage) -> Result<(), Error>

Send a ClientMessage

pub async fn send_ws_message(&self, message: Message) -> Result<(), Error>

Send a websocket Message

pub async fn wait_for_relay_message<P>( &self, predicate: P, timeout: Duration, ) -> Result<RelayMessage, Error>

where P: Fn(&RelayMessage) -> bool,

Wait for some matching RelayMessage.

The timeout will be reset when any event happens, so it make take longer than the timeout to give up.

pub async fn get_auth_state(&self) -> AuthState

Get AuthState

pub async fn wait_for_auth_state_change( &self, timeout: Duration, ) -> Result<AuthState, Error>

Wait for the given AuthState to occur.

pub async fn send_authenticate(&self, event: Event) -> Result<(), Error>

Authenticate

Trait Implementations

impl Debug for ClientConnection

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

Formats the value using the given formatter.