Struct SendQueue

pub struct SendQueue { /* private fields */ }

A client-wide send queue, for all the rooms known by a client.

Implementations

impl SendQueue

pub async fn respawn_tasks_for_rooms_with_unsent_requests(&self)

Reload all the rooms which had unsent requests, and respawn tasks for those rooms.

pub async fn set_enabled(&self, enabled: bool)

Enable or disable the send queue for the entire client, i.e. all rooms.

If we’re disabling the queue, and requests were being sent, they’re not aborted, and will continue until a status resolves (error responses will keep the events in the buffer of events to send later). The disablement will happen before the next request is sent.

This may wake up background tasks and resume sending of requests in the background.

pub fn is_enabled(&self) -> bool

Returns whether the send queue is enabled, at a client-wide granularity.

pub fn enable_upload_progress(&self, enabled: bool)

Enable or disable progress reporting for media uploads.

pub fn subscribe(&self) -> Receiver<SendQueueUpdate>

Subscribe to all updates for all rooms.

Use RoomSendQueue::subscribe to subscribe to update for a specific room.

pub fn subscribe_errors(&self) -> Receiver<SendQueueRoomError>

A subscriber to the enablement status (enabled or disabled) of the send queue, along with useful errors.

Trait Implementations

impl Debug for SendQueue

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.