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

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

ब्यौरा
पैरामीटर
[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
सफलता पर

शुरू करें

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

TLVReader पर, पार्सर ऑब्जेक्ट को शुरू करें.

ब्यौरा
पैरामीटर
[in] aReader
TLVReader पर पॉइंटर, जो इस अनुरोध की शुरुआत की ओर इशारा करना चाहिए
रिटर्न वैल्यू
WEAVE_NO_ERROR
सफलता पर