मैसेज
इस मॉड्यूल में ऐसे फ़ंक्शन शामिल हैं जो OpenThread मैसेज बफ़र में बदलाव करते हैं.
खास जानकारी
गिनती |
|
---|---|
otMessageOrigin{
|
enum OpenThread मैसेज के ऑरिजिन के बारे में जानकारी. |
otMessagePriority{
|
enum OpenThread मैसेज के प्राथमिकता लेवल को तय करता है. |
टाइपडीफ़ |
|
---|---|
otBufferInfo
|
typedefstruct otBufferInfo
यह, OpenThread स्टैक में इस्तेमाल की जाने वाली अलग-अलग सूचियों के लिए मैसेज बफ़र की जानकारी दिखाता है. |
otMessage
|
typedefstruct otMessage
OpenThread मैसेज बफ़र का ओपेक प्रज़ेंटेशन. |
otMessageOrigin
|
typedefenum otMessageOrigin
OpenThread मैसेज के ऑरिजिन के बारे में जानकारी. |
otMessagePriority
|
typedefenum otMessagePriority
OpenThread मैसेज के प्राथमिकता लेवल को तय करता है. |
otMessageQueueInfo
|
typedefstruct otMessageQueueInfo
यह मैसेज सूची के बारे में जानकारी दिखाता है. |
otMessageSettings
|
typedefstruct otMessageSettings
यह मैसेज सेटिंग के बारे में बताता है. |
फ़ंक्शन |
|
---|---|
otMessageAppend(otMessage *aMessage, const void *aBuf, uint16_t aLength)
|
मैसेज में बाइट जोड़ें.
|
otMessageFree(otMessage *aMessage)
|
void
तय किए गए मैसेज बफ़र को खाली करें.
|
otMessageGetBufferInfo(otInstance *aInstance, otBufferInfo *aBufferInfo)
|
void
मैसेज बफ़र की जानकारी पाएं.
|
otMessageGetLength(const otMessage *aMessage)
|
uint16_t
मैसेज की लंबाई बाइट में देखें.
|
otMessageGetOffset(const otMessage *aMessage)
|
uint16_t
मैसेज ऑफ़सेट बाइट में पाएं.
|
otMessageGetOrigin(const otMessage *aMessage)
|
मैसेज के ऑरिजिन की जानकारी मिलती है.
|
otMessageGetRss(const otMessage *aMessage)
|
int8_t
मैसेज से जुड़े औसत आरएसएस (मिलने वाले सिग्नल की क्षमता) दिखाता है.
|
otMessageIsLinkSecurityEnabled(const otMessage *aMessage)
|
bool
इससे पता चलता है कि मैसेज के लिए लिंक की सुरक्षा चालू है या नहीं.
|
otMessageIsLoopbackToHostAllowed(const otMessage *aMessage)
|
bool
यह बताता है कि मैसेज को वापस होस्ट पर लूप में चलाने की अनुमति है या नहीं.
|
otMessageIsMulticastLoopEnabled(otMessage *aMessage)
|
bool
इससे पता चलता है कि मल् टीकास्ट डेस्टिनेशन पते के मामले में, दिया गया मैसेज लूप बैक किया जा सकता है या नहीं.
|
otMessageQueueDequeue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
दिए गए मैसेज की सूची से कोई मैसेज हटाता है.
|
otMessageQueueEnqueue(otMessageQueue *aQueue, otMessage *aMessage)
|
void
दिए गए मैसेज की सूची के आखिर में कोई मैसेज जोड़ता है.
|
otMessageQueueEnqueueAtHead(otMessageQueue *aQueue, otMessage *aMessage)
|
void
दिए गए मैसेज की सूची में सबसे ऊपर/सामने मैसेज जोड़ता है.
|
otMessageQueueGetHead(otMessageQueue *aQueue)
|
सूची में सबसे ऊपर मैसेज की ओर पॉइंटर दिखाता है.
|
otMessageQueueGetNext(otMessageQueue *aQueue, const otMessage *aMessage)
|
आगे की कार्रवाई (हेड से टेल) तक, सूची में अगले मैसेज पर जाने के लिए पॉइंटर दिखाता है.
|
otMessageQueueInit(otMessageQueue *aQueue)
|
void
मैसेज सूची को शुरू करें.
|
otMessageRead(const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength)
|
uint16_t
किसी मैसेज में बाइट पढ़ना.
|
otMessageResetBufferInfo(otInstance *aInstance)
|
void
संदेश बफ़र जानकारी काउंटर को एक ही समय में उपयोग किए जा रहे अधिकतम बफ़रों को ट्रैक करते हुए रीसेट करें.
|
otMessageSetDirectTransmission(otMessage *aMessage, bool aEnabled)
|
void
डायरेक्ट ट्रांसमिशन का इस्तेमाल करके, मैसेज को फ़ॉरवर्ड करने की सुविधा सेट करता है या उसे फ़ोर्स करता है.
|
otMessageSetLength(otMessage *aMessage, uint16_t aLength)
|
मैसेज की लंबाई बाइट में सेट करें.
|
otMessageSetLoopbackToHostAllowed(otMessage *aMessage, bool aAllowLoopbackToHost)
|
void
सेट करता है कि मैसेज को वापस होस्ट पर लूप में चलाने की अनुमति है या नहीं.
|
otMessageSetMulticastLoopEnabled(otMessage *aMessage, bool aEnabled)
|
void
यह नीति कंट्रोल करती है कि क्या किसी मैसेज को मल्टीकास्ट डेस्टिनेशन पते के मामले में लूप बैक किया जा सकता है.
|
otMessageSetOffset(otMessage *aMessage, uint16_t aOffset)
|
void
मैसेज ऑफ़सेट को बाइट में सेट करें.
|
otMessageSetOrigin(otMessage *aMessage, otMessageOrigin aOrigin)
|
void
मैसेज का ऑरिजिन सेट करता है.
|
otMessageWrite(otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength)
|
int
किसी मैसेज में बाइट लिखें.
|
संरचना |
|
---|---|
otBufferInfo |
यह, OpenThread स्टैक में इस्तेमाल की जाने वाली अलग-अलग सूचियों के लिए मैसेज बफ़र की जानकारी दिखाता है. |
otMessageQueue |
OpenThread मैसेज की सूची के तौर पर. |
otMessageQueueInfo |
यह मैसेज सूची के बारे में जानकारी दिखाता है. |
otMessageSettings |
यह मैसेज सेटिंग के बारे में बताता है. |
गिनती
otMessageOrigin
otMessageOrigin
OpenThread मैसेज के ऑरिजिन के बारे में जानकारी.
प्रॉपर्टी | |
---|---|
OT_MESSAGE_ORIGIN_HOST_TRUSTED
|
होस्ट पर किसी भरोसेमंद स्रोत से मैसेज. |
OT_MESSAGE_ORIGIN_HOST_UNTRUSTED
|
होस्ट पर किसी गैर-भरोसेमंद सोर्स से मिला मैसेज. |
OT_MESSAGE_ORIGIN_THREAD_NETIF
|
Thread Netif का मैसेज. |
otMessagePriority
otMessagePriority
OpenThread मैसेज के प्राथमिकता लेवल को तय करता है.
प्रॉपर्टी | |
---|---|
OT_MESSAGE_PRIORITY_HIGH
|
सबसे ज़्यादा प्राथमिकता वाला लेवल. |
OT_MESSAGE_PRIORITY_LOW
|
कम प्राथमिकता का स्तर. |
OT_MESSAGE_PRIORITY_NORMAL
|
प्राथमिकता का सामान्य लेवल. |
टाइपडीफ़
otBufferInfo
struct otBufferInfo otBufferInfo
यह, OpenThread स्टैक में इस्तेमाल की जाने वाली अलग-अलग सूचियों के लिए मैसेज बफ़र की जानकारी दिखाता है.
otMessageOrigin
enum otMessageOrigin otMessageOrigin
OpenThread मैसेज के ऑरिजिन के बारे में जानकारी.
otMessagePriority
enum otMessagePriority otMessagePriority
OpenThread मैसेज के प्राथमिकता लेवल को तय करता है.
otMessageQueueInfo
struct otMessageQueueInfo otMessageQueueInfo
यह मैसेज सूची के बारे में जानकारी दिखाता है.
फ़ंक्शन
otMessageAppend
otError otMessageAppend( otMessage *aMessage, const void *aBuf, uint16_t aLength )
मैसेज में बाइट जोड़ें.
ब्यौरा | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
|
||||||
रिटर्न वैल्यू |
|
otMessageFree
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
राइट
otMessageFree
void otMessageFree( otMessage *aMessage )
तय किए गए मैसेज बफ़र को खाली करें.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
लिखें
otMessageGetBufferInfo
void otMessageGetBufferInfo( otInstance *aInstance, otBufferInfo *aBufferInfo )
मैसेज बफ़र की जानकारी पाएं.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageGetLength
uint16_t otMessageGetLength( const otMessage *aMessage )
मैसेज की लंबाई बाइट में देखें.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
||
लौटाए गए सामान |
मैसेज की लंबाई बाइट में.
|
otMessageFree
otMessageAppend
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
Write otMessageSetLength
otMessageGetOffset
uint16_t otMessageGetOffset( const otMessage *aMessage )
मैसेज ऑफ़सेट बाइट में पाएं.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
||
लौटाए गए सामान |
मैसेज ऑफ़सेट वैल्यू.
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageSetOffset
otMessageRead
otMessageWrite
otMessageGetOrigin
otMessageOrigin otMessageGetOrigin( const otMessage *aMessage )
मैसेज के ऑरिजिन की जानकारी मिलती है.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
||
लौटाए गए सामान |
मैसेज का ऑरिजिन.
|
otMessageGetRss
int8_t otMessageGetRss( const otMessage *aMessage )
मैसेज से जुड़े औसत आरएसएस (मिलने वाले सिग्नल की क्षमता) दिखाता है.
ब्यौरा | |
---|---|
लौटाए गए सामान |
अगर कोई औसत आरएसएस उपलब्ध नहीं है, तो आरएसएस की औसत वैल्यू (dBm में) या OT_Radio_RSSI_INVALID.
|
otMessageIsLinkSecurityEnabled
bool otMessageIsLinkSecurityEnabled( const otMessage *aMessage )
इससे पता चलता है कि मैसेज के लिए लिंक की सुरक्षा चालू है या नहीं.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
||||
रिटर्न वैल्यू |
|
otMessageIsLoopbackToHostAllowed
bool otMessageIsLoopbackToHostAllowed( const otMessage *aMessage )
यह बताता है कि मैसेज को वापस होस्ट पर लूप में चलाने की अनुमति है या नहीं.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
||||
रिटर्न वैल्यू |
|
otMessageIsMulticastLoopEnabled
bool otMessageIsMulticastLoopEnabled( otMessage *aMessage )
इससे पता चलता है कि मल् टीकास्ट डेस्टिनेशन पते के मामले में, दिया गया मैसेज लूप बैक किया जा सकता है या नहीं.
अगर aMessage
का इस्तेमाल otMessageInfo
के साथ किया जाता है, तो otMessageInfo
स्ट्रक्चर के mMulticastLoop
फ़ील्ड को प्राथमिकता दी जाएगी. इसका इस्तेमाल, aMessage
पर सेट की गई वैल्यू के बजाय किया जाएगा.
यह एपीआई खास तौर पर otIp6Send()
के साथ इस्तेमाल करने के लिए बनाया गया है, क्योंकि यह पहले से तैयार IPv6 मैसेज की उम्मीद करता है.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
otMessageQueueDequeue
void otMessageQueueDequeue( otMessageQueue *aQueue, otMessage *aMessage )
दिए गए मैसेज की सूची से कोई मैसेज हटाता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageQueueEnqueue
void otMessageQueueEnqueue( otMessageQueue *aQueue, otMessage *aMessage )
दिए गए मैसेज की सूची के आखिर में कोई मैसेज जोड़ता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageQueueEnqueueAtHead
void otMessageQueueEnqueueAtHead( otMessageQueue *aQueue, otMessage *aMessage )
दिए गए मैसेज की सूची में सबसे ऊपर/सामने मैसेज जोड़ता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageQueueGetHead
otMessage * otMessageQueueGetHead( otMessageQueue *aQueue )
सूची में सबसे ऊपर मैसेज की ओर पॉइंटर दिखाता है.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
||
लौटाए गए सामान |
सूची में सबसे ऊपर मैसेज दिखाने के लिए पॉइंटर या अगर सूची खाली हो, तो NULL हो सकता है.
|
otMessageQueueGetNext
otMessage * otMessageQueueGetNext( otMessageQueue *aQueue, const otMessage *aMessage )
आगे की कार्रवाई (हेड से टेल) तक, सूची में अगले मैसेज पर जाने के लिए पॉइंटर दिखाता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
||||
लौटाए गए सामान |
aMessage के बाद सूची में अगले मैसेज पर जाने के लिए पॉइंटर या aMessage is the tail of queue. NULL is returned if aMessageis not in the queue aQueue` पर मैसेज दिखने पर NULL कर दें. |
otMessageQueueInit
void otMessageQueueInit( otMessageQueue *aQueue )
मैसेज सूची को शुरू करें.
किसी otMessageQueue
इंस्टेंस के लिए, किसी दूसरे otMessageQueue
फ़ंक्शन से पहले इसे एक बार और सिर्फ़ एक बार कॉल करना ज़रूरी है. अगर अन्य API एपीआई, शुरू होने से पहले otMessageQueue
के साथ इस्तेमाल किए जाते हैं या इसे एक से ज़्यादा बार शुरू किया जाता है, तो व्यवहार की जानकारी नहीं दी जाती.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
otMessageRead
uint16_t otMessageRead( const otMessage *aMessage, uint16_t aOffset, void *aBuf, uint16_t aLength )
किसी मैसेज में बाइट पढ़ना.
ब्यौरा | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
|
||||||||
लौटाए गए सामान |
पढ़े गए बाइट की संख्या.
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageWrite
लिखें
otMessageResetBufferInfo
void otMessageResetBufferInfo( otInstance *aInstance )
संदेश बफ़र जानकारी काउंटर को एक ही समय में उपयोग किए जा रहे अधिकतम बफ़रों को ट्रैक करते हुए रीसेट करें.
इससे otBufferInfo
में mMaxUsedBuffers
रीसेट हो जाएगा.
ब्यौरा | |||
---|---|---|---|
पैरामीटर |
|
otMessageSetDirectTransmission
void otMessageSetDirectTransmission( otMessage *aMessage, bool aEnabled )
डायरेक्ट ट्रांसमिशन का इस्तेमाल करके, मैसेज को फ़ॉरवर्ड करने की सुविधा सेट करता है या उसे फ़ोर्स करता है.
नए मैसेज के लिए, डिफ़ॉल्ट सेटिंग false
है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageSetLength
otError otMessageSetLength( otMessage *aMessage, uint16_t aLength )
मैसेज की लंबाई बाइट में सेट करें.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
||||
रिटर्न वैल्यू |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
otMessageWrite
राइट
otMessageSetLoopbackToHostAllowed
void otMessageSetLoopbackToHostAllowed( otMessage *aMessage, bool aAllowLoopbackToHost )
सेट करता है कि मैसेज को वापस होस्ट पर लूप में चलाने की अनुमति है या नहीं.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageSetMulticastLoopEnabled
void otMessageSetMulticastLoopEnabled( otMessage *aMessage, bool aEnabled )
यह नीति कंट्रोल करती है कि क्या किसी मैसेज को मल्टीकास्ट डेस्टिनेशन पते के मामले में लूप बैक किया जा सकता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageSetOffset
void otMessageSetOffset( otMessage *aMessage, uint16_t aOffset )
मैसेज ऑफ़सेट को बाइट में सेट करें.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageRead
otMessageWrite
otMessageSetOrigin
void otMessageSetOrigin( otMessage *aMessage, otMessageOrigin aOrigin )
मैसेज का ऑरिजिन सेट करता है.
ब्यौरा | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otMessageWrite
int otMessageWrite( otMessage *aMessage, uint16_t aOffset, const void *aBuf, uint16_t aLength )
किसी मैसेज में बाइट लिखें.
ब्यौरा | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
|
||||||||
लौटाए गए सामान |
लिखे गए बाइट की संख्या.
|
otMessageFree
otMessageAppend
otMessageGetLength
otMessageSetLength
otMessageGetOffset
otMessageSetOffset
otMessageRead
संसाधन
OpenThread API के रेफ़रंस के विषय, सोर्स कोड से मिलते हैं. यह सोर्स GitHub पर उपलब्ध है. ज़्यादा जानकारी या हमारे दस्तावेज़ में योगदान देने के लिए, संसाधन देखें.