QueueProcessor.CompleteProcessingMessageAsync 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

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.

This method completes processing of the specified message, after the job function has been invoked.

protected internal virtual System.Threading.Tasks.Task CompleteProcessingMessageAsync (Azure.Storage.Queues.Models.QueueMessage message, Microsoft.Azure.WebJobs.Host.Executors.FunctionResult result, System.Threading.CancellationToken cancellationToken);

abstract member CompleteProcessingMessageAsync : Azure.Storage.Queues.Models.QueueMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteProcessingMessageAsync : Azure.Storage.Queues.Models.QueueMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Protected Friend Overridable Function CompleteProcessingMessageAsync (message As QueueMessage, result As FunctionResult, cancellationToken As CancellationToken) As Task

Parameters

message: QueueMessage

The message to complete processing for.

result: Microsoft.Azure.WebJobs.Host.Executors.FunctionResult

The Microsoft.Azure.WebJobs.Host.Executors.FunctionResult from the job invocation.

cancellationToken: CancellationToken

The CancellationToken to use.

Returns

Task

Remarks

If the message was processed successfully, the message should be deleted. If message processing failed, the message should be release back to the queue, or if the maximum dequeue count has been exceeded, the message should be moved to the poison queue (if poison queue handling is configured for the queue).

Applies to

Share via