Struct Service 

pub struct Service {
    keypair: Box<Ed25519KeyPair>,
    verify_keys: VerifyKeys,
    minimum_valid: Duration,
    services: Arc<OnceServices>,
    db: Data,
}

Fields

keypair: Box<Ed25519KeyPair>

verify_keys: VerifyKeys

minimum_valid: Duration

services: Arc<OnceServices>

db: Data

Implementations

impl Service

pub async fn acquire_events_pubkeys<'a, I>(&self, events: I)

where I: Iterator<Item = &'a Box<RawJsonValue>> + Send,

impl Service

pub async fn acquire_pubkeys<'a, S, K>(&self, batch: S)

where S: Iterator<Item = (&'a ServerName, K)> + Send + Clone, K: Iterator<Item = &'a ServerSigningKeyId> + Send + Clone,

impl Service

async fn acquire_locals<'a, S, K>( &self, batch: S, ) -> BTreeMap<OwnedServerName, Vec<OwnedServerSigningKeyId>>

where S: Iterator<Item = (&'a ServerName, K)> + Send, K: Iterator<Item = &'a ServerSigningKeyId> + Send,

impl Service

async fn acquire_origins<I>( &self, batch: I, ) -> BTreeMap<OwnedServerName, Vec<OwnedServerSigningKeyId>>

where I: Iterator<Item = (OwnedServerName, Vec<OwnedServerSigningKeyId>)> + Send,

impl Service

async fn acquire_origin( &self, origin: OwnedServerName, key_ids: Vec<OwnedServerSigningKeyId>, timeout: Instant, ) -> (OwnedServerName, Vec<OwnedServerSigningKeyId>)

impl Service

async fn acquire_notary<I>( &self, batch: I, ) -> BTreeMap<OwnedServerName, Vec<OwnedServerSigningKeyId>>

where I: Iterator<Item = (OwnedServerName, Vec<OwnedServerSigningKeyId>)> + Send,

impl Service

async fn acquire_notary_result( &self, missing: &mut BTreeMap<OwnedServerName, Vec<OwnedServerSigningKeyId>>, server_keys: ServerSigningKeys, )

impl Service

pub async fn get_event_keys( &self, object: &CanonicalJsonObject, version: &RoomVersionRules, ) -> Result<PubKeyMap>

impl Service

pub async fn get_pubkeys<'a, S, K>(&self, batch: S) -> PubKeyMap

where S: Iterator<Item = (&'a ServerName, K)> + Send, K: Iterator<Item = &'a ServerSigningKeyId> + Send,

impl Service

pub async fn get_pubkeys_for<'a, I>( &self, origin: &ServerName, key_ids: I, ) -> PubKeys

where I: Iterator<Item = &'a ServerSigningKeyId> + Send,

impl Service

pub async fn get_verify_key( &self, origin: &ServerName, key_id: &ServerSigningKeyId, ) -> Result<VerifyKey>

impl Service

async fn get_verify_key_from_notaries( &self, origin: &ServerName, key_id: &ServerSigningKeyId, ) -> Result<VerifyKey>

impl Service

async fn get_verify_key_from_origin( &self, origin: &ServerName, key_id: &ServerSigningKeyId, ) -> Result<VerifyKey>

impl Service

pub(super) async fn batch_notary_request<'a, S, K>( &self, notary: &ServerName, batch: S, ) -> Result<Vec<ServerSigningKeys>>

where S: Iterator<Item = (&'a ServerName, K)> + Send, K: Iterator<Item = &'a ServerSigningKeyId> + Send,

impl Service

pub async fn notary_request( &self, notary: &ServerName, target: &ServerName, ) -> Result<impl Iterator<Item = ServerSigningKeys> + Clone + Debug + Send + use<>>

impl Service

pub async fn server_request( &self, target: &ServerName, ) -> Result<ServerSigningKeys>

impl Service

pub fn gen_id_hash_and_sign_event( &self, object: &mut CanonicalJsonObject, room_version_id: &RoomVersionId, ) -> Result<OwnedEventId>

impl Service

fn gen_id_hash_and_sign_event_v1( &self, object: &mut CanonicalJsonObject, room_version_id: &RoomVersionId, ) -> Result<OwnedEventId>

impl Service

fn gen_id_hash_and_sign_event_v3( &self, object: &mut CanonicalJsonObject, room_version_id: &RoomVersionId, ) -> Result<OwnedEventId>

impl Service

pub fn hash_and_sign_event( &self, object: &mut CanonicalJsonObject, room_version_id: &RoomVersionId, ) -> Result

impl Service

pub fn sign_json(&self, object: &mut CanonicalJsonObject) -> Result

impl Service

pub async fn validate_and_add_event_id( &self, pdu: &RawJsonValue, room_version_id: &RoomVersionId, ) -> Result<(OwnedEventId, CanonicalJsonObject)>

impl Service

pub async fn validate_and_add_event_id_no_fetch( &self, pdu: &RawJsonValue, room_version_id: &RoomVersionId, ) -> Result<(OwnedEventId, CanonicalJsonObject)>

impl Service

pub async fn verify_event( &self, event: &CanonicalJsonObject, room_version_id: Option<&RoomVersionId>, ) -> Result<Verified>

impl Service

pub async fn verify_json( &self, event: &CanonicalJsonObject, room_version_id: Option<&RoomVersionId>, ) -> Result

impl Service

pub fn keypair(&self) -> &Ed25519KeyPair

impl Service

pub fn active_key_id(&self) -> &ServerSigningKeyId

impl Service

pub fn active_verify_key(&self) -> (&ServerSigningKeyId, &VerifyKey)

impl Service

async fn add_signing_keys(&self, new_keys: ServerSigningKeys)

impl Service

pub async fn required_keys_exist( &self, object: &CanonicalJsonObject, rules: &RoomVersionRules, ) -> bool

impl Service

pub async fn verify_key_exists( &self, origin: &ServerName, key_id: &ServerSigningKeyId, ) -> bool

impl Service

pub async fn verify_keys_for(&self, origin: &ServerName) -> VerifyKeys

impl Service

pub async fn signing_keys_for( &self, origin: &ServerName, ) -> Result<ServerSigningKeys>

impl Service

fn minimum_valid_ts(&self) -> MilliSecondsSinceUnixEpoch

Trait Implementations

impl Service for Service

fn build(args: &Args<'_>) -> Result<Arc<Self>>

Implement the construction of the service instance. Services are generally singletons so expect this to only be called once for a service type. Note that it may be called again after a server reload, but the prior instance will have been dropped first. Failure will shutdown the server with an error.

fn name(&self) -> &str

Return the name of the service. i.e. crate::service::make_name(std::module_path!())

fn worker<'async_trait>( self: Arc<Self>, ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait,

Implement the service’s worker loop. The service manager spawns a task and calls this function after all services have been built.

fn interrupt<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Interrupt the service. This is sent to initiate a graceful shutdown. The service worker should return from its work loop.

fn clear_cache<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clear any caches or similar runtime state.

fn memory_usage<'life0, 'life1, 'async_trait>( &'life0 self, _out: &'life1 mut (dyn Write + Send), ) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Memory usage report in a markdown string.

fn unconstrained(&self) -> bool

Return true if the service worker opts out of the tokio cooperative budgeting. This can reduce tail latency at the risk of event loop starvation.