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

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

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

Resumen

Herencia

Se 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 por la aplicación a fin de 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 de dispositivos.

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 por la aplicación a fin de 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 al conjunto de estados definido por la aplicación cuando se registra para recibir mensajes de este tipo.
[in] nodeId
El ID del nodo de Weave del origen del mensaje.
[in] nodeAddr
La dirección IP del origen del mensaje.
[in] reqMsg
Una referencia al mensaje IdentityRequest entrante.
[out] sendResp
Una referencia a un valor booleano que se debe configurar como verdadero si se debe enviar un mensaje de respuesta al iniciador.
[out] respMsg
Una referencia al mensaje 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] 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_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Cuando se registran demasiados controladores de mensajes no solicitados.
WEAVE_NO_ERROR
Si tiene éxito.

Cierre

WEAVE_ERROR Shutdown(
  void
)

Apaga el servidor de descripción de dispositivos.

Detalles
Valores de retorno
WEAVE_NO_ERROR
de forma incondicional.