Skip to content
Orleans logoMicrosoft Orleans

IStreamQueueCheckpointer<TCheckpoint> Methods

Functionality for checkpointing a stream.

FlushAsync(CancellationToken)

virtual
View source
public virtual Task FlushAsync(CancellationToken cancellationToken)
Flushes any pending checkpoint to persistent storage, ensuring the latest offset is durably saved. Called during shutdown or rebalancing to prevent message replay on restart.

Parameters

cancellationTokenCancellationToken
The cancellation token.

Returns

A System.Threading.Tasks.Task representing the flush operation.

Load

abstract
View source
[System.Obsolete(Use the overload which accepts a CancellationToken.)]
public abstract Task<TCheckpoint> Load()
Loads the checkpoint.

Returns

The checkpoint.

Load(CancellationToken)

virtual
View source
public virtual Task<TCheckpoint> Load(CancellationToken cancellationToken)
Loads the checkpoint.

Parameters

cancellationTokenCancellationToken
The cancellation token.

Returns

The checkpoint.

Update(TCheckpoint, DateTime)

abstract
View source
[System.Obsolete(Use the overload which accepts a CancellationToken.)]
public abstract void Update(TCheckpoint offset, DateTime utcNow)
Updates the checkpoint.

Parameters

offsetTCheckpoint
The offset.
utcNowDateTime
The current UTC time.

Update(TCheckpoint, DateTime, CancellationToken)

virtual
View source
public virtual void Update(TCheckpoint offset, DateTime utcNow, CancellationToken cancellationToken)
Updates the checkpoint.

Parameters

offsetTCheckpoint
The offset.
utcNowDateTime
The current UTC time.
cancellationTokenCancellationToken
The cancellation token.