Struct distant_net::server::QueuedServerReply

pub struct QueuedServerReply<T> { /* private fields */ }

Represents a reply where all sends are queued up but not sent until after the flush method is called. This reply supports injecting at the front of the queue in order to support sending messages but ensuring that some specific message is sent out first

Implementations

impl<T> QueuedServerReply<T>

pub async fn hold(&self, hold: bool)

Updates the hold status for the queue

• If true, all messages are held until the queue is flushed
• If false, messages are sent directly as they come in

pub async fn send(&self, data: T) -> Result<()>

Send this message, adding it to a queue if holding messages

pub fn blocking_send(&self, data: T) -> Result<()>

Send this message, adding it to a queue if holding messages, blocking for access to locks and other internals

pub async fn send_before(&self, data: T) -> Result<()>

Send this message before anything else in the queue

pub async fn flush(&self, hold: bool) -> Result<()>

Sends all pending msgs queued up and clears the queue

Additionally, takes hold to indicate whether or not new msgs after the flush should continue to be held within the queue or if all future msgs will be sent immediately

pub fn is_closed(&self) -> bool

Trait Implementations

impl<T> Clone for QueuedServerReply<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Send + 'static> Reply for QueuedServerReply<T>

type Data = T

fn send(
    &self,
    data: Self::Data
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + '_>>

Sends a reply out from the server

fn blocking_send(&self, data: Self::Data) -> Result<()>

Blocking version of sending a reply out from the server

fn clone_reply(&self) -> Box<dyn Reply<Data = Self::Data>>

Clones this reply