nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

#include <src/lib/profiles/device-description/DeviceDescription.h>

Objeto do cliente para a emissão de solicitações de descrição do dispositivo.

Resumo

Construtores e destrutores
DeviceDescriptionClient(void)

Tipos públicos
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Essa função é responsável por processar mensagens IdentityResponse.

Atributos públicos
AppState
void *
Objeto de estado definido pelo aplicativo.
ExchangeMgr
[SOMENTE LEITURA] Objeto do gerenciador de troca
FabricState
[SOMENTE LEITURA] Objeto de estado do Fabric
OnIdentifyResponseReceived

Funções públicas
CancelExchange(void)
Cancele uma troca IdentityRequest em andamento aguardando uma resposta.
Init(WeaveExchangeManager *exchangeMgr)
Inicializar o estado do cliente de descrição do dispositivo.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
enviar uma mensagem IdentityRequest para um endereço IP específico.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Envia uma mensagem de transmissão IdentityRequest para descobrir nós do Weave.
Shutdown(void)
Encerre o cliente de descrição do dispositivo.

Tipos públicos

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

Essa função é responsável por processar mensagens IdentityResponse.

Detalhes
Parâmetros
[in] appState
Um ponteiro para o conjunto de estado definido pelo aplicativo ao criar o contexto do IdentityRequest Exchange.
[in] nodeId
O ID do nó do Weave da origem da mensagem.
[in] nodeAddr
O endereço IP do nó que responde.
[in] msg
Uma referência à mensagem IdentityResponse recebida.

Atributos públicos

AppState

void * AppState

Objeto de estado definido pelo aplicativo.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOMENTE LEITURA] Objeto do gerenciador de troca

FabricState

const WeaveFabricState * FabricState

[SOMENTE LEITURA] Objeto de estado do Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Funções públicas

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Cancele uma troca IdentityRequest em andamento aguardando uma resposta.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
incondicionalmente.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializar o estado do cliente de descrição do dispositivo.

param[in] ExchangeMgr Um ponteiro para o gerenciador do Weave Exchange.

Detalhes
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Quando um servidor de encontro passivo remoto já tiver sido registrado.
WEAVE_NO_ERROR
Se der certo.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

enviar uma mensagem IdentityRequest para um endereço IP específico.

Detalhes
Parâmetros
[in] nodeAddr
Uma referência ao endereço IP do nó do Weave a ser consultado.
[in] msg
Uma referência à mensagem SubscribeRequest a ser enviada.
Valores de retorno
WEAVE_ERROR_NO_MEMORY
Se a alocação do contexto de troca do buffer de pacote falhar.
WEAVE_NO_ERROR
Se der certo.
other
Outros códigos do Weave ou específicos da plataforma que indicam a ocorrência de um erro que impede o envio do PinpointRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Envia uma mensagem de transmissão IdentityRequest para descobrir nós do Weave.

Detalhes
Parâmetros
[in] msg
Uma referência à mensagem SubscribeRequest a ser enviada.

Desligamento

WEAVE_ERROR Shutdown(
  void
)

Encerre o cliente de descrição do dispositivo.

Essa função fecha qualquer contexto de troca ativa e redefine ponteiros. Chame o método Init novamente para reutilizar o objeto.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
incondicionalmente.