nl::Weave::Profiles::DeviceDescription::DeviceDescriptionServer

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

Objeto de servidor para responder a solicitudes de descripción de dispositivos.

Resumen

Herencia

Hereda de: nl::Weave::WeaveServerBase
Subclases conocidas directas: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Constructores y destructores
DeviceDescriptionServer(void)

Tipos públicos
HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg) typedef
void(*

Atributos públicos
AppState
void *
Puntero de estado definido de la aplicación para proporcionar contexto para las devoluciones de llamada.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Esta función se encarga de procesar los mensajes de IdentityRequest.

Funciones públicas
Init(WeaveExchangeManager *exchangeMgr)
Inicializa el estado del servidor de descripción del dispositivo y regístrate para recibir mensajes de descripción del dispositivo.
Shutdown(void)
Apaga el servidor de descripción del dispositivo.

Tipos públicos

HandleIdentifyRequestFunct

void(* HandleIdentifyRequestFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyRequestMessage &reqMsg, bool &sendResp, IdentifyResponseMessage &respMsg)

Atributos públicos

AppState

void * AppState

Puntero de estado definido de la aplicación para proporcionar contexto para las devoluciones de llamada.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

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

Detalles
Parámetros
[in] appState
Un puntero para el conjunto de estado definido de la aplicación cuando se registra para recibir mensajes de este tipo.
[in] nodeId
ID de nodo de Weave de la fuente del mensaje.
[in] nodeAddr
La dirección IP del origen del mensaje.
[in] reqMsg
Una referencia al mensaje entrante de IdentificaRequest.
[out] sendResp
Referencia a un valor booleano que se debe establecer como verdadero si se debe enviar un mensaje de respuesta al iniciador.
[out] respMsg
Es una referencia al mensaje de IdentityResponse que se enviará al iniciador.

Funciones públicas

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializa el estado del servidor de descripción del dispositivo y regístrate para recibir mensajes de descripción del dispositivo.

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_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Cuando se registran demasiados controladores de mensajes no solicitados.
WEAVE_NO_ERROR
Si la operación es exitosa.

Cierre

WEAVE_ERROR Shutdown(
  void
)

Apaga el servidor de descripción del dispositivo.

Detalles
Valores que se muestran
WEAVE_NO_ERROR
incondicionalmente.