nl::Weave::Profiles::DataManagement_Current::CustomCommand::Parser

#include <src/lib/profiles/data-management/Current/MessageDef.h>

Definicja parsera żądań niestandardowych polecenia WDM.

Podsumowanie

Dziedziczenie

Dziedziczy z: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Funkcje publiczne
CheckSchemaValidity(void) const
Sprawdź, czy komunikat ma prawidłowy format.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Pobierz zaplanowany czas działania dla tego polecenia.
GetCommandType(uint64_t *const apCommandType) const
Uzyskaj identyfikator typu polecenia dla tego polecenia.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Uzyskaj czas wygaśnięcia tego polecenia.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Uzyskaj czas zainicjowania tego polecenia.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Pobierz wersję obowiązkową tego polecenia.
GetPath(Path::Parser *const apPath) const
Zainicjuj element Path::Parser za pomocą komponentu ścieżki w tym poleceniu.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Zainicjuj obiekt TLVReader, aby wskazywał początek komponentu argumentu w tym poleceniu.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Zainicjuj czytnik TLVReader, aby wskazywał początek komponentu ścieżki w tym poleceniu.
Init(const nl::Weave::TLV::TLVReader & aReader)
Zainicjuj obiekt parsera za pomocą narzędzia TLVReader.

Funkcje publiczne

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Sprawdź, czy komunikat ma prawidłowy format.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Pobierz zaplanowany czas działania dla tego polecenia.

Szczegóły
Parametry
[out] apActionTimeMicroSecond
Wskaźnik do zmiennej otrzymującej czas działania Command w przypadku powodzenia
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to liczba całkowita ze znakiem

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Uzyskaj identyfikator typu polecenia dla tego polecenia.

Szczegóły
Parametry
[out] apCommandType
Wskaźnik do zmiennej otrzymującej identyfikator typu polecenia w przypadku powodzenia
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to nieoznaczona liczba całkowita

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Uzyskaj czas wygaśnięcia tego polecenia.

Szczegóły
Parametry
[out] apExpiryTimeMicroSecond
Wskaźnik do zmiennej, która umożliwia otrzymanie czasu wygaśnięcia po pomyślnym zakończeniu
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to liczba całkowita ze znakiem

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Uzyskaj czas zainicjowania tego polecenia.

Szczegóły
Parametry
[out] apInitiationTimeMicroSecond
Wskaźnik do zmiennej, która powoduje otrzymanie czasu inicjowania Command w przypadku powodzenia
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to liczba całkowita ze znakiem

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Pobierz wersję obowiązkową tego polecenia.

Szczegóły
Parametry
[out] apMustBeVersion
Wskaźnik do zmiennej pozwalającej uzyskać obowiązkową wersję w przypadku sukcesu
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to nieoznaczona liczba całkowita

GetPath

WEAVE_ERROR GetPath(
  Path::Parser *const apPath
) const

Zainicjuj element Path::Parser za pomocą komponentu ścieżki w tym poleceniu.

Szczegóły
Parametry
[out] apPath
wskaźnik do Path::Parser, która po pomyślnym zakończeniu zostanie zainicjowana z umieszczonym komponentem ścieżki;
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu
WEAVE_END_OF_TLV
, jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli istnieje taki element, ale nie jest to ścieżka

GetReaderOnArgument

WEAVE_ERROR GetReaderOnArgument(
  nl::Weave::TLV::TLVReader *const apReader
) const

Zainicjuj obiekt TLVReader, aby wskazywał początek komponentu argumentu w tym poleceniu.

Szczegóły
Parametry
[out] apReader
wskaźnik do TLVReader, który zostanie zainicjowany w elemencie TLV w przypadku powodzenia;
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu

GetReaderOnPath

WEAVE_ERROR GetReaderOnPath(
  nl::Weave::TLV::TLVReader *const apReader
) const

Zainicjuj czytnik TLVReader, aby wskazywał początek komponentu ścieżki w tym poleceniu.

Szczegóły
Parametry
[out] apReader
wskaźnik do TLVReader, który zostanie zainicjowany w elemencie TLV w przypadku powodzenia;
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu

Zainicjuj

WEAVE_ERROR Init(
  const nl::Weave::TLV::TLVReader & aReader
)

Zainicjuj obiekt parsera za pomocą narzędzia TLVReader.

Szczegóły
Parametry
[in] aReader
Wskaźnik do TLVReader, który powinien wskazywać początek tego żądania
Zwracane wartości
WEAVE_NO_ERROR
po pomyślnym zakończeniu