Namespace PowerSync.Common.Client.Sync.Stream
Classes
- CheckpointMode
The mechanism to request checkpoints from the PowerSync service.
Checkpoint requests are used after a client uploads local mutations. The PowerSync service later references them in downloaded data, allowing the SDK to assume that uploaded data has been synced down again.
There are two ways to send checkpoint requests: A legacy (but default and stable) format supported by all PowerSync service versions, and a newer (
requests) method which is only available from PowerSync service version 1.24.0 or later.Note that the requests checkpoint mode is an alpha API.
- CheckpointMode.Requests
Adopts a new and more efficient checkpoint protocol with better support for switching users on devices.
- CoreStreamSubscription
An
ActiveStreamSubscriptionfrom the core extension + serialized progress information.
- Instruction
An internal instruction emitted by the sync client in the core extension in response to the SDK passing sync data into the extension.
- NonInterruptingInstruction
An Instruction that doesn't start or stop a sync iteration.
- SyncStreamSubscribeOptions
Options for subscribing to a sync stream.
- SyncSubscriptionDescription
Information about a subscribed sync stream. This includes the ISyncStreamDescription, along with information about the current sync status.
Structs
Interfaces
- ISyncStream
A handle to a ISyncStreamDescription that allows subscribing to the stream. To obtain an instance of ISyncStream, call SyncStream(string, Dictionary<string, object>?).
- ISyncStreamDescription
A description of a sync stream, consisting of its Name and the Parameters used when subscribing.
- ISyncStreamSubscription
Represents an active subscription to a sync stream.