EventHubBufferedProducerClient.OnSendFailedAsync Method

Definition

Namespace:

Azure.Messaging.EventHubs.Producer

Assembly:

Azure.Messaging.EventHubs.dll

Package:

Azure.Messaging.EventHubs v5.11.5

Source:

EventHubBufferedProducerClient.cs

Responsible for raising the SendEventBatchFailedAsync event upon the failed publishing of a batch of events, after all eligible retries are exhausted.

protected virtual System.Threading.Tasks.Task OnSendFailedAsync (System.Collections.Generic.IReadOnlyList<Azure.Messaging.EventHubs.EventData> events, Exception exception, string partitionId, System.Threading.CancellationToken cancellationToken = default);

abstract member OnSendFailedAsync : System.Collections.Generic.IReadOnlyList<Azure.Messaging.EventHubs.EventData> * Exception * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.OnSendFailedAsync : System.Collections.Generic.IReadOnlyList<Azure.Messaging.EventHubs.EventData> * Exception * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Overridable Function OnSendFailedAsync (events As IReadOnlyList(Of EventData), exception As Exception, partitionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

events

IReadOnlyList<EventData>

The set of events belonging to the batch that failed to be published.

exception

Exception

The Exception that was raised when the events failed to publish.

partitionId

String

The identifier of the partition that the batch of events was published to.

cancellationToken

CancellationToken

A CancellationToken instance to signal the request to cancel publishing.

Returns

Task