EventProcessorClient.StartProcessingAsync(CancellationToken) Method

Reference

Definition

Namespace:: Azure.Messaging.EventHubs

Assembly:: Azure.Messaging.EventHubs.Processor.dll

Package:: Azure.Messaging.EventHubs.Processor v5.11.2

Source:: EventProcessorClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Signals the EventProcessorClient to begin processing events. Should this method be called while the processor is running, no action is taken.

public override System.Threading.Tasks.Task StartProcessingAsync (System.Threading.CancellationToken cancellationToken = default);

override this.StartProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function StartProcessingAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken: CancellationToken

A CancellationToken instance to signal the request to cancel the start operation. This won't affect the EventProcessorClient once it starts running.

Returns

Task

Exceptions

EventHubsException

Occurs when this EventProcessorClient instance is already closed.

InvalidOperationException

Occurs when either the ProcessEventAsync handler or ProcessErrorAsync handler has not been registered.

AggregateException

As the processor starts, it will attempt to detect configuration and permissions errors that would prevent it from being able to recover without intervention. For example, an incorrect connection string or the inability to write to the storage container would be detected. These exceptions will be packaged as an AggregateException, and will cause StartProcessingAsync(CancellationToken) to fail.

Applies to