nl::Weave::Profiles::MessageIterator

#include <src/lib/profiles/common/WeaveMessage.h>

मैसेज बफ़र का सही तरीके से इस्तेमाल करने के लिए, हम फिर से इसकी सुविधा देने वाले इसको बनाते हैं. इसका इस्तेमाल सीमाओं वगैरह को ट्रैक करने के लिए किया जा सकता है.

खास जानकारी

इनहेरिटेंस

इनसे इनहेरिट किया जाता है: nl::Weave::Profiles::RetainedPacketBuffer

कंस्ट्रक्टर और डिस्ट्रक्टर

MessageIterator(System::PacketBuffer *)
कंस्ट्रक्टर वाला तरीका.

सार्वजनिक विशेषताएं

thePoint
uint8_t *

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

append(void)
void
बफ़र में मौजूद किसी भी मौजूदा डेटा के बाद का पॉइंट सेट करें.
finishWriting(void)
void
लिखने के बाद बफ़र को अडजस्ट करें.
hasData(uint16_t)
bool
hasRoom(uint16_t)
bool
operator!=(const MessageIterator &)
bool
operator*(void)
uint8_t &
operator+(uint16_t)
operator++(void)
अगर जगह मौजूद है, तो मैसेज इटरेटर को 1 तक बढ़ाएं.
operator-(uint16_t)
operator==(const MessageIterator &)
bool
read16(uint16_t *)
read32(uint32_t *)
read64(uint64_t *)
readByte(uint8_t *)
readBytes(uint16_t, uint8_t *)
readString(uint16_t, char *)
write16(uint16_t)
write32(uint32_t)
write64(uint64_t)
writeByte(uint8_t)
writeBytes(uint16_t, uint8_t *)
writeString(uint16_t, char *)

सार्वजनिक विशेषताएं

thePoint

uint8_t * thePoint

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

MessageIterator

 MessageIterator(
  System::PacketBuffer *
)

कंस्ट्रक्टर वाला तरीका.

ब्यौरा
पैरामीटर
aBuffer
फिर से दोहराने के लिए मैसेज बफ़र.

जोड़ें

void append(
  void
)

बफ़र में मौजूद किसी भी मौजूदा डेटा के बाद का पॉइंट सेट करें.

finishWriting

void finishWriting(
  void
)

लिखने के बाद बफ़र को अडजस्ट करें.

hasData

bool hasData(
  uint16_t
)

ब्यौरा
पैरामीटर
inc
वह पूर्णांक रकम जिसे बफ़र से पढ़ा जा सकता है.
रिटर्न वैल्यू
true
बफ़र की मौजूदा डेटा लंबाई, दी गई बढ़ोतरी से ज़्यादा या उसके बराबर है.
false
नहीं तो.

hasRoom

bool hasRoom(
  uint16_t
)

ब्यौरा
पैरामीटर
inc
वह पूर्णांक रकम जिसे बफ़र में लिखा जा सकता है.
रिटर्न वैल्यू
true
बफ़र के मौजूदा डेटा साइज़ और इसकी तय की गई ज़्यादा से ज़्यादा डेटा लंबाई (डेटा के लिए उपलब्ध लंबाई) के बीच का अंतर, दी गई बढ़ोतरी से कम या उसके बराबर है.
false
नहीं तो.

operator!=

bool operator!=(
  const MessageIterator &
)

ब्यौरा
पैरामीटर
aMessageIterator
तुलना करने के लिए एक और मैसेज इटरेटर.

ऑपरेटर*

uint8_t & operator*(
  void
)

ब्यौरा
लौटाए जाने वाले प्रॉडक्ट
हम बफ़र में क्या देख रहे हैं.

ऑपरेटर+

MessageIterator & operator+(
  uint16_t
)

ब्यौरा
पैरामीटर
inc
मैसेज इटरेटर पर लागू होने वाली बढ़ोतरी.
लौटाए जाने वाले प्रॉडक्ट
अगर जगह है, तो दी गई वैल्यू के हिसाब से, इटरेटर बढ़ जाता है. इसके अलावा, अगर जगह मौजूद नहीं है, तो यह वैल्यू आखिर में ऊपर की ओर आती है.

ऑपरेटर++

MessageIterator & operator++(
  void
)

अगर जगह मौजूद है, तो मैसेज इटरेटर को 1 तक बढ़ाएं.

operator-

MessageIterator & operator-(
  uint16_t
)

ब्यौरा
पैरामीटर
dec
मैसेज इटरेटर पर लागू होने वाली कमी.
लौटाए जाने वाले प्रॉडक्ट
अगर जगह है, तो दी गई वैल्यू से इटरेटर कम हो जाता है या अगर मौजूद नहीं है, तो यह शुरुआती लेवल से ठीक हो जाता है.

ऑपरेटर==

bool operator==(
  const MessageIterator &
)

ब्यौरा
पैरामीटर
aMessageIterator
तुलना करने के लिए एक और मैसेज इटरेटर.

read16

WEAVE_ERROR read16(
  uint16_t *
)

ब्यौरा
पैरामीटर
aDestination
बफ़र को कम शब्दों में पढ़ना.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

read32

WEAVE_ERROR read32(
  uint32_t *
)

ब्यौरा
पैरामीटर
aDestination
बफ़र में 32-बिट की वैल्यू रीड करने की जगह.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

read64

WEAVE_ERROR read64(
  uint64_t *
)

ब्यौरा
पैरामीटर
aDestination
बफ़र में 64-बिट की वैल्यू रीड करने की जगह.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

readByte

WEAVE_ERROR readByte(
  uint8_t *
)

ब्यौरा
पैरामीटर
aDestination
बफ़र को पढ़ने के लिए एक बाइट रखने की जगह.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

readBytes

WEAVE_ERROR readBytes(
  uint16_t,
  uint8_t *
)

ब्यौरा
पैरामीटर
aLength
पढ़ी जाने वाली बाइट स्ट्रिंग की लंबाई.
aByteString
बाइट रखने की जगह.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

readString

WEAVE_ERROR readString(
  uint16_t,
  char *
)

ब्यौरा
पैरामीटर
aLength
पढ़ी जाने वाली स्ट्रिंग की लंबाई.
aString
स्ट्रिंग डालने की जगह.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

write16

WEAVE_ERROR write16(
  uint16_t
)

ब्यौरा
पैरामीटर
aValue
लिखने के लिए एक छोटा मान.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

write32

WEAVE_ERROR write32(
  uint32_t
)

ब्यौरा
पैरामीटर
aValue
लिखने के लिए 32-बिट वैल्यू.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

write64

WEAVE_ERROR write64(
  uint64_t
)

ब्यौरा
पैरामीटर
aValue
लिखने के लिए 64-बिट वैल्यू.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

writeByte

WEAVE_ERROR writeByte(
  uint8_t
)

ब्यौरा
पैरामीटर
aValue
राइट आउट करने के लिए एक बाइट वैल्यू.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

writeBytes

WEAVE_ERROR writeBytes(
  uint16_t,
  uint8_t *
)

ब्यौरा
पैरामीटर
aLength
लिखने के लिए बाइट स्ट्रिंग की लंबाई.
aString
बाइट स्ट्रिंग.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.

writeString

WEAVE_ERROR writeString(
  uint16_t,
  char *
)

ब्यौरा
पैरामीटर
aLength
लिखने के लिए स्ट्रिंग की लंबाई.
aString
स्ट्रिंग ही.
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर सब ठीक है.
WEAVE_ERROR_BUFFER_TOO_SMALL
यदि हम बफ़र के अंत से बाहर चला रहे हैं.