Interface ICustomCheckpointRequestConnector

Namespace

PowerSync.Common.Client.Connection

Assembly

PowerSync.Common.dll

An IPowerSyncBackendConnector capable of requesting checkpoints.

Extend this class instead of IPowerSyncBackendConnector when uploads are processed asynchronously by the backend (for example through a message queue): The sync client as part of the PowerSync .NET SDK generates a checkpoint request id and hands it to your backend via this class, which is responsible for creating a matching checkpoint once the uploads preceding the request have been processed. For more details, see asynchronous backend uploads.

To use this connector, using CheckpointMode.Requests is required. Note that this requires PowerSync service version 1.24.0 or later.

public interface ICustomCheckpointRequestConnector : IPowerSyncBackendConnector

Inherited Members

IPowerSyncBackendConnector.FetchCredentials()

IPowerSyncBackendConnector.UploadData(IPowerSyncDatabase)

Methods

PostCheckpointRequest(string, string, CancellationToken)

Posts a client-generated checkpoint request to the backend and returns the effective checkpoint request state.

Currently, checkpoint request IDs are represented as strings. This is because some PowerSync SDKs are for runtimes that don't have a fast 64-bit integer type. In a future release, checkpoint request IDs will change to be represented by longs, meaning the requestId parameter's type will also change to long.