nl::Weave::Profiles::BDX_Development::BlockSend

#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>

BlockSend メッセージは、データブロックを送信側から受信側に転送するために使用されます。

概要

継承

継承元: nl::Weave::Profiles::RetainedPacketBuffer
直接的な既知のサブクラス: nl::Weave::Profiles::BDX_Development::BlockEOF

コンストラクタとデストラクタ

BlockSend(void)
ブロック送信メッセージのデフォルトを持つ引数なしのコンストラクタ。

パブリック属性

mBlockCounter
uint8_t
送信されるこのブロックのカウンタ
mData
uint8_t *
受信または転送するデータへのポインタ。
mLength
uint64_t
このブロックに含まれるデータの長さ。

パブリック関数

init(uint8_t aCounter, uint64_t aLength, uint8_t *aData)
BlockSend メッセージを初期化します。
operator==(const BlockSend &) const
bool
BlockSend メッセージの等価比較。
packedLength(void)
uint16_t
このブロック送信メッセージのパック長を返します。

静的パブリック関数

parse(PacketBuffer *aBuffer, BlockSend & aResponse)
PacketBuffer のデータを BlockSend メッセージ形式に解析します。

パブリック属性

mBlockCounter

uint8_t mBlockCounter

送信されるこのブロックのカウンタ

mData

uint8_t * mData

受信または転送するデータへのポインタ。

mLength

uint64_t mLength

このブロックに含まれるデータの長さ。

パブリック関数

BlockSend

 BlockSend(
  void
)

ブロック送信メッセージのデフォルトを持つ引数なしのコンストラクタ。

init

WEAVE_ERROR init(
  uint8_t aCounter,
  uint64_t aLength,
  uint8_t *aData
)

BlockSend メッセージを初期化します。

詳細
パラメータ
[in] aCounter
このブロックのブロック カウンタ値
[in] aLength
ブロックの長さ
[in] aData
転送されるデータへのポインタ
戻り値
WEAVE_NO_ERROR(成功した場合)

演算子==

bool operator==(
  const BlockSend &
) const 

BlockSend メッセージの等価比較。

詳細
パラメータ
[in] another
このメッセージと比較する別の BlockSend メッセージ
戻り値
true になります。

packedLength

uint16_t packedLength(
  void
)

このブロック送信メッセージのパック長を返します。

詳細
戻り値
パックされたときのメッセージの長さ

静的パブリック関数

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  BlockSend & aResponse
)

PacketBuffer のデータを BlockSend メッセージ形式に解析します。

詳細
パラメータ
[in] aBuffer
解析するデータを含む PacketBuffer へのポインタ
[out] aResponse
結果を保存する BlockSend オブジェクトへのポインタ
戻り値
WEAVE_NO_ERROR
成功した場合
WEAVE_ERROR_BUFFER_TOO_SMALL
バッファが小さすぎる場合