Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.
Tetap teratur dengan koleksi Simpan dan kategorikan konten berdasarkan preferensi Anda.

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
[in] aBuffer
Buffering tujuan, tempat beberapa TLV dapat ditulis
[in] aBufferLength
Panjang buffer tujuan (dalam byte)
[in,out] aNumBytesWritten
Jumlah byte yang ditulis ke buffer tujuan
[in] aAppState
Status aplikasi yang disediakan pengguna
Nilai yang Ditampilkan
WEAVE_ERROR
Terjadi error.

Atribut publik

mAsyncMode Didukung

bool mAsynchronousModeSupported

True jika kami dapat mendukung mode asinkron.

mDefiniteLength

bool mDefiniteLength

True jika kolom panjang ada.

mFileDesignator

ReferencedString mFileDesignator

String yang berisi informasi pra-negosiasi.

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.

mMetaData

ReferencedTLVData mMetaData

Metadata TLV opsional.

StatusAplikasi mMeta

void * mMetaDataAppState

Status aplikasi opsional untuk Metadata TLV.

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
[in] aVersion
Versi BDX yang kami gunakan
[in] aSenderDrive
True jika pengirim mengemudi
[in] aReceiverDrive
True jika penerima sedang mengemudi
[in] aAsynchMode
True jika perangkat mendukung mode asinkron
[in] aMaxBlockSize
Proposal ukuran blok maksimum untuk transfer ini
[in] aStartOffset
Mulai offset dalam file tempat kita harus memulai
[in] aLength
Panjang file yang akan ditransfer - 0 artinya file memiliki durasi tidak terbatas
[in] aFileDesignator
String yang mengidentifikasi data yang akan ditransfer
[in] aMetaData
(opsional) Data tambahan dalam format TLV
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
[in] aVersion
Versi BDX yang kami gunakan
[in] aSenderDrive
True jika pengirim mengemudi
[in] aReceiverDrive
True jika penerima sedang mengemudi
[in] aAsynchMode
True jika perangkat mendukung mode asinkron
[in] aMaxBlockSize
Proposal ukuran blok maksimum untuk transfer ini
[in] aStartOffset
Mulai offset dalam file tempat kita harus memulai
[in] aLength
Panjang file yang akan ditransfer - 0 artinya file memiliki durasi tidak terbatas
[in] aFileDesignator
String yang mengidentifikasi data yang akan ditransfer
[in] aMetaData
(opsional) Data tambahan dalam format TLV
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
[in] aVersion
Versi BDX yang kami gunakan
[in] aSenderDrive
True jika pengirim mengemudi
[in] aReceiverDrive
True jika penerima sedang mengemudi
[in] aAsynchMode
True jika perangkat mendukung mode asinkron
[in] aMaxBlockSize
Proposal ukuran blok maksimum untuk transfer ini
[in] aStartOffset
Mulai offset dalam file tempat kita harus memulai
[in] aLength
Panjang file yang akan ditransfer - 0 artinya file memiliki durasi tidak terbatas
[in] aFileDesignator
String yang mengidentifikasi data yang akan ditransfer
[in] aMetaDataWriteCallback
(opsional) Fungsi untuk menulis data tambahan dalam format TLV
[in] aMetaDataAppState
Konteks opsional yang akan diteruskan ke aMetaDataWriteCallback
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
[in] aVersion
Versi BDX yang kami gunakan
[in] aSenderDrive
True jika pengirim mengemudi
[in] aReceiverDrive
True jika penerima sedang mengemudi
[in] aAsynchMode
True jika perangkat mendukung mode asinkron
[in] aMaxBlockSize
Proposal ukuran blok maksimum untuk transfer ini
[in] aStartOffset
Mulai offset dalam file tempat kita harus memulai
[in] aLength
Panjang file yang akan ditransfer - 0 artinya file memiliki durasi tidak terbatas
[in] aFileDesignator
String yang mengidentifikasi data yang akan ditransfer
[in] aMetaDataWriteCallback
(opsional) Fungsi untuk menulis data tambahan dalam format TLV
[in] aMetaDataAppState
(opsional) Konteks yang akan diteruskan kembali ke fungsi callback
Menampilkan
WEAVE_NO_ERROR jika berhasil

operator==

bool operator==(
  const SendInit &
) const

Perbandingan persamaan antara pesan SendInit.

Detail
Parameter
[in] another
Pesan SendInit lainnya untuk membandingkan pesan ini
Menampilkan
jika semuanya memiliki kolom yang sama.

pak

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Memaketkan pesan kirim init ke dalam PacketBuffer.

Detail
Parameter
[out] aBuffer
PacketBuffer untuk mengemas pesan SendInit di
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Jika berhasil
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika buffer terlalu kecil

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
[in] aBuffer
Pointer ke PacketBuffer yang memiliki data yang ingin diuraikan
[out] aRequest
Pointer ke objek SendInit tempat kita harus menyimpan hasilnya
Nilai yang Ditampilkan
WEAVE_NO_ERROR
Jika berhasil
WEAVE_ERROR_BUFFER_TOO_SMALL
Jika buffer terlalu kecil