Struct jsonrpsee_core::server::SubscriptionSink

pub struct SubscriptionSink { /* private fields */ }

Available on crate feature server only.

Represents a single subscription that hasn’t been processed yet.

Implementations

impl SubscriptionSink

pub fn subscription_id(&self) -> SubscriptionId<'static>

Get the subscription ID.

pub fn method_name(&self) -> &str

Get the method name.

pub fn connection_id(&self) -> ConnectionId

Get the connection ID.

pub async fn send( &self, msg: SubscriptionMessage, ) -> Result<(), DisconnectError>

Send out a response on the subscription and wait until there is capacity.

Returns

• Ok(()) if the message could be sent.
• Err(unsent_msg) if the connection or subscription was closed.

Cancel safety

This method is cancel-safe and dropping a future loses its spot in the waiting queue.

pub async fn send_timeout( &self, msg: SubscriptionMessage, timeout: Duration, ) -> Result<(), SendTimeoutError>

Similar to SubscriptionSink::send but only waits for a limited time.

pub fn try_send(&mut self, msg: SubscriptionMessage) -> Result<(), TrySendError>

Attempts to immediately send out the message as JSON string to the subscribers but fails if the channel is full or the connection/subscription is closed

This differs from SubscriptionSink::send where it will until there is capacity in the channel.

pub fn is_closed(&self) -> bool

Returns whether the subscription is closed.

pub async fn closed(&self)

Completes when the subscription has been closed.

pub fn capacity(&self) -> usize

Get the capacity of the subscription.

pub fn max_capacity(&self) -> usize

Get the max capacity of the subscription.

Trait Implementations

impl Clone for SubscriptionSink

fn clone(&self) -> SubscriptionSink

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionSink

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

Formats the value using the given formatter.

impl Drop for SubscriptionSink

fn drop(&mut self)

Executes the destructor for this type.