Del via


Container.ChangesEstimationHandler Delegate

Definition

Delegate to receive the estimation of pending changes to be read by the associated ChangeFeedProcessor instance.

public delegate System.Threading.Tasks.Task Container.ChangesEstimationHandler(long estimatedPendingChanges, CancellationToken cancellationToken);
type Container.ChangesEstimationHandler = delegate of int64 * CancellationToken -> Task
Public Delegate Function Container.ChangesEstimationHandler(estimatedPendingChanges As Long, cancellationToken As CancellationToken) As Task 

Parameters

estimatedPendingChanges
Int64

An estimation in number of transactions.

cancellationToken
CancellationToken

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

Return Value

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

Remarks

The estimation over the Change Feed identifies volumes of transactions. If operations in the container are performed through stored procedures, transactional batch or bulk, a group of operations may share the same transaction scope and represented by a single transaction. In those cases, the estimation might not exactly represent number of items, but it is still valid to understand if the pending volume is increasing, decreasing, or on a steady state.

Applies to