QueueProcessor Class

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

Applies to

Share via