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

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

SendInit मैसेज का इस्तेमाल एक्सचेंज शुरू करने के लिए किया जाता है जब भेजने वाला ही शुरुआत कर रहा हो.

खास जानकारी

इनहेरिटेंस

पहले से मालूम सब-क्लास: nl::Weave::Profiles::BDX_Development::ReceiveInit

कंस्ट्रक्टर और डिस्ट्रक्टर
SendInit(void)

सार्वजनिक प्रकार
MetaDataTLVWriteCallback)(uint8_t *aBuffer, uint16_t aBufferLength, uint16_t &aNumBytesWritten, void *aAppState) टाइपडिफ़
MetaDataTLVWriteCallback, एक ऐसा तरीका है जिससे क्लाइंट अपनी पसंद के किसी भी मेटाडेटा के साथ, SendInit दे सकता है.

सार्वजनिक विशेषताएं
mAsynchronousModeSupported
bool
सही है, अगर हम एक साथ काम नहीं करने वाले (एसिंक) मोड का इस्तेमाल कर सकते हैं.
mDefiniteLength
bool
अगर लंबाई वाला फ़ील्ड मौजूद है, तो सही है.
mFileDesignator
स्ट्रिंग में पहले से तय की गई जानकारी होती है.
mLength
uint64_t
ट्रांसफ़र में डेटा की प्रस्तावित लंबाई, अनिश्चित समय के लिए 0.
mMaxBlockSize
uint16_t
ट्रांसफ़र में इस्तेमाल करने के लिए, ब्लॉक का सुझाया गया ज़्यादा से ज़्यादा साइज़.
mMetaData
TLV मेटाडेटा ज़रूरी नहीं है.
mMetaDataAppState
void *
TLV मेटाडेटा के लिए, ऐप्लिकेशन की स्थिति ज़रूरी नहीं है.
mMetaDataWriteCallback
TLV मेटाडेटा लिखने के लिए वैकल्पिक फ़ंक्शन.
mReceiverDriveSupported
bool
अगर हम रिसीवर ड्राइव का समर्थन कर सकते हैं तो सही है.
mSenderDriveSupported
bool
अगर हम ड्राइव करने वाले लोगों के लिए, ड्राइव करने की सुविधा दे सकते हैं, तो वैल्यू 'सही' होगी.
mStartOffset
uint64_t
डेटा का प्रस्तावित शुरुआती ऑफ़सेट.
mStartOffsetPresent
bool
अगर स्टार्ट ऑफ़सेट फ़ील्ड मौजूद है, तो 'सही'.
mVersion
uint8_t
BDX प्रोटोकॉल का वह वर्शन जिसके बारे में हमने फ़ैसला लिया था.
mWideRange
bool
अगर ऑफ़सेट और लंबाई 64 बिट हैं, तो सही है.

सार्वजनिक फ़ंक्शन
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint64_t aStartOffset, uint64_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
"चौड़ी" शुरू करना SendInit.
init(uint8_t aVersion, bool aSenderDrive, bool aReceiverDrive, bool aAsynchMode, uint16_t aMaxBlockSize, uint32_t aStartOffset, uint32_t aLength, ReferencedString & aFileDesignator, ReferencedTLVData *aMetaData)
"गैर-व्यापी" शुरू करें SendInit (32 बिट स्टार्ट ऑफ़सेट, 32 बिट लंबाई)
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.
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)
"गैर-व्यापी" शुरू करें SendInit (32 बिट स्टार्ट ऑफ़सेट, 32 बिट लंबाई)
operator==(const SendInit &) const
bool
SendInit मैसेज के बीच बराबरी की तुलना.
pack(PacketBuffer *aBuffer)
किसी send init मैसेज को PacketBuffer में पैक करें.
packedLength(void)
uint16_t
इस भेजे गए इस मैसेज की पैक की गई लंबाई दिखाता है.

