Google is committed to advancing racial equity for Black communities. See how.

nl :: Tecer:: Perfis :: DeviceDescription :: DeviceDescriptionServer

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

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

Resumo

Herança

Herda: nl :: Weave :: WeaveServerBase
Dirigir Subclasses conhecidas: nl :: Weave :: DeviceLayer :: Interno :: 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 retornos de chamada.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Esta função é responsável pelo processamento de mensagens IdentityRequest.

Funções públicas

Init ( WeaveExchangeManager *exchangeMgr)
Inicialize o estado do servidor de descrição do dispositivo e registre-se para receber mensagens de descrição do dispositivo.
Shutdown (void)
Desligue o servidor de descrição de 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 retornos de chamada.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

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

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

Funções públicas

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Iniciar

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

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

param [in] exchangeMgr Um ponteiro para o Weave Exchange Manager.

Detalhes
Valores Retornados
WEAVE_ERROR_INCORRECT_STATE
Quando um servidor de encontro passivo remoto já foi registrado.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Quando muitos manipuladores de mensagens não solicitadas são registrados.
WEAVE_NO_ERROR
Com sucesso.

Desligar

WEAVE_ERROR Shutdown(
  void
)

Desligue o servidor de descrição de dispositivo.

Detalhes
Valores Retornados
WEAVE_NO_ERROR
incondicionalmente.