Share via

MessageProcessor.CompleteProcessingMessageAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.WebJobs.ServiceBus
Assembly:
Microsoft.Azure.WebJobs.ServiceBus.dll
Assembly:
Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll
Package:
Microsoft.Azure.WebJobs.ServiceBus v3.0.0-beta8
Package:
Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.4

Overloads

CompleteProcessingMessageAsync(Message, FunctionResult, CancellationToken)
CompleteProcessingMessageAsync(ServiceBusMessageActions, ServiceBusReceivedMessage, FunctionResult, CancellationToken)

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

CompleteProcessingMessageAsync(Message, FunctionResult, CancellationToken)

Source:
MessageProcessor.cs
public virtual System.Threading.Tasks.Task CompleteProcessingMessageAsync (Microsoft.Azure.ServiceBus.Message message, Microsoft.Azure.WebJobs.Host.Executors.FunctionResult result, System.Threading.CancellationToken cancellationToken);
abstract member CompleteProcessingMessageAsync : Microsoft.Azure.ServiceBus.Message * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteProcessingMessageAsync : Microsoft.Azure.ServiceBus.Message * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function CompleteProcessingMessageAsync (message As Message, result As FunctionResult, cancellationToken As CancellationToken) As Task

Parameters

message
Message
result
Microsoft.Azure.WebJobs.Host.Executors.FunctionResult
cancellationToken
CancellationToken

Returns

Task

Applies to

CompleteProcessingMessageAsync(ServiceBusMessageActions, ServiceBusReceivedMessage, FunctionResult, CancellationToken)

Source:
MessageProcessor.cs

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

protected internal virtual System.Threading.Tasks.Task CompleteProcessingMessageAsync (Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions actions, Azure.Messaging.ServiceBus.ServiceBusReceivedMessage message, Microsoft.Azure.WebJobs.Host.Executors.FunctionResult result, System.Threading.CancellationToken cancellationToken);
abstract member CompleteProcessingMessageAsync : Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions * Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.CompleteProcessingMessageAsync : Microsoft.Azure.WebJobs.ServiceBus.ServiceBusMessageActions * Azure.Messaging.ServiceBus.ServiceBusReceivedMessage * Microsoft.Azure.WebJobs.Host.Executors.FunctionResult * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Protected Friend Overridable Function CompleteProcessingMessageAsync (actions As ServiceBusMessageActions, message As ServiceBusReceivedMessage, result As FunctionResult, cancellationToken As CancellationToken) As Task

Parameters

actions
ServiceBusMessageActions

The set of actions that can be performed on a ServiceBusReceivedMessage.

message
ServiceBusReceivedMessage

The ServiceBusReceivedMessage to process.

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

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

cancellationToken
CancellationToken

A cancellation token that will be cancelled when the processor is shutting down.

Returns

Task

A Task that will complete the message processing.

Remarks

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

Applies to