सार्वजनिक स्टैटिक फ़ंक्शन
parse(PacketBuffer *aBuffer, SendInit & aRequest)
PacketBuffer के डेटा को SendInit मैसेज फ़ॉर्मैट में पार्स करें.

सार्वजनिक प्रकार

MetaDataTLVWriteCallback

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

MetaDataTLVWriteCallback, एक ऐसा तरीका है जिससे क्लाइंट अपनी पसंद के किसी भी मेटाडेटा के साथ, SendInit दे सकता है.

क्लाइंट अपने हिसाब से, पहले से कोड में बदले गए TLV (ज़्यादा तेज़), तुरंत एन्कोड किया जा सकता है (कम मेमोरी का इस्तेमाल करता है), लेज़ी-एन्कोड (कुछ समय तक चालू रहने पर कुछ ज़्यादा तेज़) वगैरह उपलब्ध करवा सकता है.

सभी मामलों में, यह माना जाता है कि कॉलबैक से बनाया गया डेटा किसी दिए गए SendInit के लिए स्थिर होता है. इसका मतलब है कि यह कॉल किए जाने पर भी बदलता नहीं है. इसकी वजह यह है कि कॉलबैक का इस्तेमाल, ऐसे किसी भी लिखे गए TLV की लंबाई का हिसाब लगाने के लिए भी किया जाता है, जिसका अनुरोध किसी भी समय किया जा सकता है.

जानकारी
पैरामीटर
[in] aBuffer
डेस्टिनेशन बफ़र, जिसमें कुछ TLV लिखे जा सकते हैं
[in] aBufferLength
डेस्टिनेशन बफ़र की लंबाई (बाइट में)
[in,out] aNumBytesWritten
डेस्टिनेशन बफ़र में लिखे गए बाइट की संख्या
[in] aAppState
उपयोगकर्ता से मिले ऐप्लिकेशन की स्थिति
रिटर्न वैल्यू
WEAVE_ERROR
कोई गड़बड़ी हुई.

सार्वजनिक विशेषताएं

mAsynchronousModeSupported

bool mAsynchronousModeSupported

सही है, अगर हम एक साथ काम नहीं करने वाले (एसिंक) मोड का इस्तेमाल कर सकते हैं.

mDefiniteLength

bool mDefiniteLength

अगर लंबाई वाला फ़ील्ड मौजूद है, तो सही है.

mFileDesignator

ReferencedString mFileDesignator

स्ट्रिंग में पहले से तय की गई जानकारी होती है.

mLength

uint64_t mLength

ट्रांसफ़र में डेटा की प्रस्तावित लंबाई, अनिश्चित समय के लिए 0.

mMaxBlockSize

uint16_t mMaxBlockSize

ट्रांसफ़र में इस्तेमाल करने के लिए, ब्लॉक का सुझाया गया ज़्यादा से ज़्यादा साइज़.

mMetaData

ReferencedTLVData mMetaData

TLV मेटाडेटा ज़रूरी नहीं है.

mMetaDataAppState

void * mMetaDataAppState

TLV मेटाडेटा के लिए, ऐप्लिकेशन की स्थिति ज़रूरी नहीं है.

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

TLV मेटाडेटा लिखने के लिए वैकल्पिक फ़ंक्शन.

mReceiverDriveSupported

bool mReceiverDriveSupported

अगर हम रिसीवर ड्राइव का समर्थन कर सकते हैं तो सही है.

mSenderDriveSupported

bool mSenderDriveSupported

मैसेज भेजने वाले व्यक्ति की ड्राइव को सेव करने की सुविधा मिलने पर, यह वैल्यू 'सही' होती है.

mStartOffset

uint64_t mStartOffset

डेटा का प्रस्तावित शुरुआती ऑफ़सेट.

mStartOffsetPresent

bool mStartOffsetPresent

अगर स्टार्ट ऑफ़सेट फ़ील्ड मौजूद है, तो 'सही'.

mVersion

uint8_t mVersion

