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

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

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 de la aplicación.
ExchangeMgr
[SOLO LECTURA] Objeto del administrador de Exchange
FabricState
[SOLO LECTURA] Objeto de estado de Fabric
OnIdentifyResponseReceived

Funciones públicas
CancelExchange(void)
Cancelar un intercambio de IdentityRequest en curso a la espera de una respuesta.
Init(WeaveExchangeManager *exchangeMgr)
Inicializa el estado del cliente de descripción de dispositivos.
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 IdentificaciónRequest 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 para el conjunto de estado definido de la aplicación cuando se crea el contexto de intercambio de IdentityRequest.
[in] nodeId
ID de nodo de Weave de la fuente del mensaje.
[in] nodeAddr
La dirección IP del nodo de respuesta.
[in] msg
Es una referencia al mensaje entrante de IdentityResponse.

Atributos públicos

AppState

void * AppState

Objeto de estado definido de la aplicación.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LECTURA] Objeto del 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
)

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

Detalles
Valores que se muestran
WEAVE_NO_ERROR
incondicionalmente.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializa el estado del cliente de descripción de dispositivos.

param[in] exchangeMgr Es un puntero al administrador de Weave Exchange.

Detalles
Valores que se muestran
WEAVE_ERROR_INCORRECT_STATE
Cuando ya se haya registrado un servidor de reunión pasivo remoto.
WEAVE_NO_ERROR
Si la operación es exitosa.

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
Es una referencia a la dirección IP del nodo de Weave para consultar.
[in] msg
Es una referencia al mensaje de IdentityRequest que se debe enviar.
Valores que se muestran
WEAVE_ERROR_NO_MEMORY
Si falla la asignación del contexto de intercambio del búfer de paquetes.
WEAVE_NO_ERROR
Si la operación es exitosa.
other
Otros códigos de error específicos de la plataforma o de Weave que indiquen que se produjo un error que impedía el envío de IdentityRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

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

Detalles
Parámetros
[in] msg
Es una referencia al mensaje de IdentityRequest que se debe 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 de nuevo.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
incondicionalmente.