Class SyncProcessor

Applies sync responses to the in-memory RoomStore and the database, and publishes the changes to the frontend.

Inheritance
object
SyncProcessor
Inherited Members
Namespace: Uniform.Matrix.Client.Services
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed class SyncProcessor
Remarks

RoomStore is not thread-safe, so every access goes through Read<T>(Func<RoomStore?, T>) or a method of this class, all under one lock that is never held across network calls.

Constructors

| Edit this page View Source

SyncProcessor(ClientStore, CryptoService?)

Create a processor persisting to store, decrypting with crypto when given.

Declaration
public SyncProcessor(ClientStore store, CryptoService? crypto = null)
Parameters
Type Name Description
ClientStore store
CryptoService crypto

Properties

| Edit this page View Source

Changes

Changes of each processed sync, in order; reads by one frontend.

Declaration
public ChannelReader<SyncChanges> Changes { get; }
Property Value
Type Description
ChannelReader<SyncChanges>

Methods

| Edit this page View Source

BackfillAsync(MatrixClient, string, int, CancellationToken)

Load up to limit older events of roomId from the server, stores them and prepend them to the room; return them oldest first.

Declaration
public Task<IReadOnlyList<ClientEvent>> BackfillAsync(MatrixClient client, string roomId, int limit, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
string roomId
int limit
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<ClientEvent>>
| Edit this page View Source

DecryptWithReceivedKeysAsync(CancellationToken)

Decrypt stored events whose room keys arrived since the last call, e.g. in this sync or from a backup restore, and announces their rooms.

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

IsIgnored(string)

Return whether the user ignores, i.e. has blocked, userId.

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

LoadMembersAsync(MatrixClient, string, CancellationToken)

Load the full member list of roomId, which sync omits when lazy-loading.

Declaration
public Task LoadMembersAsync(MatrixClient client, string roomId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

LoadMembersOfUnnamedRoomsAsync(MatrixClient, CancellationToken)

Load the whole member list of joined rooms that are named after their members, i.e. have neither a name nor an alias, and whose summary is unknown; then announce them.

Declaration
public Task LoadMembersOfUnnamedRoomsAsync(MatrixClient client, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

With lazy-loaded members, a sync from a stored position, as at every start, has no room summary, so such a room, e.g. a direct chat, knows only this user and is named "Empty Room". Rooms with a name are left alone, as large public rooms are.

| Edit this page View Source

ProcessAsync(SyncResponse, string, CancellationToken)

Persist sync, then apply it to the room state and publishes the changes.

Declaration
public Task ProcessAsync(SyncResponse sync, string ownUserId, CancellationToken cancellationToken)
Parameters
Type Name Description
SyncResponse sync
string ownUserId
CancellationToken cancellationToken
Returns
Type Description
Task
Remarks

Persisting first means a crash can at worst re-apply a sync, which the store tolerates as events are deduplicated by ID.

| Edit this page View Source

Read<T>(Func<RoomStore?, T>)

Run read on the room state while no sync is applied.

Declaration
public T Read<T>(Func<RoomStore?, T> read)
Parameters
Type Name Description
Func<RoomStore, T> read
Returns
Type Description
T
Type Parameters
Name Description
T
| Edit this page View Source

RetryStoredEncryptedAsync(CancellationToken)

Try once more to decrypt every stored encrypted event, e.g. at start, for keys that arrived while an event could not be matched; return how many were decrypted.

Declaration
public Task<int> RetryStoredEncryptedAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<int>
| Edit this page View Source

SetIgnoredAsync(MatrixClient, string, bool, CancellationToken)

Ignore userId, i.e. block them, or stop ignoring them, on the server, and apply the new list at once; the server then leaves out their messages and invites.

Declaration
public Task SetIgnoredAsync(MatrixClient client, string userId, bool ignored, CancellationToken cancellationToken = default)
Parameters
Type Name Description
MatrixClient client
string userId
bool ignored
CancellationToken cancellationToken
Returns
Type Description
Task

Events

| Edit this page View Source

Applied

Raised with the changes of each processed sync after they are applied, for services beside the frontend, e.g. calls; on the sync loop, so handlers return quickly.

Declaration
public event Action<SyncChanges>? Applied
Event Type
Type Description
Action<SyncChanges>
| Edit this page View Source

EventsDecrypted

Raised with a room ID after stored events of it were decrypted with a late room key, so a shown log can reload.

Declaration
public event Action<string>? EventsDecrypted
Event Type
Type Description
Action<string>