ModuleClient Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Enthält Methoden, die ein Modul verwenden kann, um Nachrichten an den Dienst zu senden und von diesem zu empfangen und mit Modulzwillys zu interagieren.
public class ModuleClient : IDisposabletype ModuleClient = class
interface IDisposablePublic Class ModuleClient
Implements IDisposable- Vererbung
-
ModuleClient
- Implementiert
Eigenschaften
| DiagnosticSamplingPercentage |
Der Prozentsatz der Diagnosestichproben. |
| OperationTimeoutInMilliseconds |
Speichert das Timeout, das in den Vorgangsversuchen verwendet wird. Beachten Sie, dass dieser Wert für Vorgänge ignoriert wird, bei denen ein Abbruchtoken bereitgestellt wird. Beispielsweise verwendet SendEventAsync(Message) dieses Timeout, SendEventAsync(Message, CancellationToken) hingegen nicht. Der letztere Vorgang wird nur durch das bereitgestellte Abbruchtoken abgebrochen. |
| ProductInfo |
Speichert benutzerdefinierte Produktinformationen, die an die Benutzer-Agent-Zeichenfolge angefügt werden, die an IoT Hub gesendet wird. |
Methoden
| AbandonAsync(Message) |
Fügt eine empfangene Nachricht wieder in die Modulwarteschlange ein. |
| AbandonAsync(Message, CancellationToken) |
Fügt eine empfangene Nachricht wieder in die Modulwarteschlange ein. |
| AbandonAsync(String) |
Fügt eine empfangene Nachricht wieder in die Modulwarteschlange ein. |
| AbandonAsync(String, CancellationToken) |
Fügt eine empfangene Nachricht wieder in die Modulwarteschlange ein. |
| CloseAsync() |
Schließen Sie die moduleClient-instance. |
| CloseAsync(CancellationToken) |
Schließen Sie die moduleClient-instance. |
| CompleteAsync(Message) |
Löscht eine empfangene Nachricht aus der Modulwarteschlange. |
| CompleteAsync(Message, CancellationToken) |
Löscht eine empfangene Nachricht aus der Modulwarteschlange. |
| CompleteAsync(String) |
Löscht eine empfangene Nachricht aus der Modulwarteschlange. |
| CompleteAsync(String, CancellationToken) |
Löscht eine empfangene Nachricht aus der Modulwarteschlange. |
| Create(String, IAuthenticationMethod, ClientOptions) |
Erstellt einen AMQP ModuleClient aus einzelnen Parametern. |
| Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions) |
Erstellt einen ModuleClient aus einzelnen Parametern. |
| Create(String, IAuthenticationMethod, TransportType, ClientOptions) |
Erstellt einen ModuleClient aus einzelnen Parametern. |
| Create(String, String, IAuthenticationMethod, ClientOptions) |
Erstellt einen AMQP ModuleClient aus einzelnen Parametern. |
| Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions) |
Erstellt einen ModuleClient aus einzelnen Parametern. |
| Create(String, String, IAuthenticationMethod, TransportType, ClientOptions) |
Erstellt einen ModuleClient aus einzelnen Parametern. |
| CreateFromConnectionString(String, ClientOptions) |
Erstellt einen ModuleClient mithilfe des AMQP-Transports aus der angegebenen Verbindungszeichenfolge. |
| CreateFromConnectionString(String, ITransportSettings[], ClientOptions) |
Erstellt ModuleClient aus der angegebenen Verbindungszeichenfolge mithilfe einer priorisierten Liste von Transporten. |
| CreateFromConnectionString(String, TransportType, ClientOptions) |
Erstellt ModuleClient aus der angegebenen Verbindungszeichenfolge unter Verwendung des angegebenen Transporttyps. |
| CreateFromEnvironmentAsync(ClientOptions) |
Erstellt einen ModuleClient-instance in einer IoT Edge-Bereitstellung basierend auf Umgebungsvariablen. |
| CreateFromEnvironmentAsync(ITransportSettings[], ClientOptions) |
Erstellt einen ModuleClient-instance in einer IoT Edge-Bereitstellung basierend auf Umgebungsvariablen. |
| CreateFromEnvironmentAsync(TransportType, ClientOptions) |
Erstellt einen ModuleClient-instance in einer IoT Edge-Bereitstellung basierend auf Umgebungsvariablen. |
| Dispose() |
Gibt die nicht verwalteten Ressourcen frei, die vom ModuleClient verwendet werden, und entsorgt optional die verwalteten Ressourcen. |
| Dispose(Boolean) |
Gibt die nicht verwalteten Ressourcen frei, die vom ModuleClient verwendet werden, und ermöglicht es jeder abgeleiteten Klasse, die benutzerdefinierte Implementierung zu überschreiben und bereitzustellen. |
| GetTwinAsync() |
Rufen Sie ein Modulzwillwillungsobjekt für das aktuelle Modul ab. |
| GetTwinAsync(CancellationToken) |
Rufen Sie ein Modulzwillwillungsobjekt für das aktuelle Modul ab. |
| InvokeMethodAsync(String, MethodRequest) |
Ruft interaktiv eine Methode von einem Edgemodul zu einem Edgegerät auf. Sowohl das Edgemodul als auch das Edgegerät müssen mit demselben Edgehub verbunden sein. |
| InvokeMethodAsync(String, MethodRequest, CancellationToken) |
Ruft interaktiv eine Methode von einem Edgemodul zu einem Edgegerät auf. Sowohl das Edgemodul als auch das Edgegerät müssen mit demselben Edgehub verbunden sein. |
| InvokeMethodAsync(String, String, MethodRequest) |
Ruft interaktiv eine Methode von einem Edgemodul zu einem anderen Edgemodul auf. Beide Edgemodule müssen mit demselben Edgehub verbunden sein. |
| InvokeMethodAsync(String, String, MethodRequest, CancellationToken) |
Ruft interaktiv eine Methode von einem Edgemodul zu einem anderen Edgemodul auf. Beide Edgemodule müssen mit demselben Edgehub verbunden sein. |
| OpenAsync() |
Öffnen Sie explizit die moduleClient-instance. |
| OpenAsync(CancellationToken) |
Öffnen Sie explizit die moduleClient-instance. |
| SendEventAsync(Message) |
Sendet ein Ereignis an IoT Hub. |
| SendEventAsync(Message, CancellationToken) |
Sendet ein Ereignis an IoT Hub. |
| SendEventAsync(String, Message) |
Sendet ein Ereignis an IoT Hub. |
| SendEventAsync(String, Message, CancellationToken) |
Sendet ein Ereignis an IoT Hub. |
| SendEventBatchAsync(IEnumerable<Message>) |
Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander. Weitere Informationen zum IoT Edge Modulroutinghttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes. |
| SendEventBatchAsync(IEnumerable<Message>, CancellationToken) |
Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander. Weitere Informationen zum IoT Edge Modulroutinghttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes. |
| SendEventBatchAsync(String, IEnumerable<Message>) |
Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander. Weitere Informationen zum IoT Edge Modulroutinghttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes |
| SendEventBatchAsync(String, IEnumerable<Message>, CancellationToken) |
Sendet einen Batch von Ereignissen an IoT Hub. Verwenden Sie AMQP oder HTTPs für einen echten Batchvorgang. MQTT sendet die Nachrichten einfach nacheinander. Weitere Informationen zum IoT Edge Modulroutinghttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes |
| SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler) |
Legt einen neuen Delegaten für die Verbindung status geänderten Rückrufs fest. Wenn ein Delegat bereits zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Beachten Sie, dass dieser Rückruf nie aufgerufen wird, wenn der Client für die Verwendung von HTTP konfiguriert ist, da dieses Protokoll zustandslos ist. |
| SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object) |
Legen Sie einen Rückruf fest, der immer dann aufgerufen wird, wenn der Client eine Zustandsaktualisierung (gewünscht oder gemeldet) vom Dienst empfängt. Legen Sie den Rückrufwert auf NULL fest, um ihn zu löschen. |
| SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken) |
Legen Sie einen Rückruf fest, der immer dann aufgerufen wird, wenn der Client eine Zustandsaktualisierung (gewünscht oder gemeldet) vom Dienst empfängt. Legen Sie den Rückrufwert auf NULL fest, um ihn zu löschen. |
| SetInputMessageHandlerAsync(String, MessageHandler, Object) |
Legt einen neuen Delegaten für die jeweilige Eingabe fest. Wenn der Eingabe bereits ein Delegat zugeordnet ist, wird sie durch den neuen Delegaten ersetzt. |
| SetInputMessageHandlerAsync(String, MessageHandler, Object, CancellationToken) |
Legt einen neuen Delegaten für die jeweilige Eingabe fest. Wenn der Eingabe bereits ein Delegat zugeordnet ist, wird sie durch den neuen Delegaten ersetzt. |
| SetMessageHandlerAsync(MessageHandler, Object) |
Legt einen neuen Standarddelegat fest, der für alle Endpunkte gilt. Wenn der Eingabe bereits ein Delegat zugeordnet ist, wird sie aufgerufen, andernfalls wird der Standarddelegat aufgerufen. Wenn zuvor ein Standarddelegat festgelegt wurde, wird er überschrieben. |
| SetMessageHandlerAsync(MessageHandler, Object, CancellationToken) |
Legt einen neuen Standarddelegat fest, der für alle Endpunkte gilt. Wenn der Eingabe bereits ein Delegat zugeordnet ist, wird sie aufgerufen, andernfalls wird der Standarddelegat aufgerufen. Wenn zuvor ein Standarddelegat festgelegt wurde, wird er überschrieben. |
| SetMethodDefaultHandlerAsync(MethodCallback, Object) |
Legt einen neuen Delegaten fest, der für eine Methode aufgerufen wird, für die kein Delegat für ihren Namen registriert ist. Wenn ein Standarddelegat bereits registriert ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden. |
| SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken) |
Legt einen neuen Delegaten fest, der für eine Methode aufgerufen wird, für die kein Delegat für ihren Namen registriert ist. Wenn ein Standarddelegat bereits registriert ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden. |
| SetMethodHandlerAsync(String, MethodCallback, Object) |
Legt einen neuen Delegaten für die benannte Methode fest. Wenn der benannten Methode bereits ein Delegat zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden. |
| SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken) |
Legt einen neuen Delegaten für die benannte Methode fest. Wenn der benannten Methode bereits ein Delegat zugeordnet ist, wird er durch den neuen Delegaten ersetzt. Ein Methodenhandler kann durch Übergeben eines Null-MethodCallback-Objekts nicht festgelegt werden. |
| SetRetryPolicy(IRetryPolicy) |
Legt die Wiederholungsrichtlinie fest, die in den Wiederholungsversuchen des Vorgangs verwendet wird. Die Änderung wird nach allen laufenden Vorgängen wirksam. |
| UpdateReportedPropertiesAsync(TwinCollection) |
Übertragen von gemeldeten Eigenschaftsänderungen an den Dienst. |
| UpdateReportedPropertiesAsync(TwinCollection, CancellationToken) |
Übertragen von gemeldeten Eigenschaftsänderungen an den Dienst. |
Gilt für:
Azure SDK for .NET