nl::Weave::Profiles::BDX_Development::ReceiveAccept

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

ReceiveAccept メッセージは、受信者がイニシエータである場合に、提案された交換を承諾するために使用されます。

概要

継承

継承元: nl::Weave::Profiles::BDX_Development::SendAccept

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

パブリック属性
mDefiniteLength
bool
一定の長さが選択された場合は true。
mLength
uint64_t
決定した送金期間。
mMetaData
オプションの TLV メタデータ。
mWideRange
bool
範囲フィールドとオフセット フィールドが 64 ビットの場合は true。

パブリック関数
init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint64_t aLength, ReferencedTLVData *aMetaData)
「wide」の受信承認フレームを初期化します。
init(uint8_t aVersion, uint8_t aTransferMode, uint16_t aMaxBlockSize, uint32_t aLength, ReferencedTLVData *aMetaData)
「非ワイド」受信フレーム（32 ビット長）を初期化します。
operator==(const ReceiveAccept &) const
bool
ReceiveAccept メッセージの等価比較。
pack(PacketBuffer *aBuffer)
受信承認メッセージを PacketBuffer にパックします。
packedLength(void)
uint16_t
この受信承認メッセージのパック長を返します。

静的パブリック関数
parse(PacketBuffer *aBuffer, ReceiveAccept & aResponse)
PacketBuffer のデータを ReceiveAccept メッセージ形式に解析します。

パブリック属性

mDefiniteLength

bool mDefiniteLength

一定の長さが選択された場合は true。

mLength

uint64_t mLength

決定した送金期間。

mMetaData

ReferencedTLVData mMetaData

オプションの TLV メタデータ。

mWideRange

bool mWideRange

範囲フィールドとオフセット フィールドが 64 ビットの場合は true。

パブリック関数

ReceiveAccept

 ReceiveAccept(
  void
)

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

init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint64_t aLength,
  ReferencedTLVData *aMetaData
)

「wide」の受信承認フレームを初期化します。

詳細
パラメータ
[in] aVersion
使用している BDX のバージョン
[in] aTransferMode
転送で使用する転送モード
[in] aMaxBlockSize
この転送で許容される最大ブロックサイズ
[in] aLength
転送されるファイルの長さ（不確定の場合は 0）
[in] aMetaData
（省略可）TLV メタデータ
戻り値
WEAVE_NO_ERROR（成功した場合）

init

WEAVE_ERROR init(
  uint8_t aVersion,
  uint8_t aTransferMode,
  uint16_t aMaxBlockSize,
  uint32_t aLength,
  ReferencedTLVData *aMetaData
)

「非ワイド」受信フレーム（32 ビット長）を初期化します。

詳細
パラメータ
[in] aVersion
使用している BDX のバージョン
[in] aTransferMode
転送で使用する転送モード
[in] aMaxBlockSize
この転送で許容される最大ブロックサイズ
[in] aLength
転送されるファイルの長さ（不確定の場合は 0）
[in] aMetaData
（省略可）TLV メタデータ
戻り値
WEAVE_NO_ERROR（成功した場合）

演算子==

bool operator==(
  const ReceiveAccept &
) const

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

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

パック

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

受信承認メッセージを PacketBuffer にパックします。

詳細
パラメータ
[out] aBuffer
ReceiveAccept メッセージをパッキングするための PacketBuffer
戻り値
WEAVE_NO_ERROR
成功した場合
WEAVE_ERROR_BUFFER_TOO_SMALL
バッファが小さすぎる場合

packedLength

uint16_t packedLength(
  void
)

この受信承認メッセージのパック長を返します。

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

静的パブリック関数

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  ReceiveAccept & aResponse
)

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

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