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

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

SendInit mesajı, göndereni başlatan olduğunda bir exchange başlatmak için 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, bir istemcinin SendInit'i istediği meta veriyi sağlamak için kullanabileceği bir araç sunar.

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 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ımda kullanılacak önerilen 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ğru değerini döndürür.
mSenderDriveSupported
bool
Gönderen Drive'ını destekleyebiliyorsak doğru değerini döndürür.
mStartOffset
uint64_t
Verilerin önerilen başlangıç ofseti.
mStartOffsetPresent
bool
Başlangıç uzaklığı alanı mevcutsa doğru değerini döndürür.
mVersion
uint8_t
Kararlaştırdığımız BDX protokolünün sürümü.
mWideRange
bool
Ofset ve uzunluk 64 bitse doğru değerini alır.

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)
"wide" özelliğini başlatın SendInit.
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" öğesini başlatma SendInit (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" özelliğini başlatın 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)
"Geniş olmayan" öğesini başlatma SendInit (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)
PacketBuffer'a gönderme başlatma mesajı paketleyin.
packedLength(void)
uint16_t
Bu gönderme başlangıç mesajının paketlenmiş uzunluğunu döndürür.

Herkese açık statik işlevler
parse(PacketBuffer *aBuffer, SendInit & aRequest)
PacketBuffer'daki verileri 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, bir istemcinin SendInit'i istediği meta veriyi sağlamak için kullanabileceği bir araç sunar.

İstemci, önceden kodlanmış TLV (daha hızlı), çalışırken kodlama (daha az bellek kullanır), geç kodlama (başlangıçta biraz daha hızlı) vb. bunları uygun gördükleri şekilde sağlayabilir.

Her durumda, geri çağırma işleminin oluşturduğu verilerin belirli bir SendInit için sabit olduğu, diğer bir deyişle çağrının ne zaman çağrıldığı fark etmeksizin değişmediği varsayılır. Bunun nedeni, geri çağırmanın herhangi bir zamanda istenebilecek olan bu yazılı TLV'nin uzunluğunu hesaplamak için de kullanılmasıdır.

Ayrıntılar
Parametreler
[in] aBuffer
Bir miktar TLV'nin yazılabileceği hedef tampon
[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
Değerleri Döndür
WEAVE_ERROR
Karşılaşılan tüm hatalar.

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 görüşülen bilgileri içeren dize.

mLength

uint64_t mLength

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

mMaxBlockSize

uint16_t mMaxBlockSize

Aktarımda kullanılacak önerilen 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ğru değerini döndürür.

mSenderDriveSupported

bool mSenderDriveSupported

Gönderen Drive'ını destekleyebiliyorsak doğru değerini döndürür.

mStartOffset

uint64_t mStartOffset

Verilerin önerilen başlangıç ofseti.

mStartOffsetPresent

bool mStartOffsetPresent

Başlangıç uzaklığı alanı mevcutsa doğru değerini döndürür.

mVersion

uint8_t mVersion

Kararlaştırdığımız BDX protokolünün sürümü.

mWideRange

bool mWideRange

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

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
)

"wide" özelliğini başlatın SendInit.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araba kullanıyorsa doğru değerini alır
[in] aReceiverDrive
Alıcı sürüş yapıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini döndürür
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlangıçta yapmamı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ıysa 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" öğesini başlatma SendInit (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 araba kullanıyorsa doğru değerini alır
[in] aReceiverDrive
Alıcı sürüş yapıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini döndürür
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlangıçta yapmamı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ıysa 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" özelliğini başlatın SendInit.

Ayrıntılar
Parametreler
[in] aVersion
Kullandığımız BDX sürümü
[in] aSenderDrive
Gönderen araba kullanıyorsa doğru değerini alır
[in] aReceiverDrive
Alıcı sürüş yapıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini döndürür
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlangıçta yapmamı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ıysa 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" öğesini başlatma SendInit (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 araba kullanıyorsa doğru değerini alır
[in] aReceiverDrive
Alıcı sürüş yapıyorsa doğru
[in] aAsynchMode
Cihaz eşzamansız modu destekliyorsa doğru değerini döndürür
[in] aMaxBlockSize
Bu aktarım için maksimum blok boyutu teklifi
[in] aStartOffset
Başlangıçta yapmamı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ı) Geri çağırma işlevine geri verilecek bir bağlam
İadeler
Başarılıysa 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 (doğru) değerine sahip olmalıdır.

paket

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

PacketBuffer'a gönderme başlatma mesajı paketleyin.

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

packedLength

uint16_t packedLength(
  void
)

Bu gönderme başlangıç mesajının paketlenmiş uzunluğunu döndürür.

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

Herkese açık statik işlevler

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

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

Ayrıntılar
Parametreler
[in] aBuffer
Ayrıştırmak istediğimiz verilerin bulunduğu bir PacketBuffer'ın işaretçisi
[out] aRequest
Sonuçları depolamamız gereken bir SendInit nesnesine işaretçi
Değerleri Döndür
WEAVE_NO_ERROR
Başarılıysa
WEAVE_ERROR_BUFFER_TOO_SMALL
Arabellek çok küçükse