nl::Weave::Profiles::DeviceDescription::DeviceDescriptionClient

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

Obiekt klienta wysyłający żądania opisu urządzenia.

Podsumowanie

Konstruktory i niszczyciele
DeviceDescriptionClient(void)

Typy publiczne
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Ta funkcja jest odpowiedzialna za przetwarzanie komunikatów IdentityResponse.

Atrybuty publiczne
AppState
void *
Obiekt stanu zdefiniowanego przez aplikację.
ExchangeMgr
[TYLKO DO ODCZYTU] Obiekt menedżera Exchange
FabricState
[TYLKO DO ODCZYTU] Obiekt stanu Fabric
OnIdentifyResponseReceived

Funkcje publiczne
CancelExchange(void)
Anuluj trwającą wymianę IdentifieRequest w oczekiwaniu na odpowiedź.
Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan klienta opisu urządzenia.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Wyślij wiadomość IdentifieRequest na określony adres IP.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Aby wykryć węzły Weave, wyślij komunikat IdentityRequest.
Shutdown(void)
Wyłącz klienta opisu urządzenia.

Typy publiczne

HandleIdentifyResponseFunct

void(* HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg)

Ta funkcja jest odpowiedzialna za przetwarzanie komunikatów IdentityResponse.

Szczegóły
Parametry
[in] appState
Wskaźnik do stanu zdefiniowanego przez aplikację ustawionego podczas tworzenia kontekstu ExchangeRequest IdentityRequest.
[in] nodeId
Identyfikator węzła Weave źródła wiadomości.
[in] nodeAddr
Adres IP węzła odpowiadającego.
[in] msg
Odwołanie do przychodzącego komunikatu Identyfikacji.

Atrybuty publiczne

AppState

void * AppState

Obiekt stanu zdefiniowanego przez aplikację.

ExchangeMgr

WeaveExchangeManager * ExchangeMgr

[TYLKO DO ODCZYTU] Obiekt menedżera Exchange

FabricState

const WeaveFabricState * FabricState

[TYLKO DO ODCZYTU] Obiekt stanu Fabric

OnIdentifyResponseReceived

HandleIdentifyResponseFunct OnIdentifyResponseReceived

Funkcje publiczne

CancelExchange

WEAVE_ERROR CancelExchange(
  void
)

Anuluj trwającą wymianę IdentifieRequest w oczekiwaniu na odpowiedź.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Init

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan klienta opisu urządzenia.

param[in] ExchangeMgr A wskaźnik do menedżera Weave Exchange.

Szczegóły
Zwracane wartości
WEAVE_ERROR_INCORRECT_STATE
Gdy zdalny pasywny serwer rendezvous został już zarejestrowany.
WEAVE_NO_ERROR
Powodzenie.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IPAddress & nodeAddr,
  const IdentifyRequestMessage & msg
)

Wyślij wiadomość IdentifieRequest na określony adres IP.

Szczegóły
Parametry
[in] nodeAddr
Odwołanie do adresu IP węzła Weave, którego ma dotyczyć zapytanie.
[in] msg
Odwołanie do wiadomości IdentifieRequest do wysłania.
Zwracane wartości
WEAVE_ERROR_NO_MEMORY
Jeśli nie uda się przydzielić kontekstu wymiany bufora pakietów.
WEAVE_NO_ERROR
Powodzenie.
other
Inne kody błędów Weave lub dotyczące platformy, które wskazują, że wystąpił błąd, który uniemożliwia wysłanie żądania IdentifieRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Aby wykryć węzły Weave, wyślij komunikat IdentityRequest.

Szczegóły
Parametry
[in] msg
Odwołanie do wiadomości IdentifieRequest do wysłania.

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz klienta opisu urządzenia.

Ta funkcja zamyka wszystkie aktywne konteksty wymiany i resetuje wskaźniki. Obiektu można użyć ponownie, ponownie wywołując metodę Init.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.