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) typedef
MetaDataTLVWriteCallback एक ऐसा तरीका उपलब्ध कराता है जिससे क्लाइंट अपनी पसंद के किसी भी मेटाडेटा के साथ SendInit दे सकता है.

सार्वजनिक एट्रिब्यूट
mAsynchronousModeSupported
bool
सही है अगर हम एक साथ काम नहीं करने वाली प्रोसेस के साथ काम कर सकते हैं.
mDefiniteLength
bool
अगर लंबाई वाला फ़ील्ड मौजूद है, तो वैल्यू 'सही' होगी.
mFileDesignator
स्ट्रिंग जिसमें पहले से तय की गई जानकारी है.
mLength
uint64_t
ट्रांसफ़र में डेटा की सुझाई गई लंबाई, अनिश्चित समय के लिए 0.
mMaxBlockSize
uint16_t
ट्रांसफ़र में इस्तेमाल करने के लिए ब्लॉक का ज़्यादा से ज़्यादा साइज़ सुझाया गया.
mMetaData
टीएलवी मेटाडेटा ज़रूरी नहीं है.
mMetaDataAppState
void *
टीएलवी मेटाडेटा के लिए, ऐप्लिकेशन की वैकल्पिक स्थिति.
mMetaDataWriteCallback
टीएलवी मेटाडेटा लिखने के लिए वैकल्पिक फ़ंक्शन.
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)
'इनिट मैसेज भेजें' को पैकेटबफ़र में पैक करें.
packedLength(void)
uint16_t
इस 'init मैसेज भेजें' मैसेज की पैक की गई लंबाई दिखाता है.

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

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

MetaDataTLVWriteCallback

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

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

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

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

जानकारी
पैरामीटर
[in] aBuffer
डेस्टिनेशन बफ़र, जिसमें कुछ टीएलवी को लिखा जा सकता है
[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

टीएलवी मेटाडेटा ज़रूरी नहीं है.

mMetaDataAppState

void * mMetaDataAppState

टीएलवी मेटाडेटा के लिए, ऐप्लिकेशन की वैकल्पिक स्थिति.

mMetaDataWriteCallback

MetaDataTLVWriteCallback mMetaDataWriteCallback

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

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
(ज़रूरी नहीं) टीएलवी फ़ॉर्मैट में अतिरिक्त डेटा
लौटाए गए सामान
सफल होने पर 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
(ज़रूरी नहीं) टीएलवी फ़ॉर्मैट में अतिरिक्त डेटा
लौटाए गए सामान
सफल होने पर 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
(ज़रूरी नहीं) अतिरिक्त डेटा को टीएलवी फ़ॉर्मैट में लिखने के लिए फ़ंक्शन
[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
(ज़रूरी नहीं) अतिरिक्त डेटा को टीएलवी फ़ॉर्मैट में लिखने के लिए फ़ंक्शन
[in] aMetaDataAppState
(ज़रूरी नहीं) कॉलबैक फ़ंक्शन में वापस भेजा जाने वाला कॉन्टेक्स्ट
लौटाए गए सामान
सफल होने पर WEAVE_NO_ERROR

ऑपरेटर==

bool operator==(
  const SendInit &
) const

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

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

पैक

WEAVE_ERROR pack(
  PacketBuffer *aBuffer
)

'इनिट मैसेज भेजें' को पैकेटबफ़र में पैक करें.

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

packedLength

uint16_t packedLength(
  void
)

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

जानकारी
लौटाए गए सामान
पैक किए जाने पर संदेश की लंबाई

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

parse

WEAVE_ERROR parse(
  PacketBuffer *aBuffer,
  SendInit & aRequest
)

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

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