Class DelayedEvents

Delayed events (MSC4140): events sent later unless restarted or cancelled first, which MatrixRTC uses to end the call membership of a client that disappears.

Inheritance
object
DelayedEvents
Implements
Inherited Members
Namespace: Uniform.Matrix.Server.Rooms
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class DelayedEvents : IHostedService, IDisposable
Remarks

Each waits on a timer, and is kept in the database too, so a restart of the server does not forget it: at start, those whose delay ran out meanwhile are sent at once, the others wait for the rest of theirs. Their IDs are random enough to act as the secret that restarting, cancelling and sending need.

Constructors

| Edit this page View Source

DelayedEvents(RoomService, IOptionsMonitor<CallOptions>, TimeProvider, ILogger<DelayedEvents>, IDbContextFactory<ServerDbContext>)

Create the service.

Declaration
public DelayedEvents(RoomService rooms, IOptionsMonitor<CallOptions> options, TimeProvider time, ILogger<DelayedEvents> logger, IDbContextFactory<ServerDbContext> contexts)
Parameters
Type Name Description
RoomService rooms
IOptionsMonitor<CallOptions> options
TimeProvider time
ILogger<DelayedEvents> logger
IDbContextFactory<ServerDbContext> contexts

Methods

| Edit this page View Source

ActAsync(string, string, CancellationToken)

Restart, cancel or send now (action restart, cancel or send) a delayed event; throw M_NOT_FOUND when there is none, e.g. as it was sent already.

Declaration
public Task ActAsync(string delayId, string action, CancellationToken cancellationToken)
Parameters
Type Name Description
string delayId
string action
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

Dispose()

Stop all timers.

Declaration
public void Dispose()
| Edit this page View Source

List(string)

Return the user's delayed events as MSC4140 lists them.

Declaration
public JsonArray List(string userId)
Parameters
Type Name Description
string userId
Returns
Type Description
JsonArray
| Edit this page View Source

ScheduleAsync(Requester, string, string, string?, JsonObject, long, CancellationToken)

Schedule a message (stateKey null) or state event; return its delay ID.

Declaration
public Task<string> ScheduleAsync(Requester requester, string roomId, string type, string? stateKey, JsonObject content, long delayMilliseconds, CancellationToken cancellationToken)
Parameters
Type Name Description
Requester requester
string roomId
string type
string stateKey
JsonObject content
long delayMilliseconds
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

StartAsync(CancellationToken)

Load the delayed events kept from before a restart, after the database is migrated: send those whose delay ran out, and wait for the rest of the others' delays.

Declaration
public Task StartAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

StopAsync(CancellationToken)

Leave the kept delayed events for the next start.

Declaration
public Task StopAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task

Implements