EventProcessor<TPartition>.StartProcessingAsync Method
Definition
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 EventProcessor<TPartition> to begin processing events. Should this method be called while the processor is running, no action is taken.
public virtual System.Threading.Tasks.Task StartProcessingAsync (System.Threading.CancellationToken cancellationToken = default);
abstract member StartProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.StartProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable 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 EventProcessor<TPartition> once it starts running.
Returns
Exceptions
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 query the Event Hub would be detected. These exceptions will be packaged as an AggregateException, and will cause StartProcessingAsync(CancellationToken) to fail.