Struct nostr_sdk::relay::Relay

pub struct Relay { /* private fields */ }

Relay

Implementations

impl Relay

pub fn new( url: Url, pool_sender: Sender<RelayPoolMessage>, notification_sender: Sender<RelayPoolNotification>, proxy: Option<SocketAddr>, opts: RelayOptions ) -> Self

Create new Relay

pub fn url(&self) -> Url

Get relay url

pub fn proxy(&self) -> Option<SocketAddr>

Get proxy

pub async fn status(&self) -> RelayStatus

Get RelayStatus

pub fn status_blocking(&self) -> RelayStatus

Get RelayStatus

pub async fn is_connected(&self) -> bool

Check if Relay is connected

pub async fn document(&self) -> RelayInformationDocument

Get RelayInformationDocument

pub fn document_blocking(&self) -> RelayInformationDocument

Get RelayInformationDocument

pub async fn subscriptions( &self ) -> HashMap<InternalSubscriptionId, ActiveSubscription>

Get ActiveSubscription

pub async fn update_subscription_filters( &self, internal_id: InternalSubscriptionId, filters: Vec<Filter> )

Update ActiveSubscription

pub fn opts(&self) -> RelayOptions

Get RelayOptions

pub fn stats(&self) -> RelayConnectionStats

Get RelayConnectionStats

pub fn queue(&self) -> usize

Get queue len

pub async fn connect(&self, wait_for_connection: bool)

Connect to relay and keep alive connection

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

Disconnect from relay and set status to ‘Stopped’

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

Disconnect from relay and set status to ‘Terminated’

pub async fn send_msg( &self, msg: ClientMessage, wait: Option<Duration> ) -> Result<(), Error>

Send msg to relay

pub async fn batch_msg( &self, msgs: Vec<ClientMessage>, wait: Option<Duration> ) -> Result<(), Error>

Send multiple ClientMessage at once

pub async fn send_event( &self, event: Event, opts: RelaySendOptions ) -> Result<EventId, Error>

Send event and wait for OK relay msg

pub async fn batch_event( &self, events: Vec<Event>, opts: RelaySendOptions ) -> Result<(), Error>

Send multiple Event at once

pub async fn subscribe( &self, filters: Vec<Filter>, wait: Option<Duration> ) -> Result<(), Error>

Subscribe to filter with internal ID set to InternalSubscriptionId::Default

pub async fn subscribe_with_internal_id( &self, internal_id: InternalSubscriptionId, filters: Vec<Filter>, wait: Option<Duration> ) -> Result<(), Error>

Subscribe with custom internal ID

pub async fn unsubscribe(&self, wait: Option<Duration>) -> Result<(), Error>

Unsubscribe

pub async fn unsubscribe_with_internal_id( &self, internal_id: InternalSubscriptionId, wait: Option<Duration> ) -> Result<(), Error>

Unsubscribe with custom internal id

pub async fn unsubscribe_all(&self, wait: Option<Duration>) -> Result<(), Error>

Unsubscribe from all subscriptions

pub async fn get_events_of_with_callback<F>( &self, filters: Vec<Filter>, timeout: Duration, opts: FilterOptions, callback: impl Fn(Event) -> F ) -> Result<(), Error>where F: Future<Output = ()>,

Get events of filters with custom callback

pub async fn get_events_of( &self, filters: Vec<Filter>, timeout: Duration, opts: FilterOptions ) -> Result<Vec<Event>, Error>

Get events of filters

pub fn req_events_of( &self, filters: Vec<Filter>, timeout: Duration, opts: FilterOptions )

Request events of filter. All events will be sent to notification listener, until the EOSE “end of stored events” message is received from the relay.

Trait Implementations

impl Clone for Relay

fn clone(&self) -> Relay

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Relay

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

Formats the value using the given formatter.

impl PartialEq<Relay> for Relay

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.