सीओएपी

इस मॉड्यूल में वे फ़ंक्शन शामिल हैं जो CoAP कम्यूनिकेशन को कंट्रोल करते हैं.

खास जानकारी

CoAP API सुविधा (OPENTHREAD_CONFIG_COAP_API_ENABLE) के चालू होने पर, इस मॉड्यूल में मौजूद फ़ंक्शन उपलब्ध होते हैं.

गिनती
otCoapBlockSzx enum
CoAP ब्लॉक के साइज़ के एक्सपोनेंट.
otCoapCode{
  OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
  OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
  OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
  OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
  OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
  OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
  OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
} 		enum
CoAP कोड की वैल्यू.
otCoapOptionContentFormat{
  OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
  OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
  OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
  OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
  OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
  OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
  OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
  OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
  OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
} 		enum
CoAP कॉन्टेंट फ़ॉर्मैट के कोड.
otCoapOptionType{
  OT_COAP_OPTION_IF_MATCH = 1,
  OT_COAP_OPTION_URI_HOST = 3,
  OT_COAP_OPTION_E_TAG = 4,
  OT_COAP_OPTION_IF_NONE_MATCH = 5,
  OT_COAP_OPTION_OBSERVE = 6,
  OT_COAP_OPTION_URI_PORT = 7,
  OT_COAP_OPTION_LOCATION_PATH = 8,
  OT_COAP_OPTION_URI_PATH = 11,
  OT_COAP_OPTION_CONTENT_FORMAT = 12,
  OT_COAP_OPTION_MAX_AGE = 14,
  OT_COAP_OPTION_URI_QUERY = 15,
  OT_COAP_OPTION_ACCEPT = 17,
  OT_COAP_OPTION_LOCATION_QUERY = 20,
  OT_COAP_OPTION_BLOCK2 = 23,
  OT_COAP_OPTION_BLOCK1 = 27,
  OT_COAP_OPTION_SIZE2 = 28,
  OT_COAP_OPTION_PROXY_URI = 35,
  OT_COAP_OPTION_PROXY_SCHEME = 39,
  OT_COAP_OPTION_SIZE1 = 60
} 		enum
CoAP के लिए विकल्प की संख्या.
otCoapType{
  OT_COAP_TYPE_CONFIRMABLE = 0,
  OT_COAP_TYPE_NON_CONFIRMABLE = 1,
  OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
  OT_COAP_TYPE_RESET = 3
} 		enum
CoAP टाइप की वैल्यू (साइन नहीं किया गया दो बिट वाला पूर्णांक).

