Struct RoomSendQueue

pub struct RoomSendQueue { /* private fields */ }

A per-room send queue.

This is cheap to clone.

Implementations

impl RoomSendQueue

pub async fn send_attachment( &self, filename: &str, content_type: Mime, data: Vec<u8>, config: AttachmentConfig, ) -> Result<SendHandle, RoomSendQueueError>

Queues an attachment to be sent to the room, using the send queue.

This returns quickly (without sending or uploading anything), and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

The attachment and its optional thumbnail are stored in the media cache and can be retrieved at any time, by calling Media::get_media_content() with the MediaSource that can be found in the local or remote echo, and using a MediaFormat::File.

impl RoomSendQueue

pub async fn send_raw( &self, content: Raw<AnyMessageLikeEventContent>, event_type: String, ) -> Result<SendHandle, RoomSendQueueError>

Queues a raw event for sending it to this room.

This immediately returns, and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

pub async fn send( &self, content: AnyMessageLikeEventContent, ) -> Result<SendHandle, RoomSendQueueError>

Queues an event for sending it to this room.

This immediately returns, and will push the event to be sent into a queue, handled in the background.

Callers are expected to consume RoomSendQueueUpdate via calling the Self::subscribe() method to get updates about the sending of that event.

By default, if sending failed on the first attempt, it will be retried a few times. If sending failed after those retries, the entire client’s sending queue will be disabled, and it will need to be manually re-enabled by the caller (e.g. after network is back, or when something has been done about the faulty requests).

pub async fn subscribe( &self, ) -> Result<(Vec<LocalEcho>, Receiver<RoomSendQueueUpdate>), RoomSendQueueError>

Returns the current local requests as well as a receiver to listen to the send queue updates, as defined in RoomSendQueueUpdate.

pub fn is_enabled(&self) -> bool

Returns whether the room is enabled, at the room level.

pub fn set_enabled(&self, enabled: bool)

Set the locally enabled flag for this room queue.

Trait Implementations

impl Clone for RoomSendQueue

fn clone(&self) -> RoomSendQueue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomSendQueue

Available on non-tarpaulin_include only.

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

Formats the value using the given formatter.