Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

nl::Weave::Profiller:BDX_Geliştirme:SendInit

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

SendInit mesajı, gönderen başlatıcı olduğunda bir exchange'i başlatmak için kullanılır.

Özet

Devralma

Doğrudan Bilinen Alt Sınıflar: nl::Weave::Profiles::BDX_Development::ReceiveInit

İnşaat Ustaları ve Yıkıcılar

SendInit(void)

Herkese açık türler

MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) Tür
MetaDataTLVWriteCallback, istemcinin istediği meta verileri SendInit ile sağlaması için bir yol sağlar.

Herkese açık özellikler

mAsynchronousModeSupported
bool
Eş zamansız modu destekleyebilirsek doğrudur.
mDefiniteLength
bool
Uzunluk alanı mevcutsa doğru değerini alır.
mFileDesignator
Önceden görüşülen bilgileri içeren dize.
mLength
uint64_t
Aktarım sırasında önerilen veri uzunluğu, süresiz için 0.
mMaxBlockSize
uint16_t
Aktarım sırasında kullanılacak maksimum blok boyutu.
mMetaData
İsteğe bağlı TLV Meta Verileri.
mMetaDataAppState
void *
TLV Meta Verileri için isteğe bağlı uygulama durumu.
mMetaDataWriteCallback
TLV Meta Verileri yazmak için isteğe bağlı işlev.
mReceiverDriveSupported
bool
Alıcı sürücüsünü destekleyebiliyorsak bu doğrudur.
mSenderDriveSupported
bool
Gönderen Drive'ı destekleyebiliyorsak true değerini alırız.
mStartOffset
uint64_t
Önerilen başlangıç ofset verileri.
mStartOffsetPresent
bool
Başlangıç ofseti alanı mevcutsa doğru değerini alır.
mVersion
uint8_t
Karar verdiğimiz BDX protokolünün sürümü.
mWideRange
bool
Doğruluk ve uzunluk 64 bitse doğrudur.

Herkese açık işlevler

init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
SendInit genişliğini başlatın.
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
"Geniş" olmayan SendInit değerini başlat (32 bit başlangıç ofseti, 32 bit uzunluğu)
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 genişliğini başlatın.
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)
"Geniş" olmayan SendInit değerini başlat (32 bit başlangıç ofseti, 32 bit uzunluğu)
operator==(const SendInit &) const
bool
SendInit iletileri arasında eşitlik karşılaştırması.
pack(PacketBuffer *aBuffer)
Gönderin init mesajını PacketBuffer içinde paketleyin.
packedLength(void)
uint16_t
Bu init mesajının paket uzunluğunu döndürür.

Herkese açık statik işlevler

parse(PacketBuffer *aBuffer, SendInit & aRequest)
PacketBuffer'dan verileri SendInit mesaj biçimine ayrıştırın.

Herkese açık türler

MetaVeriTLVYazarak Geri Çağırma

WEAVE_ERROR(* MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState)

MetaDataTLVWriteCallback, istemcinin istediği meta verileri SendInit ile sağlaması için bir yol sağlar.

İstemci, önceden kodlanmış TLV'yi (daha hızlı), hızlı bir şekilde kodlama (daha az bellek kullanır), gerektiğinde kodlama (başlangıçta daha hızlı bir şekilde) vb. sağlar.

Her durumda, geri çağırma tarafından oluşturulan verilerin belirli bir SendInit için sabit olduğu kabul edilir (yani ne zaman çağrılırsa dursun değişmez). Bunun nedeni, geri çağırmanın herhangi bir zamanda istenebilecek bu tür yazılı TLV uzunluğunu hesaplamak için kullanılmasıdır.

Ayrıntılar
Parametreler
[in] aBuffer
Bazı TLV yazılabileceği hedef arabellek
[in] aBufferLength
Hedef arabelleğin uzunluğu (bayt cinsinden)
[in,out] aNumBytesWritten
Hedef arabelleğe yazılan bayt sayısı
[in] aAppState
Kullanıcı tarafından sağlanan uygulama durumu
Döndürülen Değerler
WEAVE_ERROR
Herhangi bir hata ile karşılaşıldı.

Herkese açık özellikler

mAEşzamansız Mod Desteklenir

bool mAsynchronousModeSupported

Eş zamansız modu destekleyebilirsek doğrudur.

mDefiniteLength

bool mDefiniteLength

Uzunluk alanı mevcutsa doğru değerini alır.

mFileDesignator

ReferencedString mFileDesignator

Önceden görüşülen bilgileri içeren dize.

mUzunluk

uint64_t mLength

Aktarım sırasında önerilen veri uzunluğu, süresiz için 0.