BDX प्रोटोकॉल का वह वर्शन जिसके बारे में हमने फ़ैसला लिया था.

mWideRange

bool mWideRange

अगर ऑफ़सेट और लंबाई 64 बिट हैं, तो सही है.

सार्वजनिक फ़ंक्शन

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.

जानकारी
पैरामीटर
[in] aVersion
BDX का वह वर्शन जिसका हम इस्तेमाल कर रहे हैं
[in] aSenderDrive
अगर भेजने वाला व्यक्ति ड्राइव कर रहा है, तो सही है
[in] aReceiverDrive
अगर पाने वाला गाड़ी चला रहा है, तो सही है
[in] aAsynchMode
अगर डिवाइस एसिंक्रोनस मोड पर काम करता है, तो वैल्यू 'सही' होगी
[in] aMaxBlockSize
इस ट्रांसफ़र के लिए ब्लॉक करने की सीमा से जुड़ा प्रस्ताव
[in] aStartOffset
फ़ाइल में ऑफ़सेट शुरू करें, जिसे हमें शुरू करना चाहिए
[in] aLength
ट्रांसफ़र की जाने वाली फ़ाइल की लंबाई - 0 होने का मतलब है कि इसकी लंबाई अनिश्चित है
[in] aFileDesignator
ट्रांसफ़र किए जाने वाले डेटा की पहचान करने वाली स्ट्रिंग
[in] aMetaData
(ज़रूरी नहीं) TLV फ़ॉर्मैट में अतिरिक्त डेटा
लौटाए जाने वाले प्रॉडक्ट
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
)

"गैर-व्यापी" शुरू करें SendInit (32 बिट स्टार्ट ऑफ़सेट, 32 बिट लंबाई)

जानकारी
पैरामीटर
[in] aVersion
BDX का वह वर्शन जिसका हम इस्तेमाल कर रहे हैं
[in] aSenderDrive
अगर भेजने वाला व्यक्ति ड्राइव कर रहा है, तो सही है
[in] aReceiverDrive
अगर पाने वाला गाड़ी चला रहा है, तो सही है
[in] aAsynchMode
अगर डिवाइस एसिंक्रोनस मोड पर काम करता है, तो वैल्यू 'सही' होगी
[in] aMaxBlockSize
इस ट्रांसफ़र के लिए ब्लॉक करने की सीमा से जुड़ा प्रस्ताव
[in] aStartOffset
फ़ाइल में ऑफ़सेट शुरू करें, जिसे हमें शुरू करना चाहिए
[in] aLength
ट्रांसफ़र की जाने वाली फ़ाइल की लंबाई - 0 होने का मतलब है कि इसकी लंबाई अनिश्चित है
[in] aFileDesignator
ट्रांसफ़र किए जाने वाले डेटा की पहचान करने वाली स्ट्रिंग
[in] aMetaData
(ज़रूरी नहीं) TLV फ़ॉर्मैट में अतिरिक्त डेटा
लौटाए जाने वाले प्रॉडक्ट
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.

जानकारी
पैरामीटर
[in] aVersion
BDX का वह वर्शन जिसका हम इस्तेमाल कर रहे हैं
[in] aSenderDrive
अगर भेजने वाला व्यक्ति ड्राइव कर रहा है, तो सही है
[in] aReceiverDrive
अगर पाने वाला गाड़ी चला रहा है, तो सही है
[in] aAsynchMode
अगर डिवाइस एसिंक्रोनस मोड पर काम करता है, तो वैल्यू 'सही' होगी
[in] aMaxBlockSize
इस ट्रांसफ़र के लिए ब्लॉक करने की सीमा से जुड़ा प्रस्ताव
[in] aStartOffset
फ़ाइल में ऑफ़सेट शुरू करें, जिसे हमें शुरू करना चाहिए
[in] aLength
ट्रांसफ़र की जाने वाली फ़ाइल की लंबाई - 0 होने का मतलब है कि इसकी लंबाई अनिश्चित है
[in] aFileDesignator
ट्रांसफ़र किए जाने वाले डेटा की पहचान करने वाली स्ट्रिंग
[in] aMetaDataWriteCallback
(ज़रूरी नहीं) अतिरिक्त डेटा को TLV फ़ॉर्मैट में लिखने के लिए फ़ंक्शन
[in] aMetaDataAppState
aMetaDataWriteCallback में दिया जाने वाला वैकल्पिक संदर्भ
लौटाए जाने वाले प्रॉडक्ट
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
)

