Share via

PartitionContext.CheckpointAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.EventHubs.Processor
Assembly:
Microsoft.Azure.EventHubs.Processor.dll
Package:
Microsoft.Azure.EventHubs.Processor v4.3.2

Overloads

CheckpointAsync()

Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.
CheckpointAsync(EventData)

Stores the offset and sequenceNumber from the provided received EventData instance, then writes those values to the checkpoint store via the checkpoint manager.
CheckpointAsync(Checkpoint)

Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.

CheckpointAsync()

Source:
PartitionContext.cs

Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.

public System.Threading.Tasks.Task CheckpointAsync ();
member this.CheckpointAsync : unit -> System.Threading.Tasks.Task
Public Function CheckpointAsync () As Task

Returns

Task

Applies to

CheckpointAsync(EventData)

Source:
PartitionContext.cs

Stores the offset and sequenceNumber from the provided received EventData instance, then writes those values to the checkpoint store via the checkpoint manager.

public System.Threading.Tasks.Task CheckpointAsync (Microsoft.Azure.EventHubs.EventData eventData);
member this.CheckpointAsync : Microsoft.Azure.EventHubs.EventData -> System.Threading.Tasks.Task
Public Function CheckpointAsync (eventData As EventData) As Task

Parameters

eventData
EventData

A received EventData with valid offset and sequenceNumber

Returns

Task

Exceptions

ArgumentNullException

If suplied eventData is null

ArgumentOutOfRangeException

If the sequenceNumber is less than the last checkpointed value

Applies to

CheckpointAsync(Checkpoint)

Source:
PartitionContext.cs

Writes the current offset and sequenceNumber to the checkpoint store via the checkpoint manager.

public System.Threading.Tasks.Task CheckpointAsync (Microsoft.Azure.EventHubs.Processor.Checkpoint checkPoint);
member this.CheckpointAsync : Microsoft.Azure.EventHubs.Processor.Checkpoint -> System.Threading.Tasks.Task
Public Function CheckpointAsync (checkPoint As Checkpoint) As Task

Parameters

checkPoint
Checkpoint

Returns

Task

Applies to