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

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

طلب تعريف المحلِّل اللغوي لطلب Command المخصَّص لـ 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
مؤشر يشير إلى متغيّر لتلقّي وقت إجراء 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
مؤشر إلى متغيّر لتلقّي وقت بدء Command عند النجاح
قيم الإرجاع
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
عند النجاح

إنت

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

تهيئة كائن المحلل باستخدام TLVReader.

التفاصيل
المَعلمات
[in] aReader
مؤشر إلى TLVReader، والذي يجب أن يشير إلى بداية هذا الطلب
قيم الإرجاع
WEAVE_NO_ERROR
عند النجاح