nl::Weave::Profiles::BDX_Development::SendInit

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

Gönderen kişi olduğunda exchange'i başlatmak için SendInit mesajı kullanılır.

Özet

Devralma

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

Oluşturucular ve Yıkıcılar
SendInit(void)

Herkese açık türler
MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) typedef
MetaDataTLVWriteCallback, istemcinin istediği herhangi bir meta veriyle SendInit sağlamasını sağlayan bir araç sunuyor.

Herkese açık özellikler
mAsynchronousModeSupported
bool
Eş zamansız modu destekleyebiliyorsak doğru değerini döndürür.
mDefiniteLength
bool
Uzunluk alanı mevcutsa doğru değerini döndürür.
mFileDesignator
Önceden pazarlık yapılmış bilgileri içeren dize.
mLength
uint64_t
Aktarım sırasında önerilen veri uzunluğu, belirsiz için 0.
mMaxBlockSize
uint16_t
Aktarımda 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 Verilerini yazmak için isteğe bağlı işlev.
mReceiverDriveSupported
bool
Alıcı sürücüsünü destekleyebiliyorsak doğrudur.
mSenderDriveSupported
bool
Doğru değerine ayarlandığında gönderen sürücüsünü destekleyebiliyorsak doğrudur.
mStartOffset
uint64_t
Verilerin önerilen başlangıç ofseti.
mStartOffsetPresent
bool
Başlangıç uzaklığı alanı varsa doğru değerini alır.
mVersion
uint8_t
Karar verdiğimiz BDX protokolünün sürümü.
mWideRange
bool
Ofset ve uzunluk 64 bitse doğru değerini alır.

Kamu işlevleri
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
"wide" için bir SendInit 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" bir SendInit öğesini başlatın (32 bit başlangıç ofseti, 32 bit uzunluk)
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)
"wide" için bir SendInit 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" bir SendInit öğesini başlatın (32 bit başlangıç ofseti, 32 bit uzunluk)
operator==(const SendInit &) const
bool
SendInit mesajları arasında eşitlik karşılaştırması.
pack(PacketBuffer *aBuffer)
Send init mesajını PacketBuffer içine yerleştirin.
packedLength(void)
uint16_t
Bu gönderme başlatma mesajının paket uzunluğunu döndürür.

Herkese açık statik işlevler
parse(PacketBuffer *aBuffer, SendInit & aRequest)
Verileri PacketBuffer'dan SendInit mesaj biçimine ayrıştırın.

Herkese açık türler

MetaDataTLVWriteCallback

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

MetaDataTLVWriteCallback, istemcinin istediği herhangi bir meta veriyle SendInit sağlamasını sağlayan bir araç sunuyor.

İstemci, uygun gördüğü şekilde önceden kodlanmış TLV (daha hızlı), çalışırken kodlama (daha az bellek kullanır), geç kodlama (başlangıçta biraz daha hızlı) gibi işlemleri yapabilir.

Her durumda, geri çağırma tarafından üretilen verilerin belirli bir SendInit için sabit olduğu, yani çağrılma zamanından bağımsız olarak değişmediği varsayılır. Bunun nedeni, geri çağırmanın bu tür yazılmış TLV'lerin uzunluğunu hesaplamak için de kullanılması ve istendiğinde istenebilmesidir.

Ayrıntılar
Parametreler
[in] aBuffer
Bazı TLV'lerin yazılabileceği hedef arabelleği
[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 uygulamanın durumu
Döndürülen Değerler
WEAVE_ERROR
Karşılaşılan herhangi bir hata.

Herkese açık özellikler

mAsynchronousModeSupported

bool mAsynchronousModeSupported

Eş zamansız modu destekleyebiliyorsak doğru değerini döndürür.

mDefiniteLength

bool mDefiniteLength

Uzunluk alanı mevcutsa doğru değerini döndürür.

mFileDesignator

ReferencedString mFileDesignator

Önceden pazarlık yapılmış bilgileri içeren dize.

mLength

uint64_t mLength

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

mMaxBlockSize

uint16_t mMaxBlockSize

Aktarımda kullanılacak maksimum blok boyutu.

mMetaData

ReferencedTLVData mMetaData

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

mMetaDataAppState

void * mMetaDataAppState

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

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

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

mReceiverDriveSupported

bool mReceiverDriveSupported

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

mSenderDriveSupported

bool mSenderDriveSupported

Doğru değerine ayarlandığında gönderen sürücüsünü destekleyebiliyorsak doğrudur.

mStartOffset

uint64_t mStartOffset

Verilerin önerilen başlangıç ofseti.

mStartOffsetPresent

bool mStartOffsetPresent

Başlangıç uzaklığı alanı varsa doğru değerini alır.

mVersion

uint8_t mVersion

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

mWideRange

bool mWideRange

Ofset ve uzunluk 64 bitse doğru değerini alır.

Kamu işlevleri

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
)

