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

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

Definicja parsera żądań WDM.

Podsumowanie

Dziedziczenie

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

Funkcje publiczne
CheckSchemaValidity(void) const
Sprawdź, czy wiadomość jest prawidłowo sformatowana.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Uzyskaj zaplanowany czas wykonania tej czynności.
GetCommandType(uint64_t *const apCommandType) const
Uzyskaj identyfikator typu tego polecenia.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Uzyskaj czas wygaśnięcia tego polecenia.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Pobierz czas rozpoczęcia tego polecenia.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Uzyskaj wersję wymaganą do wykonania tego polecenia.
GetPath(Path::Parser *const apPath) const
Zainicjuj w tym poleceniu wyrażenie Path::Parser za pomocą komponentu ścieżki.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Zainicjuj komponent TLVReader, aby wskazywał początek komponentu argumentu w tym poleceniu.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Inicjalizacja TLVReader, aby wskazywała początek komponentu ścieżki w tym poleceniu.
Init(const nl::Weave::TLV::TLVReader & aReader)
Zainicjuj obiekt parsera za pomocą programu TLVReader.

Funkcje publiczne

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Sprawdź, czy wiadomość ma poprawny format.

Szczegóły
Zwracane wartości
WEAVE_NO_ERROR
w przypadku powodzenia

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Uzyskaj zaplanowany czas wykonania tej czynności.

Szczegóły
Parametry
[out] apActionTimeMicroSecond
Wskaźnik do zmiennej umożliwiającej otrzymanie czasu wykonywania działania Command
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
WEAVE_END_OF_TLV
jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli taki element istnieje, ale nie jest to liczba całkowita ze znakiem;

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Pobierz identyfikator typu polecenia.

Szczegóły
Parametry
[out] apCommandType
Wskaźnik do zmiennej, która po pomyślnym wykonaniu polecenia otrzyma identyfikator typu polecenia.
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
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 bez znaku

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Czas wygaśnięcia tego polecenia.

Szczegóły
Parametry
[out] apExpiryTimeMicroSecond
Wskaźnik do zmiennej, która otrzymuje czas wygaśnięcia po udanym działaniu
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
WEAVE_END_OF_TLV
jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli występuje taki element, ale nie jest to liczba całkowita ze znakiem

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Uzyskaj czas inicjowania tego polecenia.

Szczegóły
Parametry
[out] apInitiationTimeMicroSecond
Wskaźnik do zmiennej, która po udanym uruchomieniu polecenia przechowuje czas jego inicjowania.
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
WEAVE_END_OF_TLV
jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli taki element istnieje, ale nie jest to liczba całkowita ze znakiem;

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Uzyskaj wersję wymaganą dla tego polecenia.

Szczegóły
Parametry
[out] apMustBeVersion
Wskaźnik do zmiennej umożliwiającej otrzymanie wersji, która musi być w momencie sukcesu
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
WEAVE_END_OF_TLV
jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli taki element istnieje, ale nie jest liczbą całkowitą bez znaku;

GetPath

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

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

Szczegóły
Parametry
[out] apPath
Wskaźnik do obiektu Path::Parser, który zostanie zainicjowany za pomocą elementu ścieżki wbudowanej w przypadku powodzenia.
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu
WEAVE_END_OF_TLV
jeśli nie ma takiego elementu
WEAVE_ERROR_WRONG_TLV_TYPE
jeśli taki element istnieje, ale nie jest to ścieżka;

GetReaderOnArgument

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

Inicjalizacja TLVReader, aby wskazywała początek komponentu argumentu w tym poleceniu.

Szczegóły
Parametry
[out] apReader
Wskaźnik do TLVReader, który zostanie zainicjowany w elementie argumentu TLV w przypadku powodzenia.
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu

GetReaderOnPath

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

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

Szczegóły
Parametry
[out] apReader
Wskaźnik do TLVReader, który po zakończeniu zostanie zainicjowany z elementem TLV argumentu
Zwracane wartości
WEAVE_NO_ERROR
w przypadku sukcesu

Init

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

Zainicjuj obiekt parsera za pomocą programu TLVReader.

Szczegóły
Parametry
[in] aReader
Wskaźnik do TLVReader, który powinien wskazywać początek tego żądania
Zwracane wartości
WEAVE_NO_ERROR
w przypadku powodzenia