ModuleClient クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
モジュールがサービスとの間でメッセージを送受信し、モジュール ツインと対話するために使用できるメソッドが含まれています。
public class ModuleClient : IDisposabletype ModuleClient = class
interface IDisposablePublic Class ModuleClient
Implements IDisposable- 継承
-
ModuleClient
- 実装
プロパティ
| DiagnosticSamplingPercentage |
診断サンプリングの割合。 |
| OperationTimeoutInMilliseconds |
操作の再試行で使用されるタイムアウトを格納します。 キャンセル トークンが指定された操作では、この値は無視されることに注意してください。 たとえば、SendEventAsync(Message) はこのタイムアウトを使用しますが、SendEventAsync(Message, CancellationToken) は使用しません。 後者の操作は、指定されたキャンセル トークンによってのみ取り消されます。 |
| ProductInfo |
IoT ハブに送信されるユーザー エージェント文字列に追加されるカスタム製品情報を格納します。 |
メソッド
| AbandonAsync(Message) |
受信したメッセージをモジュール キューに戻します。 |
| AbandonAsync(Message, CancellationToken) |
受信したメッセージをモジュール キューに戻します。 |
| AbandonAsync(String) |
受信したメッセージをモジュール キューに戻します。 |
| AbandonAsync(String, CancellationToken) |
受信したメッセージをモジュール キューに戻します。 |
| CloseAsync() |
ModuleClient インスタンスを閉じます。 |
| CloseAsync(CancellationToken) |
ModuleClient インスタンスを閉じます。 |
| CompleteAsync(Message) |
受信したメッセージをモジュール キューから削除します。 |
| CompleteAsync(Message, CancellationToken) |
受信したメッセージをモジュール キューから削除します。 |
| CompleteAsync(String) |
受信したメッセージをモジュール キューから削除します。 |
| CompleteAsync(String, CancellationToken) |
受信したメッセージをモジュール キューから削除します。 |
| Create(String, IAuthenticationMethod, ClientOptions) |
個々のパラメーターから AMQP ModuleClient を作成します。 |
| Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions) |
個々のパラメーターから ModuleClient を作成します。 |
| Create(String, IAuthenticationMethod, TransportType, ClientOptions) |
個々のパラメーターから ModuleClient を作成します。 |
| Create(String, String, IAuthenticationMethod, ClientOptions) |
個々のパラメーターから AMQP ModuleClient を作成します。 |
| Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions) |
個々のパラメーターから ModuleClient を作成します。 |
| Create(String, String, IAuthenticationMethod, TransportType, ClientOptions) |
個々のパラメーターから ModuleClient を作成します。 |
| CreateFromConnectionString(String, ClientOptions) |
指定した接続文字列から AMQP トランスポートを使用して ModuleClient を作成します。 |
| CreateFromConnectionString(String, ITransportSettings[], ClientOptions) |
トランスポートの優先順位付きリストを使用して、指定した接続文字列から ModuleClient を作成します。 |
| CreateFromConnectionString(String, TransportType, ClientOptions) |
指定したトランスポートの種類を使用して、指定した接続文字列から ModuleClient を作成します。 |
| CreateFromEnvironmentAsync(ClientOptions) |
環境変数に基づいて、IoT Edgeデプロイに ModuleClient インスタンスを作成します。 |
| CreateFromEnvironmentAsync(ITransportSettings[], ClientOptions) |
環境変数に基づいて、IoT Edgeデプロイに ModuleClient インスタンスを作成します。 |
| CreateFromEnvironmentAsync(TransportType, ClientOptions) |
環境変数に基づいて、IoT Edgeデプロイに ModuleClient インスタンスを作成します。 |
| Dispose() |
ModuleClient によって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを破棄します。 |
| Dispose(Boolean) |
ModuleClient によって使用されるアンマネージ リソースを解放し、派生クラスがカスタム実装をオーバーライドして提供できるようにします。 |
| GetTwinAsync() |
現在のモジュールのモジュール ツイン オブジェクトを取得します。 |
| GetTwinAsync(CancellationToken) |
現在のモジュールのモジュール ツイン オブジェクトを取得します。 |
| InvokeMethodAsync(String, MethodRequest) |
エッジ モジュールからエッジ デバイスにメソッドを対話的に呼び出します。 エッジ モジュールとエッジ デバイスの両方を同じエッジ ハブに接続する必要があります。 |
| InvokeMethodAsync(String, MethodRequest, CancellationToken) |
エッジ モジュールからエッジ デバイスにメソッドを対話的に呼び出します。 エッジ モジュールとエッジ デバイスの両方を同じエッジ ハブに接続する必要があります。 |
| InvokeMethodAsync(String, String, MethodRequest) |
エッジ モジュールから別のエッジ モジュールにメソッドを対話的に呼び出します。 両方のエッジ モジュールを同じエッジ ハブに接続する必要があります。 |
| InvokeMethodAsync(String, String, MethodRequest, CancellationToken) |
エッジ モジュールから別のエッジ モジュールにメソッドを対話的に呼び出します。 両方のエッジ モジュールを同じエッジ ハブに接続する必要があります。 |
| OpenAsync() |
ModuleClient インスタンスを明示的に開きます。 |
| OpenAsync(CancellationToken) |
ModuleClient インスタンスを明示的に開きます。 |
| SendEventAsync(Message) |
IoT ハブにイベントを送信します。 |
| SendEventAsync(Message, CancellationToken) |
IoT ハブにイベントを送信します。 |
| SendEventAsync(String, Message) |
IoT ハブにイベントを送信します。 |
| SendEventAsync(String, Message, CancellationToken) |
IoT ハブにイベントを送信します。 |
| SendEventBatchAsync(IEnumerable<Message>) |
イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信します。 IoT Edge モジュール ルーティングhttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routesの詳細については、 を参照してください。 |
| SendEventBatchAsync(IEnumerable<Message>, CancellationToken) |
イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信します。 IoT Edge モジュール ルーティングhttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routesの詳細については、 を参照してください。 |
| SendEventBatchAsync(String, IEnumerable<Message>) |
イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信します。 IoT Edge モジュール ルーティングの詳細については、以下を参照してください。https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes |
| SendEventBatchAsync(String, IEnumerable<Message>, CancellationToken) |
イベントのバッチを IoT ハブに送信します。 真のバッチ操作には AMQP または HTTP を使用します。 MQTT はメッセージを 1 つずつ送信します。 IoT Edge モジュール ルーティングの詳細については、以下を参照してください。https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes |
| SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler) |
接続状態変更コールバックの新しいデリゲートを設定します。 デリゲートが既に関連付けられている場合は、新しいデリゲートに置き換えられます。 クライアントが HTTP を使用するように構成されている場合、そのプロトコルはステートレスであるため、このコールバックは呼び出されません。 |
| SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object) |
クライアントがサービスから状態更新 (必要または報告) を受信するたびに呼び出されるコールバックを設定します。 クリアするには、コールバック値を null に設定します。 |
| SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken) |
クライアントがサービスから状態更新 (必要または報告) を受信するたびに呼び出されるコールバックを設定します。 クリアするには、コールバック値を null に設定します。 |
| SetInputMessageHandlerAsync(String, MessageHandler, Object) |
特定の入力の新しいデリゲートを設定します。 デリゲートが入力に既に関連付けられている場合は、新しいデリゲートに置き換えられます。 |
| SetInputMessageHandlerAsync(String, MessageHandler, Object, CancellationToken) |
特定の入力の新しいデリゲートを設定します。 デリゲートが入力に既に関連付けられている場合は、新しいデリゲートに置き換えられます。 |
| SetMessageHandlerAsync(MessageHandler, Object) |
すべてのエンドポイントに適用される新しい既定のデリゲートを設定します。 デリゲートが入力に既に関連付けられている場合は、そのデリゲートが呼び出され、それ以外の場合は既定のデリゲートが呼び出されます。 既定のデリゲートが以前に設定されている場合は、上書きされます。 |
| SetMessageHandlerAsync(MessageHandler, Object, CancellationToken) |
すべてのエンドポイントに適用される新しい既定のデリゲートを設定します。 デリゲートが入力に既に関連付けられている場合は、そのデリゲートが呼び出され、それ以外の場合は既定のデリゲートが呼び出されます。 既定のデリゲートが以前に設定されている場合は、上書きされます。 |
| SetMethodDefaultHandlerAsync(MethodCallback, Object) |
名前にデリゲートが登録されていないメソッドに対して呼び出される新しいデリゲートを設定します。 既定のデリゲートが既に登録されている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことで設定を解除できます。 |
| SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken) |
名前にデリゲートが登録されていないメソッドに対して呼び出される新しいデリゲートを設定します。 既定のデリゲートが既に登録されている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことで設定を解除できます。 |
| SetMethodHandlerAsync(String, MethodCallback, Object) |
名前付きメソッドの新しいデリゲートを設定します。 デリゲートが既に名前付きメソッドに関連付けられている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことで設定を解除できます。 |
| SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken) |
名前付きメソッドの新しいデリゲートを設定します。 デリゲートが既に名前付きメソッドに関連付けられている場合は、新しいデリゲートに置き換えられます。 メソッド ハンドラーは、null MethodCallback を渡すことで設定を解除できます。 |
| SetRetryPolicy(IRetryPolicy) |
操作の再試行で使用される再試行ポリシーを設定します。 変更は、進行中の操作の後に有効になります。 |
| UpdateReportedPropertiesAsync(TwinCollection) |
報告されたプロパティの変更をサービスにプッシュします。 |
| UpdateReportedPropertiesAsync(TwinCollection, CancellationToken) |
報告されたプロパティの変更をサービスにプッシュします。 |
適用対象
Azure SDK for .NET