"wide" için bir SendInit başlatın.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araç kullanıyorsa doğru değerini döndürür
[in] aReceiverDrive
Alıcı araç sürüyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini alır
[in] aMaxBlockSize
Bu aktarım için maksimum engelleme boyutu teklifi
[in] aStartOffset
Dosyada, başlamamız gereken başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu: 0 değeri, sınırsız uzunlukta olduğu anlamına gelir.
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaData
(isteğe bağlı) TLV biçiminde 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" bir SendInit öğesini başlatın (32 bit başlangıç ofseti, 32 bit uzunluk)

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araç kullanıyorsa doğru değerini döndürür
[in] aReceiverDrive
Alıcı araç sürüyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini alır
[in] aMaxBlockSize
Bu aktarım için maksimum engelleme boyutu teklifi
[in] aStartOffset
Dosyada, başlamamız gereken başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu: 0 değeri, sınırsız uzunlukta olduğu anlamına gelir.
[in] aFileDesignator
Aktarılacak verileri tanımlayan bir dize
[in] aMetaData
(isteğe bağlı) TLV biçiminde 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
)

"wide" için bir SendInit başlatın.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araç kullanıyorsa doğru değerini döndürür
[in] aReceiverDrive
Alıcı araç sürüyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini alır
[in] aMaxBlockSize
Bu aktarım için maksimum engelleme boyutu teklifi
[in] aStartOffset
Dosyada, başlamamız gereken başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu: 0 değeri, sınırsız uzunlukta 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 yazan 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" bir SendInit öğesini başlatın (32 bit başlangıç ofseti, 32 bit uzunluk)

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araç kullanıyorsa doğru değerini döndürür
[in] aReceiverDrive
Alıcı araç sürüyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini alır
[in] aMaxBlockSize
Bu aktarım için maksimum engelleme boyutu teklifi
[in] aStartOffset
Dosyada, başlamamız gereken başlangıç ofseti
[in] aLength
Aktarılacak dosyanın uzunluğu: 0 değeri, sınırsız uzunlukta 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 yazan bir işlev
[in] aMetaDataAppState
(isteğe bağlı) Geri çağırma işlevine geri aktarılacak bir bağlam
İadeler
Başarılı olursa WEAVE_NO_ERROR

operatör==

bool operator==(
  const SendInit &
) const

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

Ayrıntılar
Parametreler
[in] another
Bunu karşılaştırmak için başka bir SendInit mesajı
İadeler
"true" olarak görünür.

paket

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

Send init mesajını PacketBuffer içine yerleştirin.

Ayrıntılar
Parametreler
[out] aBuffer
SendInit iletisinin paketlenmesini sağlayacak bir PacketBuffer
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılıysa
WEAVE_ERROR_BUFFER_TOO_SMALL
Tampon çok küçükse

packedLength

uint16_t packedLength(
  void
)

Bu gönderme başlatma 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
)

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

Ayrıntılar
Parametreler
[in] aBuffer
Ayrıştırmak istediğimiz verileri içeren bir PacketBuffer'ın işaretçisi
[out] aRequest
Sonuçları depolamamız gereken bir SendInit nesnesinin işaretçisi
Döndürülen Değerler
WEAVE_NO_ERROR
Başarılıysa
WEAVE_ERROR_BUFFER_TOO_SMALL
Tampon çok küçükse