कॉप
इस मॉड्यूल में COAP संचार को नियंत्रित करने वाले कार्य शामिल हैं।
सारांश
CoAP API सुविधा ( OPENTHREAD_CONFIG_COAP_API_ENABLE
) सक्षम होने पर इस मॉड्यूल में कार्य उपलब्ध हैं।
टंकण | |
---|---|
otCoapBlockSzx | टंकणenum otCoapBlockSzx कोप ब्लॉक साइज एक्सपोर्टर। |
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) | टंकणotError (* यह फ़ंक्शन पॉइंटर तब कहा जाता है जब ब्लॉक-वार ट्रांसफर विकल्प के साथ एक सीओएपी संदेश प्राप्त होता है। |
otCoapBlockwiseResource | टंकणstruct otCoapBlockwiseResource यह संरचना ब्लॉक-वार हस्तांतरण के साथ एक सीओएपी संसाधन का प्रतिनिधित्व करती है। |
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) | टंकणotError (* ब्लॉक-वार हस्तांतरण में अगले ब्लॉक से पहले इस फ़ंक्शन पॉइंटर को बुलाया जाता है। |
otCoapCode | टंकणenum otCoapCode CoAP कोड मान। |
otCoapOption | टंकणstruct otCoapOption यह संरचना एक CoAP विकल्प का प्रतिनिधित्व करती है। |
otCoapOptionContentFormat | टंकण CoAP सामग्री प्रारूप कोड। |
otCoapOptionIterator | टंकणstruct otCoapOptionIterator यह संरचना CoAP विकल्पों के लिए एक पुनरावृत्त के रूप में कार्य करती है। |
otCoapOptionType | टंकणenum otCoapOptionType कोप विकल्प संख्या। |
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) | टंकणvoid(* यह फ़ंक्शन पॉइंटर तब कहा जाता है जब किसी दिए गए उरी-पथ के साथ एक सीओएपी अनुरोध प्राप्त होता है। |
otCoapResource | टंकणstruct otCoapResource यह संरचना एक CoAP संसाधन का प्रतिनिधित्व करती है। |
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) | टंकणvoid(* यह फ़ंक्शन पॉइंटर तब कहा जाता है जब एक सीओएपी प्रतिक्रिया प्राप्त होती है या अनुरोध टाइमआउट पर। |
otCoapTxParameters | टंकणstruct otCoapTxParameters यह संरचना सीओएपी ट्रांसमिशन मापदंडों का प्रतिनिधित्व करती है। |
otCoapType | टंकणenum otCoapType CoAP प्रकार मान (2 बिट अहस्ताक्षरित पूर्णांक)। |
कार्य | |
---|---|
otCoapAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource) | void यह फ़ंक्शन CoAP सर्वर के लिए ब्लॉक-वार संसाधन जोड़ता है। |
otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource) | void यह फ़ंक्शन CoAP सर्वर के लिए एक संसाधन जोड़ता है। |
otCoapBlockSizeFromExponent ( otCoapBlockSzx aSize) | uint16_t यह फ़ंक्शन एक ब्लॉक ब्लॉक विकल्प SZX फ़ील्ड को वास्तविक ब्लॉक आकार में परिवर्तित करता है। |
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize) | यह फ़ंक्शन ब्लॉक 1 विकल्प को जोड़ता है। |
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize) | यह फ़ंक्शन ब्लॉक 2 विकल्प को जोड़ता है। |
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat) | यह फ़ंक्शन https://tools.ietf.org/html/rfc7252#page-92 में निर्दिष्ट सामग्री प्रारूप CoAP विकल्प को जोड़ता है। |
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge) | यह फ़ंक्शन अधिकतम-आयु विकल्प जोड़ता है। |
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve) | यह फ़ंक्शन एक ऑब्ज़र्व विकल्प को जोड़ता है। |
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue) | यह फ़ंक्शन हेडर में CoAP विकल्प को जोड़ता है। |
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath) | यह फ़ंक्शन एक प्रॉक्सी-उरी विकल्प जोड़ता है। |
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue) | यह फ़ंक्शन https://tools.ietf.org/html/rfc7252#section-3.2 में निर्दिष्ट एक अहस्ताक्षरित पूर्णांक CoAP विकल्प को जोड़ता है। |
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath) | यह फ़ंक्शन एक Uri-Path विकल्प को जोड़ता है। |
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery) | यह फ़ंक्शन एकल उरी-क्वेरी विकल्प जोड़ता है। |
otCoapMessageCodeToString (const otMessage *aMessage) | const char * यह विधि सीओएपी कोड को मानव पठनीय स्ट्रिंग के रूप में लौटाती है। |
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength) | void यह फ़ंक्शन टोकन लंबाई निर्धारित करता है और इसके मूल्य को यादृच्छिक करता है। |
otCoapMessageGetCode (const otMessage *aMessage) | यह फ़ंक्शन कोड मान लौटाता है। |
otCoapMessageGetMessageId (const otMessage *aMessage) | uint16_t यह फ़ंक्शन संदेश ID मान लौटाता है। |
otCoapMessageGetToken (const otMessage *aMessage) | const uint8_t * यह फ़ंक्शन टोकन मान के लिए एक संकेतक लौटाता है। |
otCoapMessageGetTokenLength (const otMessage *aMessage) | uint8_t यह फ़ंक्शन टोकन लंबाई लौटाता है। |
otCoapMessageGetType (const otMessage *aMessage) | यह फ़ंक्शन टाइप मान लौटाता है। |
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode) | void यह फ़ंक्शन CoAP शीर्षलेख को प्रारंभ करता है। |
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode) | यह फ़ंक्शन प्रतिक्रिया संदेश को प्रारंभ करता है। |
otCoapMessageSetPayloadMarker ( otMessage *aMessage) | यह फ़ंक्शन Coload हेडर को पेलोड की शुरुआत का संकेत देते हुए पेलोड मार्कर जोड़ता है। |
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength) | यह फ़ंक्शन एक हेडर में टोकन मान और लंबाई निर्धारित करता है। |
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings) | यह फ़ंक्शन एक नया CoAP संदेश बनाता है। |
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator) | const otCoapOption * यह फ़ंक्शन पॉइंटर को पहले विकल्प पर लौटाता है। |
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption) | const otCoapOption * यह फ़ंक्शन निर्दिष्ट विकल्प संख्या से मेल खाने वाले पहले विकल्प के लिए एक संकेतक लौटाता है। |
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator) | const otCoapOption * यह फ़ंक्शन पॉइंटर को अगले विकल्प पर लौटाता है। |
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption) | const otCoapOption * यह फ़ंक्शन निर्दिष्ट विकल्प संख्या से मेल खाने वाले अगले विकल्प के लिए एक संकेतक लौटाता है। |
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *aValue) | यह फ़ंक्शन वर्तमान विकल्प मान को aValue में भरता है, यह मानकर कि वर्तमान मान https://tools.ietf.org/html/rfc7252#section-3.2 के अनुसार एन्कोड किया गया एक अहस्ताक्षरित पूर्णांक है। |
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue) | यह फ़ंक्शन वर्तमान विकल्प मान को aValue में aValue । |
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage) | यह फ़ंक्शन दिए गए संदेश में विकल्पों के लिए एक पुनरावृत्ति प्रारंभ करता है। |
otCoapRemoveBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource) | void यह फ़ंक्शन CoAP सर्वर से ब्लॉक-वार संसाधन को निकालता है। |
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource) | void यह फ़ंक्शन CoAP सर्वर से एक संसाधन निकालता है। |
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext) | यह फ़ंक्शन एक COAP अनुरोध भेजता है। |
otCoapSendRequestBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook) | यह फ़ंक्शन एक COAP अनुरोध ब्लॉक-वार भेजता है। |
otCoapSendRequestBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook) | यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ एक COAP अनुरोध ब्लॉक-वार भेजता है। |
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters) | यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ एक CoAP अनुरोध भेजता है। |
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo) | यह फ़ंक्शन सर्वर से CoAP प्रतिक्रिया भेजता है। |
otCoapSendResponseBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook) | यह फ़ंक्शन सर्वर से एक COAP प्रतिक्रिया ब्लॉक-वार भेजता है। |
otCoapSendResponseBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook) | यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ सर्वर से एक COAP प्रतिक्रिया ब्लॉक-वार भेजता है। |
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters) | यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ सर्वर से एक सीओएपी प्रतिक्रिया भेजता है। |
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext) | void यह फ़ंक्शन अनचाहे CoAP अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है। |
otCoapStart ( otInstance *aInstance, uint16_t aPort) | यह फ़ंक्शन CoAP सर्वर शुरू करता है। |
otCoapStop ( otInstance *aInstance) | यह फ़ंक्शन CoAP सर्वर को रोकता है। |
संरचनाएं | |
---|---|
otCoapBlockwiseResource | यह संरचना ब्लॉक-वार हस्तांतरण के साथ एक CoAP संसाधन का प्रतिनिधित्व करती है। |
ओटापोशन | यह संरचना एक CoAP विकल्प का प्रतिनिधित्व करती है। |
otCoapOptionIterator | यह संरचना CoAP विकल्पों के लिए एक पुनरावृत्त के रूप में कार्य करती है। |
otCoapResource | यह संरचना एक CoAP संसाधन का प्रतिनिधित्व करती है। |
otCoapTxParameters | यह संरचना सीओएपी ट्रांसमिशन मापदंडों का प्रतिनिधित्व करती है। |
गणना
otCoapBlockSzx
otCoapBlockSzx
कोप ब्लॉक साइज एक्सपोर्टर।
otCoapCode
otCoapCode
CoAP कोड मान।
otCoapOptionContentFormat
otCoapOptionContentFormat
CoAP सामग्री प्रारूप कोड।
पूरी सूची https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats पर प्रलेखित है
otCoapOptionType
otCoapOptionType
कोप विकल्प संख्या।
otCoapType
otCoapType
टंकण
otCoapBlockwiseReceiveHook
otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)
यह फ़ंक्शन पॉइंटर तब कहा जाता है जब ब्लॉक-वार ट्रांसफर विकल्प के साथ एक सीओएपी संदेश प्राप्त होता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
विवरण | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||||
वापसी मान |
|
otCoapBlockwiseResource
struct otCoapBlockwiseResource otCoapBlockwiseResource
यह संरचना ब्लॉक-वार हस्तांतरण के साथ एक सीओएपी संसाधन का प्रतिनिधित्व करती है।
otCoapBlockwiseTransmitHook
otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)
ब्लॉक-वार हस्तांतरण में अगले ब्लॉक से पहले इस फ़ंक्शन पॉइंटर को बुलाया जाता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
ऑब्लॉक वेल्थ के मान को बदलकर, पूरे एक्सचेंज के ब्लॉक आकार को फिर से जोड़ा जाता है। पहले ब्लॉक प्राप्त होने के बाद ऐसा करने की सिफारिश की गई है क्योंकि बाद में बदलाव अन्य सीओएपी कार्यान्वयन के साथ समस्याएं पैदा कर सकते हैं।
विवरण | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||
वापसी मान |
|
otCoapOptionContentFormat
0 बी 217 सी 1 एफ 50CoAP सामग्री प्रारूप कोड।
पूरी सूची https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats पर प्रलेखित है
otCoapOptionIterator
struct otCoapOptionIterator otCoapOptionIterator
यह संरचना CoAP विकल्पों के लिए एक पुनरावृत्त के रूप में कार्य करती है।
otCoapRequestHandler
void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
यह फ़ंक्शन पॉइंटर तब कहा जाता है जब किसी दिए गए उरी-पथ के साथ एक सीओएपी अनुरोध प्राप्त होता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
|
otCoapResource
struct otCoapResource otCoapResource
यह संरचना एक CoAP संसाधन का प्रतिनिधित्व करती है।
otCoapResponseHandler
void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)
यह फ़ंक्शन पॉइंटर तब कहा जाता है जब एक सीओएपी प्रतिक्रिया प्राप्त होती है या अनुरोध टाइमआउट पर।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapTxParameters
struct otCoapTxParameters otCoapTxParameters
यह संरचना सीओएपी ट्रांसमिशन मापदंडों का प्रतिनिधित्व करती है।
कार्य
otCoapAddBlock KindResource
void otCoapAddBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
यह फ़ंक्शन CoAP सर्वर के लिए ब्लॉक-वार संसाधन जोड़ता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otCoapAddResource
void otCoapAddResource( otInstance *aInstance, otCoapResource *aResource )
यह फ़ंक्शन CoAP सर्वर के लिए एक संसाधन जोड़ता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otCoapBlockSizeFromExponent
uint16_t otCoapBlockSizeFromExponent( otCoapBlockSzx aSize )
यह फ़ंक्शन एक ब्लॉक ब्लॉक विकल्प SZX फ़ील्ड को वास्तविक ब्लॉक आकार में परिवर्तित करता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | वास्तविक आकार घातांक मान। |
otCoapMessageAppendBlock1Option
otError otCoapMessageAppendBlock1Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
यह फ़ंक्शन ब्लॉक 1 विकल्प को जोड़ता है।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapMessageAppendBlock2Option
otError otCoapMessageAppendBlock2Option( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize )
यह फ़ंक्शन ब्लॉक 2 विकल्प को जोड़ता है।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapMessageAppendContentFormatOption
otError otCoapMessageAppendContentFormatOption( otMessage *aMessage, otCoapOptionContentFormat aContentFormat )
यह फ़ंक्शन https://tools.ietf.org/html/rfc7252#page-92 में निर्दिष्ट सामग्री प्रारूप CoAP विकल्प को जोड़ता है।
यदि संदेश में कोई पेलोड शामिल किया जाना है, तो otCoapMessageSetPayloadMarker सेट करने से पहले इसे कॉल किया जाना चाहिए।
फ़ंक्शन otCoapMessageAppendUintOption के आसपास एक सुविधा आवरण है, और यदि वांछित प्रारूप प्रकार कोड otCoapOptionContentFormat में सूचीबद्ध नहीं है, तो इस आधार फ़ंक्शन का उपयोग किया जाना चाहिए।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendMaxAgeOption
otError otCoapMessageAppendMaxAgeOption( otMessage *aMessage, uint32_t aMaxAge )
यह फ़ंक्शन अधिकतम-आयु विकल्प जोड़ता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendOberveOption
otError otCoapMessageAppendObserveOption( otMessage *aMessage, uint32_t aObserve )
यह फ़ंक्शन एक ऑब्ज़र्व विकल्प को जोड़ता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendOption
otError otCoapMessageAppendOption( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue )
यह फ़ंक्शन हेडर में CoAP विकल्प को जोड़ता है।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapMessageAppendProxyUriOption
otError otCoapMessageAppendProxyUriOption( otMessage *aMessage, const char *aUriPath )
यह फ़ंक्शन एक प्रॉक्सी-उरी विकल्प जोड़ता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendUintOption
otError otCoapMessageAppendUintOption( otMessage *aMessage, uint16_t aNumber, uint32_t aValue )है
यह फ़ंक्शन https://tools.ietf.org/html/rfc7252#section-3.2 में निर्दिष्ट एक अहस्ताक्षरित पूर्णांक CoAP विकल्प देता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageGetOptionUintValue
otCoapMessageAppendUriPathOptions
otError otCoapMessageAppendUriPathOptions( otMessage *aMessage, const char *aUriPath )
यह फ़ंक्शन एक Uri-Path विकल्प को जोड़ता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendUriQueryOption
otError otCoapMessageAppendUriQueryOption( otMessage *aMessage, const char *aUriQuery )
यह फ़ंक्शन एकल उरी-क्वेरी विकल्प जोड़ता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageCodeToString
const char * otCoapMessageCodeToString( const otMessage *aMessage )
यह विधि सीओएपी कोड को मानव पठनीय स्ट्रिंग के रूप में लौटाती है।
@ कोड को स्ट्रिंग के रूप में लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
|
otCoapMessageGenerateToken
void otCoapMessageGenerateToken( otMessage *aMessage, uint8_t aTokenLength )
यह फ़ंक्शन टोकन लंबाई निर्धारित करता है और इसके मूल्य को यादृच्छिक करता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otCoapMessageGetCode
otCoapCode otCoapMessageGetCode( const otMessage *aMessage )
यह फ़ंक्शन कोड मान लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | कोड मान। |
otCoapMessageGetMessageId
uint16_t otCoapMessageGetMessageId( const otMessage *aMessage )
यह फ़ंक्शन संदेश ID मान लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | संदेश ID मान। |
otCoapMessageGetToken
const uint8_t * otCoapMessageGetToken( const otMessage *aMessage )
यह फ़ंक्शन टोकन मान के लिए एक संकेतक लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | टोकन मान के लिए एक सूचक। |
otCoapMessageGetTokenLength
uint8_t otCoapMessageGetTokenLength( const otMessage *aMessage )
यह फ़ंक्शन टोकन लंबाई लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | टोकन की लंबाई। |
otCoapMessageGetType
otCoapType otCoapMessageGetType( const otMessage *aMessage )
यह फ़ंक्शन टाइप मान लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | प्रकार मान। |
otCoapMessageInit
void otCoapMessageInit( otMessage *aMessage, otCoapType aType, otCoapCode aCode )
यह फ़ंक्शन CoAP शीर्षलेख को प्रारंभ करता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
|
otCoapMessageInitResponse
otError otCoapMessageInitResponse( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode )
यह फ़ंक्शन प्रतिक्रिया संदेश को प्रारंभ करता है।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapMessageSetPayloadMarker
otError otCoapMessageSetPayloadMarker( otMessage *aMessage )
यह फ़ंक्शन पेलोड मार्कर को CoAP हेडर को पेलोड की शुरुआत का संकेत देता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
वापसी मान |
|
otCoapMessageSetToken
otError otCoapMessageSetToken( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength )
यह फ़ंक्शन एक हेडर में टोकन मान और लंबाई निर्धारित करता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapNewMessage
otMessage * otCoapNewMessage( otInstance *aInstance, const otMessageSettings *aSettings )
यह फ़ंक्शन एक नया CoAP संदेश बनाता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
लौटता है | संदेश बफ़र या NULL के लिए कोई पॉइंटर यदि कोई संदेश बफ़र उपलब्ध नहीं है या पैरामीटर अमान्य हैं। |
otCoapOptionIteratorGetFirstOption
const otCoapOption * otCoapOptionIteratorGetFirstOption( otCoapOptionIterator *aIterator )
यह फ़ंक्शन पॉइंटर को पहले विकल्प पर लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | पहले विकल्प के लिए एक सूचक। यदि कोई विकल्प मौजूद नहीं है तो NULL पॉइंटर लौटाया जाता है। |
otCoapOptionIteratorGetFirstOptionMatching
const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
यह फ़ंक्शन निर्दिष्ट विकल्प संख्या से मेल खाने वाले पहले विकल्प के लिए एक पॉइंटर लौटाता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
लौटता है | पहला मिलान विकल्प के लिए एक सूचक। यदि कोई मिलान विकल्प मौजूद नहीं है तो NULL पॉइंटर लौटाया जाता है। |
otCoapOptionIteratorGetNextOption
const otCoapOption * otCoapOptionIteratorGetNextOption( otCoapOptionIterator *aIterator )
यह फ़ंक्शन पॉइंटर को अगले विकल्प पर लौटाता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
लौटता है | अगले विकल्प के लिए एक सूचक। यदि कोई और विकल्प मौजूद नहीं है तो NULL पॉइंटर लौटाया जाता है। |
otCoapOptionIteratorGetNextOptionMatching
const otCoapOption * otCoapOptionIteratorGetNextOptionMatching( otCoapOptionIterator *aIterator, uint16_t aOption )
यह फ़ंक्शन निर्दिष्ट विकल्प संख्या से मेल खाने वाले अगले विकल्प के लिए एक संकेतक लौटाता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
लौटता है | अगले मिलान विकल्प के लिए एक सूचक। यदि कोई और मिलान विकल्प मौजूद नहीं है तो NULL पॉइंटर लौटाया जाता है। |
otCoapOptionIteratorGetOptionUintValue
otError otCoapOptionIteratorGetOptionUintValue( otCoapOptionIterator *aIterator, uint64_t *aValue )
यह फ़ंक्शन वर्तमान विकल्प मान को aValue
में भरता है, यह मानकर कि वर्तमान मान https://tools.ietf.org/html/rfc7252#section-3.2 के अनुसार एन्कोड किया गया एक अहस्ताक्षरित पूर्णांक है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapMessageAppendUintOption
otCoapOptionIteratorGetOptionValue
05 बी 517 ई 840 यह फ़ंक्शन वर्तमान विकल्प मान को aValue
में aValue
।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
वापसी मान |
|
otCoapOptionIteratorInit
otError otCoapOptionIteratorInit( otCoapOptionIterator *aIterator, const otMessage *aMessage )
यह फ़ंक्शन दिए गए संदेश में विकल्पों के लिए एक पुनरावृत्ति प्रारंभ करता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
वापसी मान |
|
otCoapRemoveBlock KindResource
void otCoapRemoveBlockWiseResource( otInstance *aInstance, otCoapBlockwiseResource *aResource )
यह फ़ंक्शन CoAP सर्वर से ब्लॉक-वार संसाधन को निकालता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otCoapRemoveResource
void otCoapRemoveResource( otInstance *aInstance, otCoapResource *aResource )
यह फ़ंक्शन CoAP सर्वर से एक संसाधन निकालता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
|
otCoapSendRequest
otError otCoapSendRequest( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext )
यह फ़ंक्शन एक COAP अनुरोध भेजता है।
यदि किसी अनुरोध की प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए।
विवरण | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||
वापसी मान |
|
otCoapSendRequestBlock Kind
otError otCoapSendRequestBlockWise( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
यह फ़ंक्शन एक COAP अनुरोध ब्लॉक-वार भेजता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
यदि किसी अनुरोध की प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि प्रतिक्रिया ब्लॉक-वार होने की उम्मीद है, तो एक संबंधित हुक फ़ंक्शन प्रदान किया जाना चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए।
विवरण | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||||||
वापसी मान |
|
otCoapSendRequestBlock KindWithParameters
otError otCoapSendRequestBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook )
यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ एक COAP अनुरोध ब्लॉक-वार भेजता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
यदि किसी अनुरोध की प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि प्रतिक्रिया ब्लॉक-वार होने की उम्मीद है, तो एक संबंधित हुक फ़ंक्शन प्रदान किया जाना चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए।
विवरण | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||||||||
वापसी मान |
|
otCoapSendRequestWithParameters
otError otCoapSendRequestWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters )
यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ एक CoAP अनुरोध भेजता है।
यदि किसी अनुरोध की प्रतिक्रिया अपेक्षित है, तो संबंधित फ़ंक्शन और संदर्भ जानकारी प्रदान की जानी चाहिए। यदि कोई प्रतिक्रिया अपेक्षित नहीं है, तो ये तर्क NULL संकेतकर्ता होने चाहिए।
विवरण | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||||
वापसी मान |
|
otCoapSendResponse
otError otCoapSendResponse( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo )
यह फ़ंक्शन सर्वर से CoAP प्रतिक्रिया भेजता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||
वापसी मान |
|
otCoapSendResponseBlock Kind
07bd1616यह फ़ंक्शन सर्वर से एक COAP प्रतिक्रिया ब्लॉक-वार भेजता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
विवरण | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||
वापसी मान |
|
otCoapSendResponseBlock KindWithParameters
otError otCoapSendResponseBlockWiseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook )
यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ सर्वर से एक COAP प्रतिक्रिया ब्लॉक-वार भेजता है।
यह फ़ंक्शन उपलब्ध है जब OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE कॉन्फ़िगरेशन सक्षम है।
विवरण | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||||||
वापसी मान |
|
otCoapSendResponseWithParameters
otError otCoapSendResponseWithParameters( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters )
यह फ़ंक्शन कस्टम ट्रांसमिशन मापदंडों के साथ सर्वर से एक सीओएपी प्रतिक्रिया भेजता है।
विवरण | |||||||||
---|---|---|---|---|---|---|---|---|---|
पैरामीटर |
| ||||||||
वापसी मान |
|
otCoapSetDefaultHandler
void otCoapSetDefaultHandler( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext )
यह फ़ंक्शन अनचाहे CoAP अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है।
विवरण | |||||||
---|---|---|---|---|---|---|---|
पैरामीटर |
|
otCoapStart
otError otCoapStart( otInstance *aInstance, uint16_t aPort )
यह फ़ंक्शन CoAP सर्वर शुरू करता है।
विवरण | |||||
---|---|---|---|---|---|
पैरामीटर |
| ||||
वापसी मान |
|
otCoapStop
otError otCoapStop( otInstance *aInstance )
यह फ़ंक्शन CoAP सर्वर को रोकता है।
विवरण | |||
---|---|---|---|
पैरामीटर |
| ||
वापसी मान |
|
मैक्रों
OT_COAP_CODE
OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))
कूपर कोड मूल्यों को परिभाषित करने के लिए हेल्पर मैक्रो।
OT_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_DEFAULT_TOKEN_LENGTH 2
डिफ़ॉल्ट टोकन लंबाई।
OT_COAP_MAX_RETRANSMIT
OT_COAP_MAX_RETRANSMIT 20
मैक्स रिट्रांसमिट OpenThread द्वारा समर्थित है।
OT_COAP_MAX_TOKEN_LENGTH
OT_COAP_MAX_TOKEN_LENGTH 8
निर्दिष्ट के रूप में अधिकतम टोकन लंबाई (आरएफसी 7252)।
OT_COAP_MIN_ACK_TIMEOUT
OT_COAP_MIN_ACK_TIMEOUT 1000
OpenThread द्वारा समर्थित मिलीसेकंड में न्यूनतम ACK टाइमआउट।
OT_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_PORT 5683
डिफ़ॉल्ट CoAP पोर्ट, जैसा कि RFC 7252 में निर्दिष्ट है।