टाइपडीफ़
otCoapBlockSzx टाइपडिफ़
CoAP ब्लॉक के साइज़ के एक्सपोनेंट.
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) टाइपडिफ़
जब CoAP से, ब्लॉक के मुताबिक ट्रांसफ़र करने का विकल्प मिलता है, तो पॉइंटर को कॉल किया जाता है.
otCoapBlockwiseResource टाइपडिफ़
ब्लॉक के हिसाब से ट्रांसफ़र की सुविधा वाले CoAP संसाधन के बारे में.
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) टाइपडिफ़
ब्लॉक के मुताबिक ट्रांसफ़र में अगला ब्लॉक भेजे जाने से पहले, पॉइंटर को कॉल किया जाता है.
otCoapCode टाइपडिफ़
enum otCoapCode
CoAP कोड की वैल्यू.
otCoapOption टाइपडिफ़
struct otCoapOption
यह CoAP का विकल्प है.
otCoapOptionContentFormat टाइपडिफ़
CoAP कॉन्टेंट फ़ॉर्मैट के कोड.
otCoapOptionIterator टाइपडिफ़
यह CoAP के विकल्पों के लिए, इटरेटर के तौर पर काम करता है.
otCoapOptionType टाइपडिफ़
CoAP के लिए विकल्प की संख्या.
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) टाइपडिफ़
void(*
जब किसी Uri-पाथ के साथ सीओएपी से अनुरोध किया जाता है, तो पॉइंटर को कहा जाता है.
otCoapResource टाइपडिफ़
यहां CoAP के संसाधन का इस्तेमाल किया जाता है.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) टाइपडिफ़
void(*
सीओएपी से जवाब मिलने या अनुरोध के टाइम आउट होने पर, पॉइंटर को कॉल किया जाता है.
otCoapTxParameters टाइपडिफ़
यह सीओएपी ट्रांसमिशन पैरामीटर के बारे में बताता है.
otCoapType टाइपडिफ़
enum otCoapType
CoAP टाइप की वैल्यू (साइन नहीं किया गया दो बिट वाला पूर्णांक).

फ़ंक्शन
otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
CoAP सर्वर में, ब्लॉक के मुताबिक संसाधन जोड़ता है.
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
void
CoAP सर्वर में कोई संसाधन जोड़ता है.
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
uint16_t
CoAP ब्लॉक के विकल्प SZX फ़ील्ड को ब्लॉक के असल साइज़ में बदलता है.
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Block1 विकल्प जोड़ता है.
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
ब्लॉक 2 का विकल्प जोड़ता है.
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
https://tools.ietf.org/html/fc7252#page-92 में बताए गए तरीके से, कॉन्टेंट फ़ॉर्मैट सीओएपी का विकल्प जोड़ता है.
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/fc7252#section-3.2 में बताया गया, बिना साइन वाले पूर्णांक सीओएपी का विकल्प जोड़ता है.
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
Uri-पाथ का विकल्प जोड़ता है.
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
एक Uri-Query विकल्प जोड़ता है.
otCoapMessageCodeToString(const otMessage *aMessage)
const char *
यह CoAP कोड को ऐसी स्ट्रिंग के तौर पर दिखाता है जिसे इंसान पढ़ सकता है.
otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)
void
टोकन की लंबाई सेट करता है और उसकी वैल्यू किसी भी क्रम में लगाता है.
otCoapMessageGetCode(const otMessage *aMessage)
कोड वैल्यू दिखाता है.
otCoapMessageGetMessageId(const otMessage *aMessage)
uint16_t
मैसेज आईडी की वैल्यू दिखाता है.
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)
जवाब का मैसेज शुरू करता है.
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
void
कोड की वैल्यू सेट करता है.
otCoapMessageSetPayloadMarker(otMessage *aMessage)
CoAP हेडर पर पेलोड की शुरुआत को दिखाने वाला पेलोड मार्कर जोड़ता है.
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 में भरता है.
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)
सीओएपी से जुड़ा अनुरोध भेजता है.
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)
यह कस्टम ट्रांसमिशन पैरामीटर के साथ सर्वर से CoAP जवाब भेजता है.
otCoapSetDefaultHandler(otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
यह, हैंडल नहीं किए गए CoAP अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है.
otCoapStart(otInstance *aInstance, uint16_t aPort)
CoAP सर्वर चालू करता है.
otCoapStop(otInstance *aInstance)
CoAP सर्वर को रोकता है.

स्ट्रक्चर
otCoapBlockwiseResource

ब्लॉक के हिसाब से ट्रांसफ़र की सुविधा वाले CoAP संसाधन के बारे में.

otCoapOption

यह CoAP का विकल्प है.

otCoapOptionIterator

यह CoAP के विकल्पों के लिए, इटरेटर के तौर पर काम करता है.

otCoapResource

यहां CoAP के संसाधन का इस्तेमाल किया जाता है.

otCoapTxपैरामीटर

यह सीओएपी ट्रांसमिशन पैरामीटर के बारे में बताता है.

गिनती

otCoapblockSzx 

 otCoapBlockSzx

CoAP ब्लॉक के साइज़ के एक्सपोनेंट.

otCoapकोड

 otCoapCode

CoAP कोड की वैल्यू.

प्रॉपर्टी
OT_COAP_CODE_BAD_GATEWAY

खराब गेटवे.

OT_COAP_CODE_BAD_OPTION

खराब विकल्प.

OT_COAP_CODE_BAD_REQUEST

गलत अनुरोध.

OT_COAP_CODE_CHANGED

बदला गया.

OT_COAP_CODE_CONTENT

सामग्री.

OT_COAP_CODE_CONTINUE

RFC7959 जारी रखें.

OT_COAP_CODE_CREATED

बनाया गया.

OT_COAP_CODE_DELETE

मिटाएं पर टैप करें.

OT_COAP_CODE_DELETED

इतिहास मिटाया गया.

OT_COAP_CODE_EMPTY

कोई मैसेज कोड नहीं दिया गया है.

OT_COAP_CODE_FORBIDDEN

आपके पास यह मैसेज देखने की मंज़ूरी नहीं है.

OT_COAP_CODE_GATEWAY_TIMEOUT

गेटवे का समय खत्म हो गया.

OT_COAP_CODE_GET

डाउनलोड करें.

OT_COAP_CODE_INTERNAL_ERROR

आंतरिक सर्वर त्रुटि.

OT_COAP_CODE_METHOD_NOT_ALLOWED

तरीके की अनुमति नहीं है.

OT_COAP_CODE_NOT_ACCEPTABLE

मान्य नहीं है.

OT_COAP_CODE_NOT_FOUND

नहीं मिला.

OT_COAP_CODE_NOT_IMPLEMENTED

लागू नहीं किया गया.

OT_COAP_CODE_POST

पोस्ट पर टैप करें.

OT_COAP_CODE_PRECONDITION_FAILED

पहले से तय शर्त पूरी नहीं की जा सकी.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

प्रॉक्सी करने की सुविधा काम नहीं करती.

OT_COAP_CODE_PUT

रखें.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 के लिए, अनुरोध की गई इकाई पूरी नहीं हुई.

OT_COAP_CODE_REQUEST_TOO_LARGE

अनुरोध की गई इकाई बहुत बड़ी है.

OT_COAP_CODE_RESPONSE_MIN

2.00

OT_COAP_CODE_SERVICE_UNAVAILABLE

सेवा उपलब्ध नहीं है.

OT_COAP_CODE_UNAUTHORIZED

अनधिकृत.

OT_COAP_CODE_UNSUPPORTED_FORMAT

असमर्थित सामग्री-फ़ॉर्मैट.

OT_COAP_CODE_VALID

मान्य.

otCoapOptionContentFormat

 otCoapOptionContentFormat

CoAP कॉन्टेंट फ़ॉर्मैट के कोड.

पूरी सूची https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats पर दी गई है

प्रॉपर्टी
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

ऐप्लिकेशन/cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

ऐप्लिकेशन/coap-group+json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

ऐप्लिकेशन/cose; cose-type="cose-Encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

ऐप्लिकेशन/cose; cose-type="cose-Encrypt0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

ऐप्लिकेशन/कोसे-की: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

ऐप्लिकेशन/cose-key-set: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

ऐप्लिकेशन/cose; cose-type="cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

ऐप्लिकेशन/cose; cose-type="cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

ऐप्लिकेशन/cose; cose-type="cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

ऐप्लिकेशन/cose; cose-type="cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

ऐप्लिकेशन/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

ऐप्लिकेशन/exi: ["बेहतर एक्सएमएल इंटरचेंज (EXI) फ़ॉर्मैट 1.0 (दूसरा वर्शन)", फ़रवरी 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

ऐप्लिकेशन/json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

ऐप्लिकेशन/json-patch+json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

ऐप्लिकेशन/लिंक-फ़ॉर्मैट: [RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

ऐप्लिकेशन/मर्ज-पैच+json: [RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

ऐप्लिकेशन/ऑक्टेट-स्ट्रीम: [RFC2045][RFC2046]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR

ऐप्लिकेशन/senml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

ऐप्लिकेशन/senml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

ऐप्लिकेशन/senml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

ऐप्लिकेशन/senml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR

ऐप्लिकेशन/sensml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI

ऐप्लिकेशन/sensml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON

ऐप्लिकेशन/sensml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML

ऐप्लिकेशन/sensml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN

टेक्स्ट/सादा; charset=utf-8: [RFC2046][RFC3676][RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

ऐप्लिकेशन/xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

CoAP के लिए विकल्प की संख्या.

प्रॉपर्टी
OT_COAP_OPTION_ACCEPT

स्वीकार करें.

OT_COAP_OPTION_BLOCK1

ब्लॉक1 (RFC7959)

OT_COAP_OPTION_BLOCK2

ब्लॉक2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

कॉन्टेंट का फ़ॉर्मैट.

OT_COAP_OPTION_E_TAG

ईटैग.

OT_COAP_OPTION_IF_MATCH

अगर-मैच करता है.

OT_COAP_OPTION_IF_NONE_MATCH

अगर कोई मैच नहीं है.

OT_COAP_OPTION_LOCATION_PATH

लोकेशन-पाथ.

OT_COAP_OPTION_LOCATION_QUERY

जगह की जानकारी से जुड़ी क्वेरी.

OT_COAP_OPTION_MAX_AGE

ज़्यादा से ज़्यादा उम्र.

OT_COAP_OPTION_OBSERVE

[RFC7641] को देखें.

OT_COAP_OPTION_PROXY_SCHEME

प्रॉक्सी-स्कीम.

OT_COAP_OPTION_PROXY_URI

प्रॉक्सी-यूरी.

OT_COAP_OPTION_SIZE1

साइज़ 1.

OT_COAP_OPTION_SIZE2

आकार 2 (RFC7959)

OT_COAP_OPTION_URI_HOST

यूआरआई-होस्ट.

OT_COAP_OPTION_URI_PATH

उरी-पाथ.

OT_COAP_OPTION_URI_PORT

उरी-पोर्ट.

OT_COAP_OPTION_URI_QUERY

Uri-Query.

otCoapType

 otCoapType

CoAP टाइप की वैल्यू (साइन नहीं किया गया दो बिट वाला पूर्णांक).

प्रॉपर्टी
OT_COAP_TYPE_ACKNOWLEDGMENT

धन्यवाद.

OT_COAP_TYPE_CONFIRMABLE

पुष्टि की जा सकती है.

OT_COAP_TYPE_NON_CONFIRMABLE

पुष्टि न की जा सकती है.

OT_COAP_TYPE_RESET

रीसेट पर टैप करें.

टाइपडीफ़

otCoapblockSzx 

enum otCoapBlockSzx otCoapBlockSzx

CoAP ब्लॉक के साइज़ के एक्सपोनेंट.

otCoapBlockwiseReceiveHook

otError(* otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)

जब CoAP से, ब्लॉक के मुताबिक ट्रांसफ़र करने का विकल्प मिलता है, तो पॉइंटर को कॉल किया जाता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

जानकारी
पैरामीटर
[in] aContext
ऐप्लिकेशन के हिसाब से संदर्भ के लिए पॉइंटर.
[in] aBlock
'ब्लॉक करें' सेगमेंट के लिए पॉइंटर.
[in] aPosition
बाइट में, किसी क्रम में aBlock की रैंक.
[in] aBlockLength
ब्लॉक सेगमेंट की लंबाई बाइट में.
[in] aMore
अगर ब्लॉक किए गए और सेगमेंट फ़ॉलो किए जा रहे हैं, तो फ़्लैग करें.
[in] aTotalLength
ट्रांसफ़र की गई जानकारी की कुल लंबाई बाइट में (साइज़1 या साइज़2 विकल्प से दिखाई जाती है).
रिटर्न वैल्यू
OT_ERROR_NONE
ब्लॉक सेगमेंट सेव किया गया.
OT_ERROR_NO_BUFS
ब्लॉक सेव करने के लिए अब कोई मेमोरी नहीं.
OT_ERROR_NO_FRAME_RECEIVED
ब्लॉक सेगमेंट मौजूद नहीं है.

otCoapBlockwiseसंसाधन

struct otCoapBlockwiseResource otCoapBlockwiseResource

ब्लॉक के हिसाब से ट्रांसफ़र की सुविधा वाले CoAP संसाधन के बारे में.

otCoapBlockwiseट्रांसमिटहुक

otError(* otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore)

ब्लॉक के मुताबिक ट्रांसफ़र में अगला ब्लॉक भेजे जाने से पहले, पॉइंटर को कॉल किया जाता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

aBlockLength का मान बदलने पर, पूरे एक्सचेंज के ब्लॉक का साइज़ फिर से तय हो जाता है. आपको पहला ब्लॉक मिलने के बाद ऐसा करने का सुझाव दिया जाता है, क्योंकि बाद में किए गए बदलावों की वजह से, अन्य CoAP लागू करने में समस्याएं आ सकती हैं.

जानकारी
पैरामीटर
[in] aContext
ऐप्लिकेशन के हिसाब से संदर्भ के लिए पॉइंटर.
[in,out] aBlock
वह पॉइंटर जहां ब्लॉक सेगमेंट लिखा जा सकता है.
[in] aPosition
क्रम में वह जगह जहां से ब्लॉक सेगमेंट पाना है.
[in,out] aBlockLength
एंट्री करने पर, ब्लॉक सेगमेंट की ज़्यादा से ज़्यादा लंबाई बाइट में होती है.
[out] aMore
अगर ऐसे और भी सेगमेंट आते हैं, तो फ़्लैग का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
कोई गड़बड़ी नहीं हुई.
OT_ERROR_INVALID_ARGS
aPosition पर ब्लॉक करने की सुविधा मौजूद नहीं है.

otCoapकोड

enum otCoapCode otCoapCode

CoAP कोड की वैल्यू.

otCoapOption

struct otCoapOption otCoapOption

यह CoAP का विकल्प है.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

CoAP कॉन्टेंट फ़ॉर्मैट के कोड.

पूरी सूची https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats पर दी गई है

otCoapOptionIterator ऐप्लिकेशन

struct otCoapOptionIterator otCoapOptionIterator

यह CoAP के विकल्पों के लिए, इटरेटर के तौर पर काम करता है.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

CoAP के लिए विकल्प की संख्या.

otCoapRequestHandler

void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

जब किसी Uri-पाथ के साथ सीओएपी से अनुरोध किया जाता है, तो पॉइंटर को कहा जाता है.

जानकारी
पैरामीटर
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर.
[in] aMessage
मैसेज का पॉइंटर.
[in] aMessageInfo
aMessage के लिए मैसेज की जानकारी का पॉइंटर.

otCoapसंसाधन

struct otCoapResource otCoapResource

यहां CoAP के संसाधन का इस्तेमाल किया जाता है.

otCoapResponseHandler

void(* otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult)

सीओएपी से जवाब मिलने या अनुरोध के टाइम आउट होने पर, पॉइंटर को कॉल किया जाता है.

जानकारी
पैरामीटर
[in] aContext
ऐप्लिकेशन के हिसाब से संदर्भ के लिए पॉइंटर.
[in] aMessage
जवाब वाले मैसेज बफ़र का पॉइंटर. कोई जवाब न मिलने पर शून्य.
[in] aMessageInfo
aMessage के लिए मैसेज की जानकारी का पॉइंटर. कोई जवाब न मिलने पर शून्य.
[in] aResult
यह CoAP से हुए लेन-देन की वजह से है.
रिटर्न वैल्यू
OT_ERROR_NONE
जवाब मिल गया है.
OT_ERROR_ABORT
CoAP से जुड़ा कोई लेन-देन, सहकर्मी ने रीसेट किया है.
OT_ERROR_RESPONSE_TIMEOUT
टाइम आउट के दौरान, कोई जवाब या स्वीकार नहीं किया गया.

otCoapTxपैरामीटर

struct otCoapTxParameters otCoapTxParameters

यह सीओएपी ट्रांसमिशन पैरामीटर के बारे में बताता है.

otCoapType

enum otCoapType otCoapType

CoAP टाइप की वैल्यू (साइन नहीं किया गया दो बिट वाला पूर्णांक).

फ़ंक्शन

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

CoAP सर्वर में, ब्लॉक के मुताबिक संसाधन जोड़ता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aResource
संसाधन के लिए पॉइंटर.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

CoAP सर्वर में कोई संसाधन जोड़ता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aResource
संसाधन के लिए पॉइंटर.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

CoAP ब्लॉक के विकल्प SZX फ़ील्ड को ब्लॉक के असल साइज़ में बदलता है.

जानकारी
पैरामीटर
[in] aSize
ब्लॉक साइज़ घातांक.
लौटाए गए सामान
वास्तविक आकार का घातांक मान.

otCoapMessageAppendBlock1Option

otError otCoapMessageAppendBlock1Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

Block1 विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aNum
मौजूदा ब्लॉक नंबर.
[in] aMore
बूलियन यह संकेत देता है कि और ब्लॉक भेजे जाने हैं.
[in] aSize
ब्लॉक साइज़ एक्सपोनेंट.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendBlock2Option

otError otCoapMessageAppendBlock2Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSzx aSize
)

ब्लॉक 2 का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aNum
मौजूदा ब्लॉक नंबर.
[in] aMore
बूलियन यह संकेत देता है कि और ब्लॉक भेजे जाने हैं.
[in] aSize
ब्लॉक साइज़ एक्सपोनेंट.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

https://tools.ietf.org/html/fc7252#page-92 में बताए गए तरीके से, कॉन्टेंट फ़ॉर्मैट सीओएपी का विकल्प जोड़ता है.

अगर मैसेज में पेलोड शामिल करना है, तो otCoapMessageSetPayloadMarker सेट करने से पहले इसे ज़रूरी है.

यह फ़ंक्शन, otCoapMessageAppendUintOption का इस्तेमाल करने वाला सुविधा रैपर है. अगर otCoapOptionContentFormat में, मनचाहे फ़ॉर्मैट टाइप का कोड मौजूद नहीं है, तो इसकी जगह इस बेस फ़ंक्शन का इस्तेमाल किया जाना चाहिए.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aContentFormat
ऊपर otCoapOptionContentFormat में बताए गए कॉन्टेंट फ़ॉर्मैट में से कोई एक फ़ॉर्मैट दिया गया है.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

ज़्यादा से ज़्यादा उम्र का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aMaxAge
ज़्यादा से ज़्यादा उम्र की वैल्यू.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppend रास्तेOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

निरीक्षण का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aObserve
फ़ील्ड की वैल्यू देखें.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendOption

otError otCoapMessageAppendOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint16_t aLength,
  const void *aValue
)

हेडर में CoAP का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aNumber
CoAP का विकल्प नंबर.
[in] aLength
CoAP विकल्प की लंबाई.
[in] aValue
CoAP वैल्यू का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendProxyUriOption

otError otCoapMessageAppendProxyUriOption(
  otMessage *aMessage,
  const char *aUriPath
)

प्रॉक्सी-यूआरआई का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aUriPath
NULL-खत्म की गई स्ट्रिंग के लिए पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendUintOption

otError otCoapMessageAppendUintOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint32_t aValue
)

https://tools.ietf.org/html/fc7252#section-3.2 में बताया गया, बिना साइन वाले पूर्णांक सीओएपी का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aNumber
CoAP का विकल्प नंबर.
[in] aValue
CoAP विकल्प से साइन न किए गए पूर्णांक की वैल्यू.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.
यह भी देखें:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

otError otCoapMessageAppendUriPathOptions(
  otMessage *aMessage,
  const char *aUriPath
)

Uri-पाथ का विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aUriPath
NULL-खत्म की गई स्ट्रिंग के लिए पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageAppendUriQueryOption

otError otCoapMessageAppendUriQueryOption(
  otMessage *aMessage,
  const char *aUriQuery
)

एक Uri-Query विकल्प जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aUriQuery
NULL-खत्म की गई स्ट्रिंग के लिए पॉइंटर, जिसमें एक की=वैल्यू पेयर होना चाहिए.
रिटर्न वैल्यू
OT_ERROR_NONE
विकल्प जोड़ दिया गया.
OT_ERROR_INVALID_ARGS
विकल्प का टाइप, आखिरी विकल्प टाइप के बराबर या उससे बड़ा नहीं है.
OT_ERROR_NO_BUFS
विकल्प की लंबाई, बफ़र साइज़ से ज़्यादा है.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

यह CoAP कोड को ऐसी स्ट्रिंग के तौर पर दिखाता है जिसे इंसान पढ़ सकता है.

@, CoAP कोड को स्ट्रिंग के तौर पर दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

टोकन की लंबाई सेट करता है और उसकी वैल्यू किसी भी क्रम में लगाता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aTokenLength
सेट किए जाने वाले टोकन की लंबाई.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

कोड वैल्यू दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.
लौटाए गए सामान
कोड वैल्यू.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

मैसेज आईडी की वैल्यू दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.
लौटाए गए सामान
मैसेज आईडी की वैल्यू.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

टोकन की वैल्यू के लिए पॉइंटर दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.
लौटाए गए सामान
टोकन की वैल्यू का पॉइंटर.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

टोकन की लंबाई दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.
लौटाए गए सामान
टोकन की लंबाई.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

'टाइप' वैल्यू दिखाता है.

जानकारी
पैरामीटर
[in] aMessage
CoAP मैसेज की जानकारी.
लौटाए गए सामान
'टाइप' की वैल्यू.

otCoapMessageInit

void otCoapMessageInit(
  otMessage *aMessage,
  otCoapType aType,
  otCoapCode aCode
)

CoAP हेडर को शुरू करता है.

जानकारी
पैरामीटर
[in,out] aMessage
शुरू करने के लिए, CoAP मैसेज का पॉइंटर.
[in] aType
CoAP मैसेज का टाइप.
[in] aCode
CoAP मैसेज कोड.

otCoapMessageInitResponse

otError otCoapMessageInitResponse(
  otMessage *aResponse,
  const otMessage *aRequest,
  otCoapType aType,
  otCoapCode aCode
)

जवाब का मैसेज शुरू करता है.

जानकारी
पैरामीटर
[in,out] aResponse
CoAP के जवाब वाले मैसेज के लिए पॉइंटर.
[in] aRequest
CoAP से जुड़े अनुरोध के मैसेज का पॉइंटर.
[in] aType
CoAP मैसेज का टाइप.
[in] aCode
CoAP मैसेज कोड.
रिटर्न वैल्यू
OT_ERROR_NONE
जवाब का मैसेज शुरू किया गया.
OT_ERROR_NO_BUFS
जवाब देने वाले मैसेज को शुरू करने के लिए, मैसेज बफ़र उपलब्ध नहीं हैं.

otCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

कोड की वैल्यू सेट करता है.

जानकारी
पैरामीटर
[in,out] aMessage
शुरू करने के लिए, CoAP मैसेज का पॉइंटर.
[in] aCode
CoAP मैसेज कोड.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

CoAP हेडर पर पेलोड की शुरुआत को दिखाने वाला पेलोड मार्कर जोड़ता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
रिटर्न वैल्यू
OT_ERROR_NONE
पेलोड मार्कर जोड़ा गया.
OT_ERROR_NO_BUFS
हेडर पेलोड मार्कर का साइज़, बफ़र साइज़ से ज़्यादा है.

otCoapMessageSetToken

otError otCoapMessageSetToken(
  otMessage *aMessage,
  const uint8_t *aToken,
  uint8_t aTokenLength
)

हेडर में टोकन की वैल्यू और लंबाई सेट करता है.

जानकारी
पैरामीटर
[in,out] aMessage
CoAP मैसेज की जानकारी.
[in] aToken
टोकन की वैल्यू का पॉइंटर.
[in] aTokenLength
aToken की लंबाई.
रिटर्न वैल्यू
OT_ERROR_NONE
टोकन की वैल्यू सेट की गई.
OT_ERROR_NO_BUFS
टोकन वैल्यू सेट करने के लिए, काफ़ी बफ़र नहीं है.

otCoapNewMessage

otMessage * otCoapNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

CoAP से जुड़ा नया मैसेज.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aSettings
मैसेज सेटिंग का पॉइंटर या डिफ़ॉल्ट सेटिंग सेट करने के लिए NULL हो.
लौटाए गए सामान
अगर कोई मैसेज बफ़र उपलब्ध नहीं है या पैरामीटर अमान्य हैं, तो मैसेज बफ़र या नल के लिए पॉइंटर.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

पहले विकल्प के लिए पॉइंटर दिखाता है.

जानकारी
पैरामीटर
[in,out] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
लौटाए गए सामान
पहले विकल्प के लिए पॉइंटर. अगर कोई विकल्प मौजूद नहीं है, तो NULL पॉइंटर वापस कर दिया जाता है.

otCoapOptionIteratorGetFirstOptionMatching

const otCoapOption * otCoapOptionIteratorGetFirstOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

विकल्प के दिए गए नंबर से मेल खाने वाले पहले विकल्प के लिए पॉइंटर लौटाता है.

जानकारी
पैरामीटर
[in] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
[in] aOption
खोजा गया विकल्प नंबर.
लौटाए गए सामान
मैच करने के पहले विकल्प के लिए पॉइंटर. अगर कोई मिलता-जुलता विकल्प मौजूद नहीं है, तो NULL पॉइंटर वापस कर दिया जाता है.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

अगले विकल्प पर जाने के लिए पॉइंटर लौटाता है.

जानकारी
पैरामीटर
[in,out] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
लौटाए गए सामान
अगले विकल्प पर जाने के लिए पॉइंटर. अगर कोई और विकल्प मौजूद नहीं है, तो NULL पॉइंटर वापस कर दिया जाता है.

otCoapOptionIteratorGetNextOptionMatching

const otCoapOption * otCoapOptionIteratorGetNextOptionMatching(
  otCoapOptionIterator *aIterator,
  uint16_t aOption
)

विकल्प के दिए गए नंबर से मेल खाने वाले अगले विकल्प पर पॉइंटर लौटाता है.

जानकारी
पैरामीटर
[in] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
[in] aOption
खोजा गया विकल्प नंबर.
लौटाए गए सामान
मैच करने के अगले विकल्प पर जाने के लिए पॉइंटर. अगर आगे कोई भी मिलान का विकल्प मौजूद नहीं होता है, तो NULL पॉइंटर वापस कर दिया जाता है.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

मौजूदा विकल्प वैल्यू को aValue में भरता है. यह मानते हुए कि मौजूदा वैल्यू, बिना साइन किए गए एक पूर्णांक है. इसे https://tools.ietf.org/html/RFC7252#section-3.2 के मुताबिक कोड में बदला गया है.

जानकारी
पैरामीटर
[in,out] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
[out] aValue
विकल्प की वैल्यू पाने के लिए, साइन नहीं किए गए पूर्णांक का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
वैल्यू डाली गई.
OT_ERROR_NOT_FOUND
कोई मौजूदा विकल्प नहीं है.
OT_ERROR_NO_BUFS
किसी uint64_t में फ़िट होने के लिए, मान बहुत लंबा है.
यह भी देखें:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

मौजूदा विकल्प की वैल्यू को aValue में भरता है.

जानकारी
पैरामीटर
[in,out] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
[out] aValue
विकल्प की वैल्यू पाने के लिए, बफ़र का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
वैल्यू डाली गई.
OT_ERROR_NOT_FOUND
कोई मौजूदा विकल्प नहीं है.

otCoapOptionIteratorInit

otError otCoapOptionIteratorInit(
  otCoapOptionIterator *aIterator,
  const otMessage *aMessage
)

दिए गए मैसेज में मौजूद विकल्पों के लिए, इटरेटर को शुरू करता है.

जानकारी
पैरामीटर
[in,out] aIterator
CoAP मैसेज के विकल्प दिखाने के लिए पॉइंटर की सुविधा.
[in] aMessage
CoAP मैसेज की जानकारी.
रिटर्न वैल्यू
OT_ERROR_NONE
सफलतापूर्वक शुरू किया गया.
OT_ERROR_PARSE
मैसेज की स्थिति अलग-अलग है.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

यह CoAP सर्वर से, ब्लॉक के मुताबिक संसाधन हटाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aResource
संसाधन के लिए पॉइंटर.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

CoAP सर्वर से संसाधन हटाता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aResource
संसाधन के लिए पॉइंटर.

otCoapSendRequest

otError otCoapSendRequest(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext
)

सीओएपी से जुड़ा अनुरोध भेजता है.

अगर किसी अनुरोध का जवाब देना ज़रूरी है, तो उससे जुड़े फ़ंक्शन और कॉन्टेक्स्ट की जानकारी दी जानी चाहिए. अगर किसी जवाब की उम्मीद नहीं है, तो ये आर्ग्युमेंट NULL पॉइंटर होने चाहिए.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
भेजे जाने वाले मैसेज का पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aHandler
फ़ंक्शन पॉइंटर, जिसे रिस्पॉन्स मिलने या टाइम आउट होने पर कॉल किया जाएगा.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP मैसेज भेजा गया.
OT_ERROR_NO_BUFS
ट्रांसमिशन डेटा असाइन नहीं किया जा सका.

otCoapSendRequestblockWise

otError otCoapSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

CoAP से ब्लॉक के हिसाब से अनुरोध भेजता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

अगर किसी अनुरोध का जवाब देना ज़रूरी है, तो उससे जुड़े फ़ंक्शन और कॉन्टेक्स्ट की जानकारी दी जानी चाहिए. अगर जवाब ब्लॉक के मुताबिक होना चाहिए, तो उससे जुड़ा हुक फ़ंक्शन दिया जाना चाहिए. अगर किसी जवाब की उम्मीद नहीं है, तो ये आर्ग्युमेंट NULL पॉइंटर होने चाहिए.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
भेजे जाने वाले मैसेज का पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aHandler
फ़ंक्शन पॉइंटर, जिसे रिस्पॉन्स मिलने या टाइम आउट होने पर कॉल किया जाएगा.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
[in] aTransmitHook
ब्लॉक के मुताबिक ट्रांसफ़र करने के लिए, हुक फ़ंक्शन का पॉइंटर.
[in] aReceiveHook
ब्लॉक के मुताबिक ट्रांसफ़र के लिए, हुक फ़ंक्शन का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP मैसेज भेजा गया.
OT_ERROR_NO_BUFS
ट्रांसमिशन डेटा असाइन नहीं किया जा सका.

otCoapSendRequestBlockWiseWith पैरामीटरs

otError otCoapSendRequestBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

यह कस्टम ट्रांसमिशन पैरामीटर के साथ, CoAP से ब्लॉक के मुताबिक अनुरोध भेजता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

अगर किसी अनुरोध का जवाब देना ज़रूरी है, तो उससे जुड़े फ़ंक्शन और कॉन्टेक्स्ट की जानकारी दी जानी चाहिए. अगर जवाब ब्लॉक के मुताबिक होना चाहिए, तो उससे जुड़ा हुक फ़ंक्शन दिया जाना चाहिए. अगर किसी जवाब की उम्मीद नहीं है, तो ये आर्ग्युमेंट NULL पॉइंटर होने चाहिए.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
भेजे जाने वाले मैसेज का पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aHandler
फ़ंक्शन पॉइंटर, जिसे रिस्पॉन्स मिलने या टाइम आउट होने पर कॉल किया जाएगा.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
[in] aTxParameters
इस अनुरोध के लिए ट्रांसमिशन पैरामीटर के लिए पॉइंटर. डिफ़ॉल्ट सेटिंग के लिए, NULL का इस्तेमाल करें.
[in] aTransmitHook
ब्लॉक के मुताबिक ट्रांसफ़र करने के लिए, हुक फ़ंक्शन का पॉइंटर.
[in] aReceiveHook
ब्लॉक के मुताबिक ट्रांसफ़र के लिए, हुक फ़ंक्शन का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP मैसेज भेजा गया.
OT_ERROR_NO_BUFS
ट्रांसमिशन डेटा असाइन नहीं किया जा सका.
OT_ERROR_INVALID_ARGS
अमान्य तर्क दिए गए हैं.

otCoapSendRequestWithparameters

otError otCoapSendRequestWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters
)

कस्टम ट्रांसमिशन पैरामीटर के साथ, CoAP अनुरोध भेजता है.

अगर किसी अनुरोध का जवाब देना ज़रूरी है, तो उससे जुड़े फ़ंक्शन और कॉन्टेक्स्ट की जानकारी दी जानी चाहिए. अगर किसी जवाब की उम्मीद नहीं है, तो ये आर्ग्युमेंट NULL पॉइंटर होने चाहिए.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
भेजे जाने वाले मैसेज का पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aHandler
फ़ंक्शन पॉइंटर, जिसे रिस्पॉन्स मिलने या टाइम आउट होने पर कॉल किया जाएगा.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
[in] aTxParameters
इस अनुरोध के लिए ट्रांसमिशन पैरामीटर के लिए पॉइंटर. डिफ़ॉल्ट सेटिंग के लिए, NULL का इस्तेमाल करें. या फिर, दिए गए पैरामीटर इन शर्तों के मुताबिक होने चाहिए:
  1. mMaxRetransmit, OT_COAP_MAX_RETRANSMIT से ज़्यादा नहीं है.
  2. mAckरेमंडैक्टरन्यूरेटर / mAckरेमंड फ़ैक्टर डेनोमिनेटर 1.0 से कम नहीं होना चाहिए.
  3. कैलकुलेटेड एक्सचेंज की अवधि के हिसाब से तय किया गया समय, uint32_t से ओवरफ़्लो नहीं होना चाहिए.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP मैसेज भेजा गया.
OT_ERROR_NO_BUFS
ट्रांसमिशन डेटा असाइन नहीं किया जा सका.
OT_ERROR_INVALID_ARGS
अमान्य तर्क दिए गए हैं.

otCoapSendResponse

otError otCoapSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

सर्वर से CoAP जवाब भेजता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
CoAP से मिले जवाब को भेजने के लिए पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP से मिले रिस्पॉन्स मैसेज को सूची में जोड़ा गया.
OT_ERROR_NO_BUFS
CoAP से जवाब भेजने के लिए, ज़रूरत के मुताबिक बफ़र उपलब्ध नहीं हैं.

otCoapSendResponseBlockWise

otError otCoapSendResponseBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

यह सर्वर से ब्लॉक के मुताबिक CoAP जवाब भेजता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
CoAP से मिले जवाब को भेजने के लिए पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
[in] aTransmitHook
ब्लॉक के मुताबिक ट्रांसफ़र करने के लिए, हुक फ़ंक्शन का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP से मिले रिस्पॉन्स मैसेज को सूची में जोड़ा गया.
OT_ERROR_NO_BUFS
CoAP से जवाब भेजने के लिए, ज़रूरत के मुताबिक बफ़र उपलब्ध नहीं हैं.

otCoapSendResponseBlockWiseWith पैरामीटर्स

otError otCoapSendResponseBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook
)

