ModuleClient Classe

  • Referência

Definição

Namespace:
Microsoft.Azure.Devices.Client
Assembly:
Microsoft.Azure.Devices.Client.dll
Pacote:
Microsoft.Azure.Devices.Client v1.41.2
Pacote:
Microsoft.Azure.Devices.Client v1.36.6

Contém métodos que um módulo pode usar para enviar mensagens e receber do serviço e interagir com módulos gêmeos.

public class ModuleClient : IDisposable
type ModuleClient = class
    interface IDisposable
Public Class ModuleClient
Implements IDisposable
Herança
Object
ModuleClient
Implementações
IDisposable

Propriedades

DiagnosticSamplingPercentage

O percentual de amostragem de diagnóstico.
OperationTimeoutInMilliseconds

Armazena o tempo limite usado nas tentativas de operação. Observe que esse valor é ignorado para operações em que um token de cancelamento é fornecido. Por exemplo, SendEventAsync(Message) usará esse tempo limite, mas SendEventAsync(Message, CancellationToken) não. A última operação só será cancelada pelo token de cancelamento fornecido.
ProductInfo

Armazena informações personalizadas do produto que serão acrescentadas à cadeia de caracteres do agente do usuário que é enviada ao Hub IoT.

Métodos

AbandonAsync(Message)

Coloca uma mensagem recebida de volta na fila do módulo.
AbandonAsync(Message, CancellationToken)

Coloca uma mensagem recebida de volta na fila do módulo.
AbandonAsync(String)

Coloca uma mensagem recebida de volta na fila do módulo.
AbandonAsync(String, CancellationToken)

Coloca uma mensagem recebida de volta na fila do módulo.
CloseAsync()

Feche a instância moduleClient.
CloseAsync(CancellationToken)

Feche a instância moduleClient.
CompleteAsync(Message)

Exclui uma mensagem recebida da fila do módulo.
CompleteAsync(Message, CancellationToken)

Exclui uma mensagem recebida da fila do módulo.
CompleteAsync(String)

Exclui uma mensagem recebida da fila do módulo.
CompleteAsync(String, CancellationToken)

Exclui uma mensagem recebida da fila do módulo.
Create(String, IAuthenticationMethod, ClientOptions)

Cria um ModuleClient AMQP com base em parâmetros individuais.
Create(String, IAuthenticationMethod, ITransportSettings[], ClientOptions)

Cria um ModuleClient com base em parâmetros individuais.
Create(String, IAuthenticationMethod, TransportType, ClientOptions)

Cria um ModuleClient com base em parâmetros individuais.
Create(String, String, IAuthenticationMethod, ClientOptions)

Cria um ModuleClient AMQP com base em parâmetros individuais.
Create(String, String, IAuthenticationMethod, ITransportSettings[], ClientOptions)

Cria um ModuleClient com base em parâmetros individuais.
Create(String, String, IAuthenticationMethod, TransportType, ClientOptions)

Cria um ModuleClient com base em parâmetros individuais.
CreateFromConnectionString(String, ClientOptions)

Cria um ModuleClient usando o transporte AMQP da cadeia de conexão especificada.
CreateFromConnectionString(String, ITransportSettings[], ClientOptions)

Cria ModuleClient com base na cadeia de conexão especificada usando uma lista priorizada de transportes.
CreateFromConnectionString(String, TransportType, ClientOptions)

Cria ModuleClient com base na cadeia de conexão especificada usando o tipo de transporte especificado.
CreateFromEnvironmentAsync(ClientOptions)

Cria uma instância moduleClient em uma implantação IoT Edge com base em variáveis de ambiente.
CreateFromEnvironmentAsync(ITransportSettings[], ClientOptions)

Cria uma instância moduleClient em uma implantação IoT Edge com base em variáveis de ambiente.
CreateFromEnvironmentAsync(TransportType, ClientOptions)

Cria uma instância moduleClient em uma implantação IoT Edge com base em variáveis de ambiente.
Dispose()

Libera os recursos não gerenciados usados pelo ModuleClient e, opcionalmente, descarta os recursos gerenciados.
Dispose(Boolean)

Libera os recursos não gerenciados usados pelo ModuleClient e permite que qualquer classe derivada substitua e forneça implementação personalizada.
GetTwinAsync()

Recupere um objeto de módulo gêmeo para o módulo atual.
GetTwinAsync(CancellationToken)

Recupere um objeto de módulo gêmeo para o módulo atual.
InvokeMethodAsync(String, MethodRequest)

Invoca interativamente um método de um módulo de borda para um dispositivo de borda. O módulo de borda e o dispositivo de borda precisam estar conectados ao mesmo hub de borda.
InvokeMethodAsync(String, MethodRequest, CancellationToken)

Invoca interativamente um método de um módulo de borda para um dispositivo de borda. O módulo de borda e o dispositivo de borda precisam estar conectados ao mesmo hub de borda.
InvokeMethodAsync(String, String, MethodRequest)

