QueueProcessor.BeginProcessingMessageAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.WebJobs.Host.Queues
Assembly:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues.dll
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.1
Package:
Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.0-beta.1
Source:
QueueProcessor.cs
Source:
QueueProcessor.cs

This method is called when there is a new message to process, before the job function is invoked. This allows any preprocessing to take place on the message before processing begins.

protected internal virtual System.Threading.Tasks.Task<bool> BeginProcessingMessageAsync (Azure.Storage.Queues.Models.QueueMessage message, System.Threading.CancellationToken cancellationToken);
abstract member BeginProcessingMessageAsync : Azure.Storage.Queues.Models.QueueMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.BeginProcessingMessageAsync : Azure.Storage.Queues.Models.QueueMessage * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Protected Friend Overridable Function BeginProcessingMessageAsync (message As QueueMessage, cancellationToken As CancellationToken) As Task(Of Boolean)

Parameters

message
QueueMessage

The message to process.

cancellationToken
CancellationToken

The CancellationToken to use

Returns

Task<Boolean>

True if the message processing should continue, false otherwise.

Applies to