DeviceClient.SetReceiveMessageHandlerAsync Method

Definition

Namespace:

Microsoft.Azure.Devices.Client

Assemblies:

Microsoft.Azure.Devices.Client.dll, Microsoft.Azure.Devices.Client.PCL.dll

Packages:

Microsoft.Azure.Devices.Client v1.41.2, Microsoft.Azure.Devices.Client.PCL v1.0.16

Sets a new delegate for receiving a message from the device queue using a cancellation token. After handling a received message, a client should call CompleteAsync(Message, CancellationToken), AbandonAsync(Message, CancellationToken), or RejectAsync(Message, CancellationToken), and then dispose the message. If a null delegate is passed, it will disable the callback triggered on receiving messages from the service.

public System.Threading.Tasks.Task SetReceiveMessageHandlerAsync (Microsoft.Azure.Devices.Client.ReceiveMessageCallback messageHandler, object userContext, System.Threading.CancellationToken cancellationToken = default);

member this.SetReceiveMessageHandlerAsync : Microsoft.Azure.Devices.Client.ReceiveMessageCallback * obj * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function SetReceiveMessageHandlerAsync (messageHandler As ReceiveMessageCallback, userContext As Object, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

messageHandler

ReceiveMessageCallback

userContext

Object

cancellationToken

CancellationToken

Returns

Task