"गैर-व्यापी" शुरू करें SendInit (32 बिट स्टार्ट ऑफ़सेट, 32 बिट लंबाई)

जानकारी
पैरामीटर
[in] aVersion
BDX का वह वर्शन जिसका हम इस्तेमाल कर रहे हैं
[in] aSenderDrive
अगर भेजने वाला व्यक्ति ड्राइव कर रहा है, तो सही है
[in] aReceiverDrive
अगर पाने वाला गाड़ी चला रहा है, तो सही है
[in] aAsynchMode
अगर डिवाइस एसिंक्रोनस मोड पर काम करता है, तो वैल्यू 'सही' होगी
[in] aMaxBlockSize
इस ट्रांसफ़र के लिए ब्लॉक करने की सीमा से जुड़ा प्रस्ताव
[in] aStartOffset
फ़ाइल में ऑफ़सेट शुरू करें, जिसे हमें शुरू करना चाहिए
[in] aLength
ट्रांसफ़र की जाने वाली फ़ाइल की लंबाई - 0 होने का मतलब है कि इसकी लंबाई अनिश्चित है
[in] aFileDesignator
ट्रांसफ़र किए जाने वाले डेटा की पहचान करने वाली स्ट्रिंग
[in] aMetaDataWriteCallback
(ज़रूरी नहीं) अतिरिक्त डेटा को TLV फ़ॉर्मैट में लिखने के लिए फ़ंक्शन
[in] aMetaDataAppState
(ज़रूरी नहीं) कॉलबैक फ़ंक्शन में वापस पास किया जाने वाला कॉन्टेक्स्ट
लौटाए जाने वाले प्रॉडक्ट
WEAVE_NO_ERROR अगर सफल रहे

ऑपरेटर==

bool operator==(
  const SendInit &
) const

SendInit मैसेज के बीच बराबरी की तुलना.

जानकारी
पैरामीटर
[in] another
इसकी तुलना करने के लिए एक और SendInit मैसेज
लौटाए जाने वाले प्रॉडक्ट
सही iff में सभी फ़ील्ड एक जैसे हों.

पैक

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

किसी send init मैसेज को PacketBuffer में पैक करें.

जानकारी
पैरामीटर
[out] aBuffer
SendInit मैसेज को पैक करने के लिए PacketBuffer
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर हो गया है, तो
WEAVE_ERROR_BUFFER_TOO_SMALL
अगर बफ़र बहुत छोटा है

packedLength

uint16_t packedLength(
  void
)

इस भेजे गए इस मैसेज की पैक की गई लंबाई दिखाता है.

जानकारी
लौटाए जाने वाले प्रॉडक्ट
पैक करने पर मैसेज की लंबाई

सार्वजनिक स्टैटिक फ़ंक्शन

पार्स करें

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

PacketBuffer के डेटा को SendInit मैसेज फ़ॉर्मैट में पार्स करें.

जानकारी
पैरामीटर
[in] aBuffer
ऐसे पैकेटबफ़र की ओर इशारा करता है जिसमें वह डेटा है जिसे हम पार्स करना चाहते हैं
[out] aRequest
उस SendInit ऑब्जेक्ट पर कर्सर ले जाएं जहां हमें नतीजे सेव करने चाहिए
रिटर्न वैल्यू
WEAVE_NO_ERROR
अगर हो गया है, तो
WEAVE_ERROR_BUFFER_TOO_SMALL
अगर बफ़र बहुत छोटा है