यह कस्टम ट्रांसमिशन पैरामीटर के साथ सर्वर से, ब्लॉक के मुताबिक CoAP जवाब भेजता है.

कॉन्फ़िगरेशन के चालू होने पर, सवाल के जवाब में यह डेटा देखा जा सकता है: बताते समय क्या होगा.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
CoAP से मिले जवाब को भेजने के लिए पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aTxParameters
इस रिस्पॉन्स के लिए ट्रांसमिशन पैरामीटर के लिए पॉइंटर. डिफ़ॉल्ट सेटिंग के लिए, NULL का इस्तेमाल करें.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.
[in] aTransmitHook
ब्लॉक के मुताबिक ट्रांसफ़र करने के लिए, हुक फ़ंक्शन का पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP से मिले रिस्पॉन्स मैसेज को सूची में जोड़ा गया.
OT_ERROR_NO_BUFS
CoAP से जवाब भेजने के लिए, ज़रूरत के मुताबिक बफ़र उपलब्ध नहीं हैं.
OT_ERROR_INVALID_ARGS
अमान्य तर्क दिए गए हैं.

otCoapSendResponseWithparameters

otError otCoapSendResponseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters
)

यह कस्टम ट्रांसमिशन पैरामीटर के साथ सर्वर से CoAP जवाब भेजता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aMessage
CoAP से मिले जवाब को भेजने के लिए पॉइंटर.
[in] aMessageInfo
aMessage से जुड़ी मैसेज की जानकारी का पॉइंटर.
[in] aTxParameters
इस रिस्पॉन्स के लिए ट्रांसमिशन पैरामीटर के लिए पॉइंटर. डिफ़ॉल्ट सेटिंग के लिए, NULL का इस्तेमाल करें.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP से मिले रिस्पॉन्स मैसेज को सूची में जोड़ा गया.
OT_ERROR_NO_BUFS
CoAP से जवाब भेजने के लिए, ज़रूरत के मुताबिक बफ़र उपलब्ध नहीं हैं.
OT_ERROR_INVALID_ARGS
अमान्य तर्क दिए गए हैं.

