Share via


IotHubBaseClient.SetIncomingMessageCallbackAsync Method

Definition

Sets a callback for receiving a message from the device or module queue using a cancellation token. This instance must be opened already.

public System.Threading.Tasks.Task SetIncomingMessageCallbackAsync (Func<Microsoft.Azure.Devices.Client.IncomingMessage,System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.MessageAcknowledgement>> messageCallback, System.Threading.CancellationToken cancellationToken = default);
member this.SetIncomingMessageCallbackAsync : Func<Microsoft.Azure.Devices.Client.IncomingMessage, System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.MessageAcknowledgement>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Function SetIncomingMessageCallbackAsync (messageCallback As Func(Of IncomingMessage, Task(Of MessageAcknowledgement)), Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

messageCallback
Func<IncomingMessage,Task<MessageAcknowledgement>>

The callback to be invoked when a cloud-to-device message is received by the client.

cancellationToken
CancellationToken

A cancellation token to cancel the operation.

Returns

Exceptions

Thrown if instance is not opened already.

Thrown when the operation has been canceled.

Remarks

Calling this API more than once will result in the callback set last overwriting any previously set callback. A method callback can be unset by setting messageCallback to null.

Applies to