En Google, luchamos por la equidad racial de la comunidad negra. Más información

nl :: Tejido:: Perfiles: Descripción del aparato:: Dispositivo Descripción Cliente

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

Objeto de cliente para emitir solicitudes de descripción de dispositivo.

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 es responsable de procesar los mensajes IdentityResponse.

Atributos públicos

AppState
void *
Objeto de estado definido por la aplicación.
ExchangeMgr
[SOLO LEER] Objeto de administrador de Exchange
FabricState
[SOLO LEER] Objeto de estado de la tela
OnIdentifyResponseReceived

Funciones publicas

CancelExchange (void)
Cancelar un intercambio IdentifyRequest en curso en espera de una respuesta.
Init ( WeaveExchangeManager *exchangeMgr)
Inicialice el estado del cliente Descripción del dispositivo.
SendIdentifyRequest (const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Envíe un mensaje IdentifyRequest a una dirección IP en particular.
SendIdentifyRequest (const IdentifyRequestMessage & msg)
Envíe un mensaje IdentifyRequest de difusión para descubrir los nodos de Weave.
Shutdown (void)
Apague 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 es responsable de procesar los mensajes IdentityResponse.

Detalles
Parámetros
[in] appState
Un puntero al estado definido por la aplicación establecido al crear el contexto de intercambio IdentityRequest.
[in] nodeId
El ID de nodo de Weave de la fuente del mensaje.
[in] nodeAddr
La dirección IP del nodo que responde.
[in] msg
Una referencia al mensaje IdentifyResponse entrante.

Atributos públicos

AppState

void * AppState

Objeto de estado definido por la aplicación.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[SOLO LEER] Objeto de administrador de Exchange

Estado de la tela

const WeaveFabricState * FabricState

[SOLO LEER] Objeto de estado de la tela

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Funciones publicas

CancelarCambio

WEAVE_ERROR CancelExchange(
  void
)

Cancelar un intercambio IdentifyRequest en curso en espera de una respuesta.

Detalles
Valores devueltos
WEAVE_NO_ERROR
incondicionalmente.

Dispositivo Descripción Cliente

 DeviceDescriptionClient(
  void
)

En eso

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicialice el estado del cliente Descripción del dispositivo.

param [in] exchangeMgr Un puntero al Weave Exchange Manager.

Detalles
Valores devueltos
WEAVE_ERROR_INCORRECT_STATE
Cuando ya se ha registrado un servidor de encuentro pasivo remoto.
WEAVE_NO_ERROR
Sobre el éxito.

SendIdentifyRequest

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

Envíe un mensaje IdentifyRequest a una dirección IP en particular.

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

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Envíe un mensaje IdentifyRequest de difusión para descubrir los nodos de Weave.

Detalles
Parámetros
[in] msg
Una referencia al mensaje IdentifyRequest para enviar.

Cerrar

WEAVE_ERROR Shutdown(
  void
)

Apague el cliente de descripción del dispositivo.

Esta función cierra cualquier contexto de intercambio activo y restablece los punteros. El objeto puede ser reutilizada mediante una llamada al Init método de nuevo.

Detalles
Valores devueltos
WEAVE_NO_ERROR
incondicionalmente.