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

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

WDM कस्टम Command अनुरोध पार्सर की परिभाषा.

खास जानकारी

इनहेरिटेंस

इनसे इनहेरिट करता है: 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 के साथ शुरू करें.

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

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
पाथ::पार्सर का पॉइंटर, जिसे सक्सेस होने पर एम्बेड किए गए पाथ कॉम्पोनेंट के साथ शुरू किया जाएगा
रिटर्न वैल्यू
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
सफल होने पर