nl:: Weave:: Profiles:: BDX_Development:: SendInit
#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>
SendInit メッセージは、送信者がイニシエーターの場合に交換を開始するために使用されます。
まとめ
継承
直接的な既知のサブクラス: nl::Weave::Profiles::BDX_Development::ReceiveInit
コンストラクタとデストラクタ |
|
---|---|
SendInit(void)
|
パブリック タイプ |
|
---|---|
MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
|
typedef MetaDataTLVWriteCallback は、クライアントが任意のメタデータを SendInit に提供するための手段を提供します。 |
パブリック属性 |
|
---|---|
mAsynchronousModeSupported
|
bool
非同期モードをサポートできる場合は True。
|
mDefiniteLength
|
bool
長さフィールドが存在する場合は true です。
|
mFileDesignator
|
事前に交渉された情報を含む文字列。
|
mLength
|
uint64_t
転送中のデータ案の長さ。無期限の場合は 0。
|
mMaxBlockSize
|
uint16_t
転送に使用する最大ブロックサイズの候補。
|
mMetaData
|
オプションの TLV メタデータ。
|
mMetaDataAppState
|
void *
TLV メタデータのアプリの状態(省略可)。
|
mMetaDataWriteCallback
|
TLV メタデータを書き込むオプションの関数。
|
mReceiverDriveSupported
|
bool
レシーバー ドライブをサポートできる場合は true。
|
mSenderDriveSupported
|
bool
送信者のドライブをサポートできる場合は true。
|
mStartOffset
|
uint64_t
提案されているデータのオフセット。
|
mStartOffsetPresent
|
bool
開始オフセット フィールドが存在する場合は true になります。
|
mVersion
|
uint8_t
決定した BDX プロトコルのバージョンです。
|
mWideRange
|
bool
オフセットと長さが 64 ビットの場合は true。
|
パブリック関数 |
|
---|---|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
「ワイド」、SendInit を初期化します。
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
「ワイドでない」SendInit(32 ビット開始オフセット、32 ビット長)を初期化する
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
|
「ワイド」、SendInit を初期化します。
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState)
|
「ワイドでない」SendInit(32 ビット開始オフセット、32 ビット長)を初期化する
|
operator==(const SendInit &) const
|
bool
SendInit メッセージ間の等価性の比較。
|
pack(PacketBuffer *aBuffer)
|
init 送信メッセージを PacketBuffer にまとめます。
|
packedLength(void)
|
uint16_t
この送信 init メッセージのパックされた長さを返します。
|
静的パブリック関数 |
|
---|---|
parse(PacketBuffer *aBuffer, SendInit & aRequest)
|
PacketBuffer から SendInit メッセージ形式にデータを解析します。
|
パブリック タイプ
MetaDataTLVWriteCallback の使用
WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
MetaDataTLVWriteCallback は、クライアントが任意のメタデータを SendInit に提供するための手段を提供します。
クライアントは、適切な場合に、事前にエンコードされた TLV(高速)、その場でのエンコード(メモリ使用量の少ない)、遅延エンコード(起動時には高速)を使用できます。
いずれの場合も、コールバックによって生成されたデータは、指定された SendInit において一定である(つまり、呼び出された場合でも変化しない)と想定されます。これは、コールバックが、書き出された TLV の長さを計算する際にも使用されるためです。TLV はいつでもリクエストできます。
詳細 | |||||||||
---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||
戻り値 |
|
パブリック属性
mAasyncModeSupported
bool mAsynchronousModeSupported
非同期モードをサポートできる場合は True。
mDefiniteLength
bool mDefiniteLength
長さフィールドが存在する場合は true です。
長さ
uint64_t mLength
転送中のデータ案の長さ。無期限の場合は 0。
mMaxBlockSize
uint16_t mMaxBlockSize
転送に使用する最大ブロックサイズの候補。
mReceiverDriveSupported
bool mReceiverDriveSupported
レシーバー ドライブをサポートできる場合は true。
mSenderDriveSupported
bool mSenderDriveSupported
送信者のドライブをサポートできる場合は true。
mStartOffset
uint64_t mStartOffset
提案されているデータのオフセット。
mStartOffsetPresent
bool mStartOffsetPresent
開始オフセット フィールドが存在する場合は true になります。
mVersion
uint8_t mVersion
決定した BDX プロトコルのバージョンです。
mWideRange
bool mWideRange
オフセットと長さが 64 ビットの場合は true。
パブリック関数
SendInit
SendInit( void )
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData )
「ワイド」、SendInit を初期化します。
詳細 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||||
戻り値 |
成功した場合、WEAVE_NO_ERROR
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData )
「ワイドでない」SendInit(32 ビット開始オフセット、32 ビット長)を初期化する
詳細 | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||||
戻り値 |
成功した場合、WEAVE_NO_ERROR
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState )
「ワイド」、SendInit を初期化します。
詳細 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||||||
戻り値 |
成功した場合、WEAVE_NO_ERROR
|
init
WEAVE_ERROR init( uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, MetaDataTLVWriteCallback aMetaDataWriteCallback, void *aMetaDataAppState )
「ワイドでない」SendInit(32 ビット開始オフセット、32 ビット長)を初期化する
詳細 | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パラメータ |
|
||||||||||||||||||||
戻り値 |
成功した場合、WEAVE_NO_ERROR
|
オペレーター==
bool operator==( const SendInit & ) const
パック
WEAVE_ERROR pack( PacketBuffer *aBuffer )
init 送信メッセージを PacketBuffer にまとめます。
詳細 | |||||
---|---|---|---|---|---|
パラメータ |
|
||||
戻り値 |
|
PackedLength
uint16_t packedLength( void )
この送信 init メッセージのパックされた長さを返します。
詳細 | |
---|---|
戻り値 |
パック時のメールの長さ
|
静的パブリック関数
parse
WEAVE_ERROR parse( PacketBuffer *aBuffer, SendInit & aRequest )