Class SessionMessageProcessor

Inheritance

System.Object

SessionMessageProcessor

Namespace: System.Dynamic.ExpandoObject

Assembly: Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Syntax

public class SessionMessageProcessor

Constructors

SessionMessageProcessor(ServiceBusSessionProcessor)

Initializes a new instance of SessionMessageProcessor.

Declaration

protected internal SessionMessageProcessor (Azure.Messaging.ServiceBus.ServiceBusSessionProcessor processor);

Parameters

Azure.Messaging.ServiceBus.ServiceBusSessionProcessor processor The Azure.Messaging.ServiceBus.ServiceBusSessionProcessor to use for processing messages from Service Bus.

Properties

Processor

Gets the Azure.Messaging.ServiceBus.ServiceBusSessionProcessor that will be used by the SessionMessageProcessor.

Declaration

protected internal Azure.Messaging.ServiceBus.ServiceBusSessionProcessor Processor { get; }

Property Value

Azure.Messaging.ServiceBus.ServiceBusSessionProcessor

Methods

BeginProcessingMessageAsync(ServiceBusSessionMessageActions, ServiceBusReceivedMessage, 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.

Declaration

protected internal virtual System.Threading.Tasks.Task<bool> BeginProcessingMessageAsync (Microsoft.Azure.WebJobs.ServiceBus.ServiceBusSessionMessageActions actions, Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, System.Threading.CancellationToken cancellationToken);

Parameters

ServiceBusSessionMessageActions actions The set of actions that can be performed on a Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.

Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message The Azure.Messaging.ServiceBus.ServiceBusReceivedMessage to process.

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken to use.

Returns

System.Threading.Tasks.Task<System.Boolean> A System.Threading.Tasks.Task that returns true if the message processing should continue, false otherwise.

CompleteProcessingMessageAsync(ServiceBusSessionMessageActions, ServiceBusReceivedMessage, FunctionResult, CancellationToken)

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

Declaration

protected internal virtual System.Threading.Tasks.Task CompleteProcessingMessageAsync (Microsoft.Azure.WebJobs.ServiceBus.ServiceBusSessionMessageActions actions, Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, Microsoft.Azure.WebJobs.Host.Executors.FunctionResult result, System.Threading.CancellationToken cancellationToken);

Parameters

ServiceBusSessionMessageActions actions The set of actions that can be performed on a Azure.Messaging.ServiceBus.ServiceBusReceivedMessage.

Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message The Azure.Messaging.ServiceBus.ServiceBusReceivedMessage to process.

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

System.Threading.CancellationToken cancellationToken The System.Threading.CancellationToken to use

Returns

System.Threading.Tasks.Task A System.Threading.Tasks.Task that will complete the message processing.

Remarks

The message is completed by the ServiceBus SDK based on how the Azure.Messaging.ServiceBus.ServiceBusSessionProcessorOptions.AutoCompleteMessages option is configured. E.g. if Azure.Messaging.ServiceBus.ServiceBusSessionProcessorOptions.AutoCompleteMessages is false, it is up to the job function to complete the message.