mMaxBlockSize

uint16_t mMaxBlockSize

Aktarım sırasında kullanılacak maksimum blok boyutu.

mMetaVerisi

ReferencedTLVData mMetaData

İsteğe bağlı TLV Meta Verileri.

mMetaDataAppState

void * mMetaDataAppState

TLV Meta Verileri için isteğe bağlı uygulama durumu.

mMetaDataWrite geri çağırma

MetaDataTLVWriteCallback mMetaDataWriteCallback

TLV Meta Verileri yazmak için isteğe bağlı işlev.

mReceiverDriveDestekli

bool mReceiverDriveSupported

Alıcı sürücüsünü destekleyebiliyorsak bu doğrudur.

mSenderDriveDestekli

bool mSenderDriveSupported

Gönderen Drive'ı destekleyebiliyorsak true değerini alırız.

mStartOfset

uint64_t mStartOffset

Önerilen başlangıç ofset verileri.

mStartOffsetOffer

bool mStartOffsetPresent

Başlangıç ofseti alanı mevcutsa doğru değerini alır.

mVersion

uint8_t mVersion

Karar verdiğimiz BDX protokolünün sürümü.

mWideRange

bool mWideRange

Doğruluk ve uzunluk 64 bitse doğrudur.

Herkese açık işlevler

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 genişliğini başlatın.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen sürüşteyse doğru
[in] aReceiverDrive
Alıcı araba kullanıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa "true" (doğru)
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlamamız gereken dosyadaki başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu - 0, dosyanın süresiz olduğu anlamına gelir
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaData
(isteğe bağlı) TLV biçimindeki ek veriler
İadeler
Başarılı olursa 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
)

"Geniş" olmayan SendInit değerini başlat (32 bit başlangıç ofseti, 32 bit uzunluğu)

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen sürüşteyse doğru
[in] aReceiverDrive
Alıcı araba kullanıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa "true" (doğru)
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlamamız gereken dosyadaki başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu - 0, dosyanın süresiz olduğu anlamına gelir
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaData
(isteğe bağlı) TLV biçimindeki ek veriler
İadeler
Başarılı olursa 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 genişliğini başlatın.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen sürüşteyse doğru
[in] aReceiverDrive
Alıcı araba kullanıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa "true" (doğru)
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlamamız gereken dosyadaki başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu - 0, dosyanın süresiz olduğu anlamına gelir
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaDataWriteCallback
(isteğe bağlı) Ek verileri TLV biçiminde yazmak için kullanılan bir işlev
[in] aMetaDataAppState
aMetaDataWriteCallback'e iletilecek isteğe bağlı bir bağlam
İadeler
Başarılı olursa 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
)

"Geniş" olmayan SendInit değerini başlat (32 bit başlangıç ofseti, 32 bit uzunluğu)

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen sürüşteyse doğru
[in] aReceiverDrive
Alıcı araba kullanıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa "true" (doğru)
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlamamız gereken dosyadaki başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu - 0, dosyanın süresiz olduğu anlamına gelir
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaDataWriteCallback
(isteğe bağlı) Ek verileri TLV biçiminde yazmak için kullanılan bir işlev
[in] aMetaDataAppState
(isteğe bağlı) Callback işlevine geri aktarılacak bağlam
İadeler
Başarılı olursa WEAVE_NO_ERROR

operatör==

bool operator==(
  const SendInit &
) const 

SendInit iletileri arasında eşitlik karşılaştırması.

Ayrıntılar
Parametreler
[in] another
Bu ile karşılaştırmak için başka bir SendInit mesajı
İadeler
true (doğru) değerine sahipse doğrudur.

paket

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Gönderin init mesajını PacketBuffer içinde paketleyin.

Ayrıntılar
Parametreler
[out] aBuffer
SendInit mesajını paketlenecek PaketetBuffer
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olursa
WEAVE_ERROR_BUFFER_TOO_SMALL
Arabellek çok küçükse

paketlenmişUzunluk

uint16_t packedLength(
  void
)

Bu init mesajının paket uzunluğunu döndürür.

Ayrıntılar
İadeler
paketlendiğinde mesajın uzunluğu

Herkese açık statik işlevler

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

PacketBuffer'dan verileri SendInit mesaj biçimine ayrıştırın.

Ayrıntılar
Parametreler
[in] aBuffer
Ayrıştırmak istediğimiz verileri içeren bir PaketetBuffer'ın üzerine gelin
[out] aRequest
Sonuçları saklamamız gereken, SendInit nesnesine işaret eden nesne
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılı olursa
WEAVE_ERROR_BUFFER_TOO_SMALL
Arabellek çok küçükse