otCoapSetDefaultHandler

void otCoapSetDefaultHandler(
  otInstance *aInstance,
  otCoapRequestHandler aHandler,
  void *aContext
)

यह, हैंडल नहीं किए गए CoAP अनुरोधों के लिए डिफ़ॉल्ट हैंडलर सेट करता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aHandler
एक फ़ंक्शन पॉइंटर, जिसे बिना हैंडल किया गया अनुरोध मिलने पर कॉल किया जाएगा.
[in] aContext
कॉन्टेक्स्ट की आर्बिट्रेरी जानकारी के लिए पॉइंटर. अगर इस्तेमाल नहीं किया जाता है, तो इसे शून्य माना जा सकता है.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

CoAP सर्वर चालू करता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
[in] aPort
वह लोकल यूडीपी पोर्ट जिससे बाइंड करना है.
रिटर्न वैल्यू
OT_ERROR_NONE
CoAP सर्वर चालू किया गया.
OT_ERROR_FAILED
CoAP सर्वर शुरू नहीं किया जा सका.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

CoAP सर्वर को रोकता है.

जानकारी
पैरामीटर
[in] aInstance
OpenThread इंस्टेंस के लिए पॉइंटर.
रिटर्न वैल्यू
OT_ERROR_NONE
सीओएपी सर्वर को रोका गया.

मैक्रो

OT_COAP_CODE

 OT_COAP_CODE ((((c)&0x7) << 5) | ((d)&0x1f))

CoAP कोड की वैल्यू तय करने में मदद करने वाला मैक्रो.

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

आरएफ़सी 7252 के मुताबिक, डिफ़ॉल्ट सीओएपी पोर्ट.

संसाधन

OpenThread API के रेफ़रंस के विषय, सोर्स कोड से लिए जाते हैं. यह कोड, GitHub पर उपलब्ध है. ज़्यादा जानकारी के लिए या हमारे दस्तावेज़ में योगदान देने के लिए, संसाधन देखें.