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

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

Objeto de servidor para responder a solicitações de descrição do dispositivo.

Resumo

Herança

Herda de: nl::Weave::WeaveServerBase
Subclasses conhecidas diretas: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Construtores e destruidores
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 *
Ponteiro de estado definido pelo aplicativo para fornecer contexto para callbacks.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Essa função é responsável pelo processamento de mensagens IdentityRequest.

Funções públicas
Init(WeaveExchangeManager *exchangeMgr)
Inicializar o estado do servidor de descrição do dispositivo e registrar-se para receber mensagens de descrição do dispositivo.
Shutdown(void)
Encerre o servidor de descrição do 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

Ponteiro de estado definido pelo aplicativo para fornecer contexto para callbacks.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Essa função é responsável pelo processamento de mensagens IdentityRequest.

Detalhes
Parâmetros
[in] appState
Um ponteiro para o estado definido do aplicativo definido durante o registro para receber mensagens desse tipo.
[in] nodeId
O ID do nó do Weave da origem da mensagem.
[in] nodeAddr
O endereço IP da origem da mensagem.
[in] reqMsg
Uma referência à mensagem IdentityRequest recebida.
[out] sendResp
Uma referência a um booleano que deve ser definido como verdadeiro caso uma mensagem de resposta precise ser enviada ao iniciador.
[out] respMsg
Uma referência à mensagem IdentityResponse a ser enviada ao iniciador.

Funções públicas

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Inicializar o estado do servidor de descrição do dispositivo e registrar-se para receber mensagens de descrição do dispositivo.

param[in] ExchangeMgr Um ponteiro para o Gerenciador do Weave Exchange.

Detalhes
Valores de retorno
WEAVE_ERROR_INCORRECT_STATE
Quando um servidor de reunião remoto e passivo já foi registrado.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Quando muitos gerenciadores de mensagens não solicitados são registrados.
WEAVE_NO_ERROR
Se a operação for bem-sucedida.

Encerramento

WEAVE_ERROR Shutdown(
  void
)

Encerre o servidor de descrição do dispositivo.

Detalhes
Valores de retorno
WEAVE_NO_ERROR
incondicionalmente.