Module delayed_events

Expand description

Delayed events (MSC4140): events scheduled now and sent later.

A scheduled event is three rows written in one batch: its record, a due-time index entry, and an owner index entry. The worker sends each event when it falls due through the ordinary append path, so events overdue at startup go out on its first pass. Whatever the outcome, one batch then replaces the three rows with a finalised record, and a crash between the two steps can send an event twice. Finalised records are kept for about a week, or less once their column reaches its size cap.

Re-exports§

use std::collections::BTreeMap; 🔒
use std::pin::pin; 🔒
use std::sync::Arc; 🔒
use std::time::Duration; 🔒
use async_trait::async_trait; 🔒
use futures::Stream; 🔒
use futures::StreamExt; 🔒
use futures::TryFutureExt; 🔒
use futures::future::Either; 🔒
use futures::future::select; 🔒
use futures::stream::unfold; 🔒
use http::StatusCode; 🔒
use ruma::EventId; 🔒
use ruma::MilliSecondsSinceUnixEpoch; 🔒
use ruma::OwnedEventId; 🔒
use ruma::OwnedRoomId; 🔒
use ruma::OwnedUserId; 🔒
use ruma::UserId; 🔒
use ruma::api::client::delayed_events::get_delayed_event::v1::Finalized; 🔒
use ruma::api::error::ErrorKind; 🔒
use ruma::api::error::LimitExceededErrorData; 🔒
use ruma::api::error::RetryAfter; 🔒
use ruma::api::error::StandardErrorBody; 🔒
use ruma::events::TimelineEventType; 🔒
use serde::Deserialize; 🔒
use serde::Deserialize; 🔒
use serde::Serialize; 🔒
use serde::Serialize; 🔒
use tokio::sync::Notify; 🔒
use tokio::time::timeout; 🔒
use tuwunel_core::Err; 🔒
use tuwunel_core::Error; 🔒
use tuwunel_core::Result; 🔒
use tuwunel_core::debug_warn; 🔒
use tuwunel_core::err; 🔒
use tuwunel_core::error; 🔒
use tuwunel_core::error; 🔒
use tuwunel_core::implement; 🔒
use tuwunel_core::result::NotFound; 🔒
use tuwunel_core::smallstr::SmallString; 🔒
use tuwunel_core::utils::MutexMap; 🔒
use tuwunel_core::utils::MutexMapGuard; 🔒
use tuwunel_core::utils::rand::string_array; 🔒
use tuwunel_core::utils::stream::BroadbandExt; 🔒
use tuwunel_core::utils::stream::ReadyExt; 🔒
use tuwunel_core::utils::stream::TryIgnore; 🔒
use tuwunel_core::utils::stream::WidebandExt; 🔒
use tuwunel_core::utils::stream::automatic_width; 🔒
use tuwunel_core::utils::time::now_millis; 🔒
use tuwunel_core::warn; 🔒
use tuwunel_database::Deserialized; 🔒
use tuwunel_database::Ignore; 🔒
use tuwunel_database::Interfix; 🔒
use tuwunel_database::Json; 🔒
use tuwunel_database::Map; 🔒
use tuwunel_matrix::StateKey; 🔒
use tuwunel_matrix::pdu::Content; 🔒
use tuwunel_matrix::pdu::DELAY_ID; 🔒
use tuwunel_matrix::pdu::PduBuilder; 🔒
use crate::service::make_name; 🔒
use crate::transaction_ids::RoomScope; 🔒
use crate::transaction_ids::RoomTxn; 🔒

Structs§

Data 🔒
Event: A delayed event as stored, scheduled or finalised, and as reported to its owner.
Limits: The limits a client is told about and held to.
Service: Schedules delayed events and sends them when they fall due.

Constants§

DELAY_ID_LEN 🔒
MAX_WAIT 🔒
SEND_WIDTH 🔒

Functions§

conflict 🔒
limit_exceeded 🔒
log_send_error 🔒: Logs a failed send, at warning level only when the server is at fault.
outcome 🔒: Records a send’s outcome with the time it was finalised.
read_event 🔒

Type Aliases§

DelayId: A delay_id, as this server issues it or a client names it.