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)
send Accept メッセージのデフォルトを含む引数のないコンストラクタ。

パブリック属性
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)
「non-wide」を初期化受信フレーム（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
)

send Accept メッセージのデフォルトを含む引数のないコンストラクタ。

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
)

「non-wide」を初期化受信フレーム（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
バッファが小さすぎる場合