Invoca interativamente um método de um módulo de borda para um módulo de borda diferente. Ambos os módulos de borda precisam estar conectados ao mesmo hub de borda.
InvokeMethodAsync(String, String, MethodRequest, CancellationToken)

Invoca interativamente um método de um módulo de borda para um módulo de borda diferente. Ambos os módulos de borda precisam estar conectados ao mesmo hub de borda.
OpenAsync()

Abra explicitamente a instância ModuleClient.
OpenAsync(CancellationToken)

Abra explicitamente a instância ModuleClient.
SendEventAsync(Message)

Envia um evento para o Hub IoT.
SendEventAsync(Message, CancellationToken)

Envia um evento para o Hub IoT.
SendEventAsync(String, Message)

Envia um evento para o Hub IoT.
SendEventAsync(String, Message, CancellationToken)

Envia um evento para o Hub IoT.
SendEventBatchAsync(IEnumerable<Message>)

Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra. Para obter mais informações sobre IoT Edge roteamento de https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routesmódulo .
SendEventBatchAsync(IEnumerable<Message>, CancellationToken)

Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra. Para obter mais informações sobre IoT Edge roteamento de https://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routesmódulo .
SendEventBatchAsync(String, IEnumerable<Message>)

Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra. Para obter mais informações sobre IoT Edge roteamento de módulohttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes
SendEventBatchAsync(String, IEnumerable<Message>, CancellationToken)

Envia um lote de eventos para o Hub IoT. Use AMQP ou HTTPs para uma operação de lote verdadeira. O MQTT enviará apenas as mensagens uma após a outra. Para obter mais informações sobre IoT Edge roteamento de módulohttps://docs.microsoft.com/azure/iot-edge/module-composition?view=iotedge-2018-06#declare-routes
SetConnectionStatusChangesHandler(ConnectionStatusChangesHandler)

Define um novo delegado para a conexão status retorno de chamada alterado. Se um delegado já estiver associado, ele será substituído pelo novo delegado. Observe que esse retorno de chamada nunca será chamado se o cliente estiver configurado para usar HTTP, pois esse protocolo é sem estado
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object)

Defina um retorno de chamada que será chamado sempre que o cliente receber uma atualização de estado (desejada ou relatada) do serviço. Defina o valor de retorno de chamada como nulo para limpar.
SetDesiredPropertyUpdateCallbackAsync(DesiredPropertyUpdateCallback, Object, CancellationToken)

Defina um retorno de chamada que será chamado sempre que o cliente receber uma atualização de estado (desejada ou relatada) do serviço. Defina o valor de retorno de chamada como nulo para limpar.
SetInputMessageHandlerAsync(String, MessageHandler, Object)

Define um novo delegado para a entrada específica. Se um delegado já estiver associado à entrada, ele será substituído pelo novo delegado.
SetInputMessageHandlerAsync(String, MessageHandler, Object, CancellationToken)

Define um novo delegado para a entrada específica. Se um delegado já estiver associado à entrada, ele será substituído pelo novo delegado.
SetMessageHandlerAsync(MessageHandler, Object)

Define um novo delegado padrão que se aplica a todos os pontos de extremidade. Se um delegado já estiver associado à entrada, ele será chamado; caso contrário, o delegado padrão será chamado. Se um delegado padrão tiver sido definido anteriormente, ele será substituído.
SetMessageHandlerAsync(MessageHandler, Object, CancellationToken)

Define um novo delegado padrão que se aplica a todos os pontos de extremidade. Se um delegado já estiver associado à entrada, ele será chamado; caso contrário, o delegado padrão será chamado. Se um delegado padrão tiver sido definido anteriormente, ele será substituído.
SetMethodDefaultHandlerAsync(MethodCallback, Object)

Define um novo delegado que é chamado para um método que não tem um delegado registrado para seu nome. Se um delegado padrão já estiver registrado, ele substituirá pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodDefaultHandlerAsync(MethodCallback, Object, CancellationToken)

Define um novo delegado que é chamado para um método que não tem um delegado registrado para seu nome. Se um delegado padrão já estiver registrado, ele substituirá pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodHandlerAsync(String, MethodCallback, Object)

Define um novo delegado para o método nomeado. Se um delegado já estiver associado ao método nomeado, ele será substituído pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetMethodHandlerAsync(String, MethodCallback, Object, CancellationToken)

Define um novo delegado para o método nomeado. Se um delegado já estiver associado ao método nomeado, ele será substituído pelo novo delegado. Um manipulador de método pode ser desconjunto passando um MethodCallback nulo.
SetRetryPolicy(IRetryPolicy)

Define a política de repetição usada nas tentativas de operação. A alteração entrará em vigor após qualquer operação em andamento.
UpdateReportedPropertiesAsync(TwinCollection)

Efetuar push das alterações de propriedade relatadas para o serviço.
UpdateReportedPropertiesAsync(TwinCollection, CancellationToken)

Efetuar push das alterações de propriedade relatadas para o serviço.

Aplica-se a