Module queue

Source
Expand description

A module containing repositories for the job queue

Structs§

CleanupExpiredTokensJob
Cleanup expired tokens
DeactivateUserJob
A job to deactivate and lock a user
DeleteDeviceJob
A job to delete a device for a user on the homeserver.
ExpireInactiveCompatSessionsJob
Expire inactive compatibility sessions
ExpireInactiveOAuthSessionsJob
Expire inactive OAuth 2.0 sessions
ExpireInactiveSessionsJob
Scheduled job to expire inactive sessions
ExpireInactiveUserSessionsJob
Expire inactive user sessions
Job
Represents a job in the job queue
JobMetadata
Metadata stored alongside the job
ProvisionDeviceJob
A job to provision a device for a user on the homeserver.
ProvisionUserJob
A job to provision the user on the homeserver.
PruneStalePolicyDataJob
Prune stale policy data
ReactivateUserJob
A job to reactivate a user
ScheduleStatus
QueueScheduleRepository::list returns a list of ScheduleStatus, which has the name of the schedule and infos about its last run
SendAccountRecoveryEmailsJob
Send account recovery emails
SendEmailAuthenticationCodeJob
A job to send an email authentication code to a user.
SyncDevicesJob
A job which syncs the list of devices of a user with the homeserver
VerifyEmailJob
This is the previous iteration of the email verification job. It has been replaced by SendEmailAuthenticationCodeJob. This struct is kept to be able to consume jobs that are still in the queue.
Worker
A worker is an entity which can execute jobs.

Traits§

InsertableJob
A trait that represents a job which can be inserted into a queue
QueueJobRepository
A QueueJobRepository is used to schedule jobs to be executed by a worker.
QueueJobRepositoryExt
Extension trait for QueueJobRepository to help adding a job to the queue through the InsertableJob trait. This isn’t in the QueueJobRepository trait to keep it object safe.
QueueScheduleRepository
A QueueScheduleRepository is used to interact with recurrent scheduled jobs in the job queue.
QueueWorkerRepository
A QueueWorkerRepository is used to schedule jobs to be executed by a worker.