QueueProcessor Class

Definition

Namespace:

Microsoft.Azure.WebJobs.Host.Queues

Assembly:

Microsoft.Azure.WebJobs.Extensions.Storage.Queues.dll

Package:

Microsoft.Azure.WebJobs.Extensions.Storage.Queues v5.3.3

Source:

QueueProcessor.cs

This class defines a strategy used for processing queue messages.

public class QueueProcessor

type QueueProcessor = class

Public Class QueueProcessor

Inheritance

Object

QueueProcessor

Remarks

Custom QueueProcessor implementations can be registered by implementing a custom IQueueProcessorFactory.

Constructors

QueueProcessor(QueueProcessorOptions)

Constructs a new instance.

Methods

BeginProcessingMessageAsync(QueueMessage, CancellationToken)	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.
CompleteProcessingMessageAsync(QueueMessage, FunctionResult, CancellationToken)	This method completes processing of the specified message, after the job function has been invoked.
CopyMessageToPoisonQueueAsync(QueueMessage, QueueClient, CancellationToken)	Moves the specified message to the poison queue.
DeleteMessageAsync(QueueMessage, CancellationToken)	Delete the specified message.
OnMessageAddedToPoisonQueueAsync(PoisonMessageEventArgs)	Called to raise the MessageAddedToPoisonQueue event.
ReleaseMessageAsync(QueueMessage, FunctionResult, TimeSpan, CancellationToken)	Release the specified failed message back to the queue.

Events

MessageAddedToPoisonQueueAsync

Event raised when a message is added to the poison queue.