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

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

Определение синтаксического анализатора запросов для специальной команды WDM.

Сводка

Наследование

Наследует от: nl::Weave::Profiles::DataManagement_Current::DataElement::Parser

Общественные функции
CheckSchemaValidity(void) const
Проверьте, правильно ли сформировано сообщение.
GetActionTimeMicroSecond(int64_t *const apActionTimeMicroSecond) const
Получить время запланированного действия для этой команды.
GetCommandType(uint64_t *const apCommandType) const
Получить идентификатор типа команды для этой команды.
GetExpiryTimeMicroSecond(int64_t *const apExpiryTimeMicroSecond) const
Получить срок действия этой команды.
GetInitiationTimeMicroSecond(int64_t *const apInitiationTimeMicroSecond) const
Получить время запуска этой команды.
GetMustBeVersion(uint64_t *const apMustBeVersion) const
Получить версию, которая должна быть у этой команды.
GetPath(Path::Parser *const apPath) const
Инициализируйте Path::Parser с компонентом пути в этой команде.
GetReaderOnArgument(nl::Weave::TLV::TLVReader *const apReader) const
Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.
GetReaderOnPath(nl::Weave::TLV::TLVReader *const apReader) const
Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.
Init(const nl::Weave::TLV::TLVReader & aReader)
Инициализируйте объект синтаксического анализатора с помощью TLVReader.

Общественные функции

CheckSchemaValidity

WEAVE_ERROR CheckSchemaValidity(
  void
) const

Примерно проверьте, правильно ли сформировано письмо.

Сведения
Возвращаемые значения
WEAVE_NO_ERROR
on success

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

Получить время запланированного действия для этой команды.

Сведения
Параметры
[out] apActionTimeMicroSecond
Указатель на переменную, в которую будет записано время действия Command при успешном выполнении.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является целым числом со знаком;

GetCommandType

WEAVE_ERROR GetCommandType(
  uint64_t *const apCommandType
) const

Получите идентификатор типа команды для этой команды.

Сведения
Параметры
[out] apCommandType
Указатель на переменную, которая в случае успеха получит идентификатор типа команды.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является целым числом без знака.

GetExpiryTimeMicroSecond

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

Получить срок действия этой команды.

Сведения
Параметры
[out] apExpiryTimeMicroSecond
Указатель на переменную, которая получит срок действия в случае успеха.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является целым числом со знаком;

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

Получить время запуска этой команды.

Сведения
Параметры
[out] apInitiationTimeMicroSecond
Указатель на переменную, в которую будет записано время инициализации команды при успешном выполнении.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является целым числом со знаком.

GetMustBeVersion

WEAVE_ERROR GetMustBeVersion(
  uint64_t *const apMustBeVersion
) const

Получить версию, которая должна быть у этой команды.

Сведения
Параметры
[out] apMustBeVersion
Указатель на переменную, которая должна получить версию в случае успеха.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является целым числом без знака.

GetPath

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

Инициализируйте Path::Parser с компонентом пути в этой команде.

Сведения
Параметры
[out] apPath
Указатель на Path::Parser, который будет инициализирован со встроенным компонентом пути в случае успеха.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении
WEAVE_END_OF_TLV
если такого элемента нет.
WEAVE_ERROR_WRONG_TLV_TYPE
если такой элемент есть, но он не является путем.

GetReaderOnArgument

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента аргумента в этой команде.

Сведения
Параметры
[out] apReader
Указатель на TLVReader, который будет инициализирован в элементе аргумента TLV в случае успеха.
Возвращаемые значения
WEAVE_NO_ERROR
on success

GetReaderOnPath

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

Инициализируйте TLVReader, чтобы он указывал на начало компонента пути в этой команде.

Сведения
Параметры
[out] apReader
Указатель на TLVReader, который будет инициализирован в элементе аргумента TLV при успешном выполнении.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении

Init

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

Инициализируйте объект парсера с помощью TLVReader.

Сведения
Параметры
[in] aReader
Указатель на TLVReader, который должен указывать на начало этого запроса.
Возвращаемые значения
WEAVE_NO_ERROR
при успешном выполнении