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

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

Obiekt serwera odpowiadający na żądania opisu urządzenia.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::WeaveServerBase
Bezpośrednie znane podklasy: nl::Weave::DeviceLayer::Internal::DeviceDescriptionServer

Konstruktorzy i niszczyciele
DeviceDescriptionServer(void)

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

Atrybuty publiczne
AppState
void *
Wskaźnik stanu zdefiniowany przez aplikację zapewniający kontekst dla wywołań zwrotnych.
OnIdentifyRequestReceived
HandleIdentifyRequestFunct
Ta funkcja odpowiada za przetwarzanie wiadomości IdentityRequest.

Funkcje publiczne
Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan serwera opisu urządzenia i zarejestruj się, by otrzymywać komunikaty z opisem urządzenia.
Shutdown(void)
Wyłącz serwer opisu urządzenia.

Typy publiczne

HandleIdentifyRequestFunct

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

Atrybuty publiczne

AppState

void * AppState

Wskaźnik stanu zdefiniowany przez aplikację zapewniający kontekst dla wywołań zwrotnych.

OnIdentifyRequestReceived

HandleIdentifyRequestFunct OnIdentifyRequestReceived

Ta funkcja odpowiada za przetwarzanie wiadomości IdentityRequest.

Szczegóły
Parametry
[in] appState
Wskaźnik do stanu zdefiniowanego przez aplikację ustawiony podczas rejestracji w celu odbierania wiadomości tego typu.
[in] nodeId
Identyfikator węzła Weave źródła wiadomości.
[in] nodeAddr
Adres IP źródła wiadomości.
[in] reqMsg
Odwołanie do przychodzącego komunikatu IdentifieRequest.
[out] sendResp
Odwołanie do wartości logicznej, która powinna być ustawiona na wartość true, jeśli wiadomość z odpowiedzią ma zostać wysłana do inicjatora.
[out] respMsg
Odwołanie do wiadomości IdentityResponse, która ma być wysłana do inicjatora.

Funkcje publiczne

DeviceDescriptionServer

 DeviceDescriptionServer(
  void
)

Zainicjuj

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan serwera opisu urządzenia i zarejestruj się, by otrzymywać komunikaty z opisem urządzenia.

param[in] ExchangeMgr Wskaźnik menedżera Weave Exchange.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Gdy został już zarejestrowany zdalny pasywny serwer rendezvity.
WEAVE_ERROR_TOO_MANY_UNSOLICITED_MESSAGE_HANDLERS
Gdy zarejestrowanych jest zbyt wiele niechcianych modułów obsługi wiadomości.
WEAVE_NO_ERROR
Na sukces.

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz serwer opisu urządzenia.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.