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
إذا كان هناك عنصر من هذا النوع ولكنّه ليس عددًا صحيحًا signed

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
إذا كان هناك عنصر من هذا النوع ولكنّه ليس عددًا صحيحًا signed

GetInitiationTimeMicroSecond

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

الحصول على وقت بدء هذا الأمر

التفاصيل
المعلمات
[out] apInitiationTimeMicroSecond
مؤشر بعض المتغيرات لتلقي وقت بدء Command عند النجاح
قيم الإرجاع
WEAVE_NO_ERROR
حول النجاح
WEAVE_END_OF_TLV
إذا لم يكن هناك مثل هذا العنصر
WEAVE_ERROR_WRONG_TLV_TYPE
إذا كان هناك عنصر من هذا النوع ولكنّه ليس عددًا صحيحًا signed

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
عند النجاح