nl:: Tenun:: Profil:: BDX_Development:: SendInit
#include <src/lib/profiles/bulk-data-transfer/Development/BDXMessages.h>
Pesan SendInit digunakan untuk memulai pertukaran saat pengirim adalah penginisialisasi.
Ringkasan
Warisan
Subclass Langsung yang Diketahui: nl::Weave::Profiles::BDX_Development::ReceiveInit
Konstruktor dan Destruktor |
|
---|---|
SendInit(void)
|
Jenis publik |
|
---|---|
MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
|
typedef MetaDataTLVWriteCallback menyediakan sarana yang dapat digunakan klien untuk menyediakan SendInit dengan metadata apa pun yang diinginkan. |
Atribut publik |
|
---|---|
mAsynchronousModeSupported
|
bool
True jika kami dapat mendukung mode asinkron.
|
mDefiniteLength
|
bool
True jika kolom panjang ada.
|
mFileDesignator
|
String yang berisi informasi pra-negosiasi.
|
mLength
|
uint64_t
Panjang data yang diusulkan dalam transfer, 0 untuk waktu tak terbatas.
|
mMaxBlockSize
|
uint16_t
Ukuran blok maksimum yang diusulkan untuk digunakan dalam transfer.
|
mMetaData
|
Metadata TLV opsional.
|
mMetaDataAppState
|
void *
Status aplikasi opsional untuk Metadata TLV.
|
mMetaDataWriteCallback
|
Fungsi opsional untuk menulis Metadata TLV.
|
mReceiverDriveSupported
|
bool
True jika kami dapat mendukung drive penerima.
|
mSenderDriveSupported
|
bool
True jika kami dapat mendukung drive pengirim.
|
mStartOffset
|
uint64_t
Pengimbangan awal data yang diusulkan.
|
mStartOffsetPresent
|
bool
True jika kolom offset awal ada.
|
mVersion
|
uint8_t
Versi protokol BDX yang kami putuskan.
|
mWideRange
|
bool
True jika offset dan panjangnya 64 bit.
|
Fungsi publik |
|
---|---|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
Inisialisasi "wide" SendInit.
|
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
|
Menginisialisasi "non-wide" SendInit (offset awal 32 bit, panjang 32 bit)
|
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)
|
Inisialisasi "wide" 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)
|
Menginisialisasi "non-wide" SendInit (offset awal 32 bit, panjang 32 bit)
|
operator==(const SendInit &) const
|
bool
Perbandingan persamaan antara pesan SendInit.
|
pack(PacketBuffer *aBuffer)
|
Memaketkan pesan kirim init ke dalam PacketBuffer.
|
packedLength(void)
|
uint16_t
Menampilkan panjang paket pesan init kirim.
|
Fungsi statis publik |
|
---|---|
parse(PacketBuffer *aBuffer, SendInit & aRequest)
|
Mengurai data dari PacketBuffer ke dalam format pesan SendInit.
|
Jenis publik
MetaDataTLVWriteCallback
WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)
MetaDataTLVWriteCallback menyediakan sarana yang dapat digunakan klien untuk menyediakan SendInit dengan metadata apa pun yang diinginkan.
Klien bebas menyediakan TLV yang telah dienkode sebelumnya (lebih cepat), mengenkode dengan cepat (menggunakan lebih sedikit memori), menjalankan kode lambat (littl lebih cepat saat memulai), dll. jika dirasa sesuai.
Dalam semua kasus, diasumsikan bahwa data yang dihasilkan oleh callback bersifat konstan untuk SendInit tertentu, yaitu tidak berubah tidak peduli kapan dipanggil. Hal ini karena callback juga digunakan untuk menghitung panjang TLV yang ditulis, yang dapat diminta kapan saja.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||
Nilai yang Ditampilkan |
|
Atribut publik
mAsyncMode Didukung
bool mAsynchronousModeSupported
True jika kami dapat mendukung mode asinkron.
mDefiniteLength
bool mDefiniteLength
True jika kolom panjang ada.
mPanjang
uint64_t mLength
Panjang data yang diusulkan dalam transfer, 0 untuk waktu tak terbatas.
mMaxBlockSize
uint16_t mMaxBlockSize
Ukuran blok maksimum yang diusulkan untuk digunakan dalam transfer.
mMetaDataWriteCallback
MetaDataTLVWriteCallback mMetaDataWriteCallback
Fungsi opsional untuk menulis Metadata TLV.
mReceiverDriveSupported
bool mReceiverDriveSupported
True jika kami dapat mendukung drive penerima.
mSenderDriveSupported
bool mSenderDriveSupported
True jika kami dapat mendukung drive pengirim.
OffsetMulai
uint64_t mStartOffset
Pengimbangan awal data yang diusulkan.
mStartOffsetSekarang
bool mStartOffsetPresent
True jika kolom offset awal ada.
Versi
uint8_t mVersion
Versi protokol BDX yang kami putuskan.
Rentang Lebar
bool mWideRange
True jika offset dan panjangnya 64 bit.
Fungsi publik
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 )
Inisialisasi "wide" SendInit.
Detail | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||||||
Menampilkan |
WEAVE_NO_ERROR jika berhasil
|
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 )
Menginisialisasi "non-wide" SendInit (offset awal 32 bit, panjang 32 bit)
Detail | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||||||
Menampilkan |
WEAVE_NO_ERROR jika berhasil
|
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 )
Inisialisasi "wide" SendInit.
Detail | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||||||||
Menampilkan |
WEAVE_NO_ERROR jika berhasil
|
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 )
Menginisialisasi "non-wide" SendInit (offset awal 32 bit, panjang 32 bit)
Detail | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
|
||||||||||||||||||||
Menampilkan |
WEAVE_NO_ERROR jika berhasil
|
operator==
bool operator==( const SendInit & ) const
pak
WEAVE_ERROR pack( PacketBuffer *aBuffer )
Memaketkan pesan kirim init ke dalam PacketBuffer.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Nilai yang Ditampilkan |
|
PanjangPanjang
uint16_t packedLength( void )
Menampilkan panjang paket pesan init kirim.
Detail | |
---|---|
Menampilkan |
panjang pesan ketika dikemas
|
Fungsi statis publik
mengurai
WEAVE_ERROR parse( PacketBuffer *aBuffer, SendInit & aRequest )
Mengurai data dari PacketBuffer ke dalam format pesan SendInit.
Detail | |||||
---|---|---|---|---|---|
Parameter |
|
||||
Nilai yang Ditampilkan |
|