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

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

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

Podsumowanie

Konstruktorzy i niszczyciele
DeviceDescriptionClient(void)

Typy publiczne
HandleIdentifyResponseFunct)(void *appState, uint64_t nodeId, const IPAddress &nodeAddr, const IdentifyResponseMessage &msg) typedef
void(*
Ta funkcja odpowiada za przetwarzanie wiadomości IdentityResponse.

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

Funkcje publiczne
CancelExchange(void)
Anulowanie trwającej wymiany IdentifieRequest oczekiwania na odpowiedź.
Init(WeaveExchangeManager *exchangeMgr)
Zainicjuj stan klienta opisu urządzenia.
SendIdentifyRequest(const IPAddress & nodeAddr, const IdentifyRequestMessage & msg)
Wyślij komunikat IdentifieRequest na określony adres IP.
SendIdentifyRequest(const IdentifyRequestMessage & msg)
Wyślij komunikat IdentityRequest na potrzeby wykrywania węzłów Weave.
Shutdown(void)
Wyłącz klienta Device Description.

Typy publiczne

HandleIdentifyResponseFunct

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

Ta funkcja odpowiada za przetwarzanie wiadomości IdentityResponse.

Szczegóły
Parametry
[in] appState
Wskaźnik do stanu zdefiniowanego przez aplikację ustawiony podczas tworzenia kontekstu Exchange 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 IdentifieResponse.

Atrybuty publiczne

AppState

void * AppState

Obiekt stanu zdefiniowany 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
)

Anulowanie trwającej wymiany IdentifieRequest oczekiwania na odpowiedź.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.

DeviceDescriptionClient

 DeviceDescriptionClient(
  void
)

Zainicjuj

WEAVE_ERROR Init(
  WeaveExchangeManager *exchangeMgr
)

Zainicjuj stan klienta opisu 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_NO_ERROR
Na sukces.

SendIdentifyRequest

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

Wyślij komunikat 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 IdentityRequest do wysłania.
Zwracane wartości
WEAVE_ERROR_NO_MEMORY
Jeśli nie uda się przypisać kontekstu wymiany bufora pakietów.
WEAVE_NO_ERROR
Na sukces.
other
Inne kody błędów Weave lub specyficzne dla platformy wskazujące, że wystąpił błąd uniemożliwiający wysłanie identyfikatora IdentifieRequest.

SendIdentifyRequest

WEAVE_ERROR SendIdentifyRequest(
  const IdentifyRequestMessage & msg
)

Wyślij komunikat IdentityRequest na potrzeby wykrywania węzłów Weave.

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

Wyłączono

WEAVE_ERROR Shutdown(
  void
)

Wyłącz klienta Device Description.

Ta funkcja zamyka kontekst aktywnego giełdy i resetuje wskaźniki. Obiektu można użyć ponownie, wywołując metodę Init.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
bezwarunkowo.