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
反復処理するメッセージ バッファ。

append

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
バッファの最後を過ぎている場合