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

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

Es el objeto de cliente para emitir solicitudes de descripción de dispositivos.

Resumen

Constructores y destructores
DeviceDescriptionClient(void)

Tipos públicos
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Esta función se encarga de procesar los mensajes de IdentityResponse.

Atributos públicos
AppState
void *
Objeto de estado definido por la aplicación.
ExchangeMgr
[SOLO LECTURA] Objeto de administrador de Exchange
FabricState
[SOLO LECTURA] Objeto de estado de Fabric
OnIdentifyResponseReceived

Funciones públicas
CancelExchange(void)
Cancela un intercambio de IdentityRequest en curso a la espera de una respuesta.
Init(WeaveExchangeManager *exchangeMgr)
Inicializa el estado del cliente de la descripción del dispositivo.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Envía un mensaje de IdentityRequest a una dirección IP específica.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Envía un mensaje de IdentityRequest de transmisión para descubrir nodos de Weave.
Shutdown(void)
Apaga el cliente de descripción del dispositivo.

Tipos públicos

HandleIdentifyResponseFunct

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

Esta función se encarga de procesar los mensajes de IdentityResponse.

Detalles
Parámetros
[in] appState
Un puntero al conjunto de estados definido por la aplicación cuando se crea el contexto de intercambio de IdentityRequest.
[in] nodeId
El ID del nodo de Weave de la fuente del mensaje.
[in] nodeAddr
La dirección IP del nodo de respuesta.
[in] msg
Una referencia al mensaje IdentityResponse entrante.

Atributos públicos

AppState

void * AppState

Objeto de estado definido por la aplicación.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LECTURA] Objeto de administrador de Exchange

FabricState

const WeaveFabricState * FabricState

[SOLO LECTURA] Objeto de estado de Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Funciones públicas

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Cancela un intercambio de IdentityRequest en curso a la espera de una respuesta.

Detalles
Valores de retorno
WEAVE_NO_ERROR
de forma incondicional.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializa el estado del cliente de la descripción del dispositivo.

param[in] intercambioMgr Un puntero al administrador de intercambio de Weave.

Detalles
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Cuando ya se registró un servidor de encuentro pasivo remoto.
WEAVE_NO_ERROR
Si tiene éxito.

SendIdentifyRequest

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

Envía un mensaje de IdentityRequest a una dirección IP específica.

Detalles
Parámetros
[in] nodeAddr
Una referencia a la dirección IP del nodo de Weave para consultar.
[in] msg
Una referencia al mensaje de IdentityRequest que se enviará.
Valores de retorno
WEAVE_ERROR_NO_MEMORY
Si falla la asignación del contexto de intercambio del búfer de paquetes.
WEAVE_NO_ERROR
Si tiene éxito.
other
Otros códigos de error específicos de la plataforma o de Weave que indican que se produjo un error que impidió el envío de IdentityRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Envía un mensaje de IdentityRequest de transmisión para descubrir nodos de Weave.

Detalles
Parámetros
[in] msg
Una referencia al mensaje de IdentityRequest que se enviará.

Cierre

WEAVE_ERROR Shutdown(
  void
)

Apaga el cliente de descripción del dispositivo.

Esta función cierra cualquier contexto de intercambio activo y restablece los punteros. El objeto se puede volver a usar llamando al método Init nuevamente.

Detalles
Valores de retorno
WEAVE_NO_ERROR
de forma incondicional.