Container.ChangeFeedStreamHandlerWithManualCheckpoint Delegate

Definition

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Package:

Microsoft.Azure.Cosmos v3.45.0

Source:

Container.cs

Delegate to receive the changes within a ChangeFeedProcessor execution with manual checkpoint.

public delegate System.Threading.Tasks.Task Container.ChangeFeedStreamHandlerWithManualCheckpoint(ChangeFeedProcessorContext context, Stream changes, Func<Task> checkpointAsync, CancellationToken cancellationToken);

type Container.ChangeFeedStreamHandlerWithManualCheckpoint = delegate of ChangeFeedProcessorContext * Stream * Func<Task> * CancellationToken -> Task

Public Delegate Function Container.ChangeFeedStreamHandlerWithManualCheckpoint(context As ChangeFeedProcessorContext, changes As Stream, checkpointAsync As Func(Of Task), cancellationToken As CancellationToken) As Task 

Parameters

context

ChangeFeedProcessorContext

The context related to the changes.

changes

Stream

The changes that happened.

checkpointAsync

Func<Task>

A task representing an asynchronous checkpoint on the progress of a lease.

cancellationToken

CancellationToken

A cancellation token representing the current cancellation status of the ChangeFeedProcessor instance.

Return Value

Task

A Task representing the asynchronous operation that is going to be done with the changes.

Examples

(ChangeFeedProcessorContext context, Stream stream, Func<Task> checkpointAsync, CancellationToken cancellationToken) =>
{
    // consume stream

    // On certain condition, we can checkpoint
    await checkpointAsync();
}