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
درصورت موفقیت

GetActionTimeMicroSecond

WEAVE_ERROR GetActionTimeMicroSecond(
  int64_t *const apActionTimeMicroSecond
) const

زمان کنش زمان‌بندی‌شده را برای این فرمان دریافت کنید.

جزئیات
پارامترها
[out] apActionTimeMicroSecond
اشاره‌گری به متغیری برای دریافت زمان کنش فرمان درصورت موفقیت
مقادیر برگشتی
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
درصورت موفقیت

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
درصورت موفقیت