nl:: बुना::प्रोफ़ाइल::DataManagement_current::कस्टम कमांड::पार्स करें

#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
इस निर्देश में, पाथ के कॉम्पोनेंट के साथ पाथ::पार्सर शुरू करें.
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 से पार्सर ऑब्जेक्ट शुरू करें.

सार्वजनिक फ़ंक्शन

जांच स्कीमा की वैधता

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
अगर ऐसा कोई एलिमेंट है, लेकिन यह बिना साइन वाला पूर्णांक है

समयसीमा खत्म होने के समय का माइक्रोसेकंड

WEAVE_ERROR GetExpiryTimeMicroSecond(
  int64_t *const apExpiryTimeMicroSecond
) const

इस निर्देश की समयसीमा खत्म होने का समय देखें.

ब्यौरा
पैरामीटर
[out] apExpiryTimeMicroSecond
खत्म होने का समय पाने के लिए, किसी वैरिएबल का पॉइंटर
सामान लौटाने की वैल्यू
WEAVE_NO_ERROR
सफल होने पर
WEAVE_END_OF_TLV
अगर ऐसा कोई एलिमेंट नहीं है
WEAVE_ERROR_WRONG_TLV_TYPE
अगर ऐसा कोई एलिमेंट है, लेकिन यह' साइन किया गया पूर्णांक नहीं है

InInitiationTimeMicrosecond पर जाएं

WEAVE_ERROR GetInitiationTimeMicroSecond(
  int64_t *const apInitiationTimeMicroSecond
) const

इस निर्देश के शुरू होने का समय पाएं.

ब्यौरा
पैरामीटर
[out] apInitiationTimeMicroSecond
सफल होने पर Command शुरू करने का समय पाने के लिए कुछ वैरिएबल का पॉइंटर
सामान लौटाने की वैल्यू
WEAVE_NO_ERROR
सफल होने पर
WEAVE_END_OF_TLV
अगर ऐसा कोई एलिमेंट नहीं है
WEAVE_ERROR_WRONG_TLV_TYPE
अगर ऐसा कोई एलिमेंट है, लेकिन यह' साइन किया गया पूर्णांक नहीं है

Get न्योतेBeVersion

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

इस निर्देश में, पाथ के कॉम्पोनेंट के साथ पाथ::पार्सर शुरू करें.

ब्यौरा
पैरामीटर
[out] apPath
पाथ::पार्सर का एक पॉइंटर, जिसे सफलता पर एम्बेड किए गए पाथ कॉम्पोनेंट के साथ शुरू किया जाएगा
सामान लौटाने की वैल्यू
WEAVE_NO_ERROR
सफल होने पर
WEAVE_END_OF_TLV
अगर ऐसा कोई एलिमेंट नहीं है
WEAVE_ERROR_WRONG_TLV_TYPE
अगर ऐसा कोई एलिमेंट है, लेकिन यह ##39 नहीं है, तो पाथ है

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
सफल होने पर