DeviceClient.ReceiveAsync メソッド

  • リファレンス

定義

名前空間:
Microsoft.Azure.Devices.Client
アセンブリ:
Microsoft.Azure.Devices.Client.dll, Microsoft.Azure.Devices.Client.PCL.dll
アセンブリ:
Microsoft.Azure.Devices.Client.dll
パッケージ:
Microsoft.Azure.Devices.Client v1.41.2, Microsoft.Azure.Devices.Client.PCL v1.0.16
パッケージ:
Microsoft.Azure.Devices.Client v1.36.6

オーバーロード

ReceiveAsync(CancellationToken)

キャンセル トークンを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。
ReceiveAsync(TimeSpan)

タイムアウトを使用してデバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。
ReceiveAsync()

既定のタイムアウトを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message)をAbandonAsync(Message)呼び出CompleteAsync(Message)し、メッセージを破棄する必要があります。

ReceiveAsync(CancellationToken)

キャンセル トークンを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message> ReceiveAsync (System.Threading.CancellationToken cancellationToken);
member this.ReceiveAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message>
Public Function ReceiveAsync (cancellationToken As CancellationToken) As Task(Of Message)

パラメーター

cancellationToken
CancellationToken

操作をキャンセルするキャンセル トークン。

戻り値

Task<Message>

キャンセル トークンの有効期限が切れるまでメッセージが存在しない場合は、受信したメッセージまたは null

例外

OperationCanceledException

操作が取り消されたときにスローされます。

IotHubCommunicationException

操作が取り消されたときにスローされます。 内部例外は になります OperationCanceledException。

注釈

MQTT プロトコルを使用してメッセージを拒否または破棄することはできません。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#the-cloud-to-device-message-life-cycle」を参照してください。

適用対象

ReceiveAsync(TimeSpan)

タイムアウトを使用してデバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message, CancellationToken)をAbandonAsync(Message, CancellationToken)呼び出CompleteAsync(Message, CancellationToken)し、メッセージを破棄する必要があります。

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message> ReceiveAsync (TimeSpan timeout);
member this.ReceiveAsync : TimeSpan -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message>
Public Function ReceiveAsync (timeout As TimeSpan) As Task(Of Message)

パラメーター

timeout
TimeSpan

戻り値

Task<Message>

指定した時間が経過するまでメッセージが存在しない場合は、受信したメッセージまたは null。

注釈

MQTT プロトコルを使用してメッセージを拒否または破棄することはできません。 詳細については、「https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#the-cloud-to-device-message-life-cycle」を参照してください。

適用対象

ReceiveAsync()

既定のタイムアウトを使用して、デバイス キューからメッセージを受信します。 受信したメッセージを処理した後、クライアントは 、、または RejectAsync(Message)をAbandonAsync(Message)呼び出CompleteAsync(Message)し、メッセージを破棄する必要があります。

public System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message> ReceiveAsync ();
member this.ReceiveAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Client.Message>
Public Function ReceiveAsync () As Task(Of Message)

戻り値

Task<Message>

既定のタイムアウトまでメッセージが存在しない場合は、受信メッセージまたは null

注釈

https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-c2d#the-cloud-to-device-message-life-cycle.

適用対象