CoAP

تتضمن هذه الوحدة الوظائف التي تتحكم في اتصال CoAP.

ملخص

تتوفر الوظائف في هذه الوحدة عند تمكين ميزة CoAP API ( OPENTHREAD_CONFIG_COAP_API_ENABLE ).

التعداد
`otCoapBlockSzx`	تعداد أسس حجم كتلة 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)) }	تعداد قيم كود 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 }	تعداد رموز تنسيق محتوى 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 }	تعداد أرقام خيارات CoAP.
`otCoapType { OT_COAP_TYPE_CONFIRMABLE = 0, OT_COAP_TYPE_NON_CONFIRMABLE = 1, OT_COAP_TYPE_ACKNOWLEDGMENT = 2, OT_COAP_TYPE_RESET = 3 }`	تعداد قيم نوع CoAP (2 بت عدد صحيح بدون إشارة).

النوع
`otCoapBlockSzx`	typedef `enum otCoapBlockSzx` أسس حجم كتلة CoAP.
`otCoapBlockwiseReceiveHook )(void aContext, const uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)`	typedef `otError (*` يتم استدعاء مؤشر الوظيفة هذا عند تلقي رسالة CoAP مع خيار النقل الكتلي.
`otCoapBlockwiseResource`	typedef `struct otCoapBlockwiseResource` يمثل هذا الهيكل مورد CoAP بنقل الكتلة.
`otCoapBlockwiseTransmitHook )(void aContext, uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore)`	typedef `otError (*` يتم استدعاء مؤشر الوظيفة هذا قبل إرسال الكتلة التالية في النقل الكتلي.
`otCoapCode`	typedef `enum otCoapCode` قيم كود CoAP.
`otCoapOption`	typedef `struct otCoapOption` يمثل هذا الهيكل خيار CoAP.
`otCoapOptionContentFormat`	typedef `enum otCoapOptionContentFormat` رموز تنسيق محتوى CoAP.
`otCoapOptionIterator`	typedef `struct otCoapOptionIterator` تعمل هذه البنية كمكرر لخيارات CoAP.
`otCoapOptionType`	typedef `enum otCoapOptionType` أرقام خيارات CoAP.
`otCoapRequestHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo)`	typedef `void(*` يتم استدعاء مؤشر الوظيفة هذا عند تلقي طلب CoAP مع مسار Uri محدد.
`otCoapResource`	typedef `struct otCoapResource` يمثل هذا الهيكل أحد موارد CoAP.
`otCoapResponseHandler )(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo, otError aResult)`	typedef `void(*` يتم استدعاء مؤشر الوظيفة هذا عند تلقي استجابة CoAP أو عند انتهاء مهلة الطلب.
`otCoapTxParameters`	typedef `struct otCoapTxParameters` يمثل هذا الهيكل معلمات الإرسال CoAP.
`otCoapType`	typedef `enum otCoapType` قيم نوع CoAP (2 بت عدد صحيح بدون إشارة).

المهام
`otCoapAddBlockWiseResource ( otInstance aInstance, otCoapBlockwiseResource aResource)`	`void` تضيف هذه الوظيفة موردًا جماعيًا إلى خادم CoAP.
`otCoapAddResource ( otInstance aInstance, otCoapResource aResource)`	`void` تضيف هذه الوظيفة مورداً إلى خادم CoAP.
`otCoapBlockSizeFromExponent ( otCoapBlockSzx aSize)`	`uint16_t` تقوم هذه الوظيفة بتحويل حقل SZX لخيار CoAP Block إلى حجم الكتلة الفعلي.
`otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` تُلحق هذه الوظيفة خيار Block1.
`otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` هذه الوظيفة تلحق خيار Block2.
`otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)`	`otError` تُلحق هذه الوظيفة خيار Content Format CoAP كما هو محدد في https://tools.ietf.org/html/rfc7252#page-92 .
`otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)`	`otError` هذه الوظيفة تلحق خيار Max-Age.
`otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)`	`otError` تُلحق هذه الوظيفة خيار مراقبة.
`otCoapMessageAppendOption ( otMessage aMessage, uint16_t aNumber, uint16_t aLength, const void aValue)`	`otError` تقوم هذه الوظيفة بإلحاق خيار CoAP في رأس الصفحة.
`otCoapMessageAppendProxyUriOption ( otMessage aMessage, const char aUriPath)`	`otError` تُلحق هذه الوظيفة خيار Proxy-Uri.
`otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)`	`otError` تقوم هذه الوظيفة بإلحاق خيار CoAP بعدد صحيح بدون إشارة كما هو محدد في https://tools.ietf.org/html/rfc7252#section-3.2 .
`otCoapMessageAppendUriPathOptions ( otMessage aMessage, const char aUriPath)`	`otError` هذه الوظيفة تلحق خيار Uri-Path.
`otCoapMessageAppendUriQueryOption ( otMessage aMessage, const char aUriQuery)`	`otError` تُلحق هذه الوظيفة خيار Uri-Query واحد.
`otCoapMessageCodeToString (const otMessage *aMessage)`	`const char *` تقوم هذه الطريقة بإرجاع رمز CoAP كسلسلة يمكن قراءتها بواسطة الإنسان.
`otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)`	`void` تحدد هذه الوظيفة طول الرمز وتعشوائي قيمته.
`otCoapMessageGetCode (const otMessage *aMessage)`	`otCoapCode` هذه الدالة ترجع قيمة الرمز.
`otCoapMessageGetMessageId (const otMessage *aMessage)`	`uint16_t` تقوم هذه الوظيفة بإرجاع قيمة معرّف الرسالة.
`otCoapMessageGetToken (const otMessage *aMessage)`	`const uint8_t *` ترجع هذه الدالة مؤشرًا إلى قيمة الرمز المميز.
`otCoapMessageGetTokenLength (const otMessage *aMessage)`	`uint8_t` هذه الدالة ترجع طول الرمز المميز.
`otCoapMessageGetType (const otMessage *aMessage)`	`otCoapType` ترجع هذه الدالة قيمة النوع.
`otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)`	`void` تعمل هذه الوظيفة على تهيئة رأس CoAP.
`otCoapMessageInitResponse ( otMessage aResponse, const otMessage aRequest, otCoapType aType, otCoapCode aCode)`	`otError` تعمل هذه الوظيفة على تهيئة رسالة الاستجابة.
`otCoapMessageSetPayloadMarker ( otMessage *aMessage)`	`otError` تضيف هذه الوظيفة علامة الحمولة التي تشير إلى بداية الحمولة إلى رأس CoAP.
`otCoapMessageSetToken ( otMessage aMessage, const uint8_t aToken, uint8_t aTokenLength)`	`otError` تحدد هذه الوظيفة قيمة الرمز المميز والطول في رأس الصفحة.
`otCoapNewMessage ( otInstance aInstance, const otMessageSettings aSettings)`	`otMessage *` تنشئ هذه الوظيفة رسالة 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)`	`otError` تملأ هذه الوظيفة قيمة الخيار الحالي في `aValue` بافتراض أن القيمة الحالية هي عدد صحيح بدون إشارة تم ترميزه وفقًا لـ https://tools.ietf.org/html/rfc7252#section-3.2 .
`otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator aIterator, void aValue)`	`otError` تملأ هذه الوظيفة قيمة الخيار الحالي في `aValue` .
`otCoapOptionIteratorInit ( otCoapOptionIterator aIterator, const otMessage aMessage)`	`otError` تعمل هذه الوظيفة على تهيئة مكرر للخيارات الموجودة في الرسالة المحددة.
`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)`	`otError` ترسل هذه الوظيفة طلب CoAP.
`otCoapSendRequestBlockWise ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` ترسل هذه الوظيفة كتلة طلب CoAP.
`otCoapSendRequestBlockWiseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` ترسل هذه الوظيفة طلب CoAP على شكل كتلة مع معلمات إرسال مخصصة.
`otCoapSendRequestWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters)`	`otError` ترسل هذه الوظيفة طلب CoAP مع معلمات الإرسال المخصصة.
`otCoapSendResponse ( otInstance aInstance, otMessage aMessage, const otMessageInfo *aMessageInfo)`	`otError` ترسل هذه الوظيفة استجابة CoAP من الخادم.
`otCoapSendResponseBlockWise ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, void aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` ترسل هذه الوظيفة كتلة استجابة CoAP من الخادم.
`otCoapSendResponseBlockWiseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` ترسل هذه الوظيفة كتلة استجابة CoAP من الخادم مع معلمات إرسال مخصصة.
`otCoapSendResponseWithParameters ( otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters)`	`otError` ترسل هذه الوظيفة استجابة CoAP من الخادم مع معلمات الإرسال المخصصة.
`otCoapSetDefaultHandler ( otInstance aInstance, otCoapRequestHandler aHandler, void aContext)`	`void` تعيّن هذه الوظيفة المعالج الافتراضي لطلبات CoAP غير المعالجة.
`otCoapStart ( otInstance *aInstance, uint16_t aPort)`	`otError` تبدأ هذه الوظيفة خادم CoAP.
`otCoapStop ( otInstance *aInstance)`	`otError` تعمل هذه الوظيفة على إيقاف خادم CoAP.

الهياكل
otCoapBlockwiseResource	يمثل هذا الهيكل مورد CoAP بنقل الكتلة.
otCoapOption	يمثل هذا الهيكل خيار CoAP.
otCoapOptionIterator	تعمل هذه البنية كمكرر لخيارات CoAP.
otCoapResource	يمثل هذا الهيكل أحد موارد CoAP.
otCoapTxParameters	يمثل هذا الهيكل معلمات الإرسال CoAP.

التعداد

otCoapBlockSzx

 otCoapBlockSzx

أسس حجم كتلة CoAP.

otCoapCode

 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`	application / 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`	application / cose-key: [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET`	application / 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`	application / exi: ["Efficient XML Interchange (EXI) Format 1.0 (الإصدار الثاني)" ، فبراير 2014]
`OT_COAP_OPTION_CONTENT_FORMAT_JSON`	التطبيق / json: [RFC7159]
`OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON`	application / json-patch + json: [RFC6902]
`OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT`	التطبيق / تنسيق الارتباط: [RFC6690]
`OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON`	application / merge-patch + json: [RFC7396]
`OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM`	application / 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`	Block1 (RFC7959)
`OT_COAP_OPTION_BLOCK2`	Block2 (RFC7959)
`OT_COAP_OPTION_CONTENT_FORMAT`	تنسيق المحتوى.
`OT_COAP_OPTION_E_TAG`	ETag.
`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`	Size2 (RFC7959)
`OT_COAP_OPTION_URI_HOST`	Uri-Host.
`OT_COAP_OPTION_URI_PATH`	يوري باث.
`OT_COAP_OPTION_URI_PORT`	ميناء أوري.
`OT_COAP_OPTION_URI_QUERY`	Uri- الاستعلام.

otCoapType

 otCoapType

قيم نوع CoAP (2 بت عدد صحيح بدون إشارة).

الخصائص
`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 مع خيار النقل الكتلي.

هذه الوظيفة متاحة عند تمكين تكوين OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

تفاصيل

المعلمات

`[in] aContext`	مؤشر إلى سياق خاص بالتطبيق.
`[in] aBlock`	مؤشر لقطعة الكتلة.
`[in] aPosition`	موضع `aBlock` في تسلسل بالبايت.
`[in] aBlockLength`	طول مقطع الكتلة بالبايت.
`[in] aMore`	ضع علامة في حالة اتباع المزيد من مقاطع الحظر.
`[in] aTotalLength`	الطول الإجمالي للمعلومات المنقولة بالبايت (يشار إليه بخيار Size1 أو Size2).

إرجاع القيم

`OT_ERROR_NONE`	تم تخزين مقطع الكتلة بنجاح.
`OT_ERROR_NO_BUFS`	لا مزيد من الذاكرة لتخزين الكتل.
`OT_ERROR_NO_FRAME_RECEIVED`	جزء الكتلة مفقود.

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

يمثل هذا الهيكل مورد CoAP بنقل الكتلة.

otCoapBlockwiseTransmitHook

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

يتم استدعاء مؤشر الوظيفة هذا قبل إرسال الكتلة التالية في النقل الكتلي.

هذه الوظيفة متاحة عند تمكين تكوين OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

من خلال تغيير قيمة aBlockLength ، تتم إعادة التفاوض على حجم كتلة التبادل بالكامل. من المستحسن القيام بذلك بعد استلام الكتلة الأولى لأن التغييرات اللاحقة قد تسبب مشاكل مع تطبيقات CoAP الأخرى.

تفاصيل

المعلمات

`[in] aContext`	مؤشر إلى سياق خاص بالتطبيق.
`[in,out] aBlock`	مؤشر إلى المكان الذي يمكن كتابة مقطع الكتلة إليه.
`[in] aPosition`	الموضع المتسلسل الذي يمكن من خلاله الحصول على قطعة الكتلة.
`[in,out] aBlockLength`	عند الإدخال ، الحد الأقصى لطول قطعة الكتلة بالبايت.
`[out] aMore`	مؤشر للعلم في حالة اتباع المزيد من مقاطع الكتلة.

إرجاع القيم

`OT_ERROR_NONE`	لم يحدث خطأ.
`OT_ERROR_INVALID_ARGS`	`aPosition` في `aPosition` غير موجود.

otCoapCode

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)

يتم استدعاء مؤشر الوظيفة هذا عند تلقي طلب CoAP مع مسار Uri محدد.

تفاصيل

المعلمات

`[in] aContext`	مؤشر إلى معلومات سياق عشوائية.
`[in] aMessage`	مؤشر للرسالة.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة لـ `aMessage` .

otCoapResource

struct otCoapResource otCoapResource

يمثل هذا الهيكل أحد موارد CoAP.

otCoapResponseHandler

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

يتم استدعاء مؤشر الوظيفة هذا عند تلقي استجابة CoAP أو عند انتهاء مهلة الطلب.

تفاصيل

المعلمات

`[in] aContext`	مؤشر إلى سياق خاص بالتطبيق.
`[in] aMessage`	مؤشر إلى مخزن الرسائل الذي يحتوي على الاستجابة. NULL إذا لم يتم تلقي أي رد.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة لـ `aMessage` . NULL إذا لم يتم تلقي أي رد.
`[in] aResult`	نتيجة معاملة CoAP.

إرجاع القيم

`OT_ERROR_NONE`	تم استلام الرد بنجاح.
`OT_ERROR_ABORT`	تمت إعادة تعيين معاملة CoAP بواسطة النظير.
`OT_ERROR_RESPONSE_TIMEOUT`	لم يتم استلام أي رد أو إقرار خلال فترة المهلة.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

يمثل هذا الهيكل معلمات الإرسال CoAP.

otCoapType

enum otCoapType otCoapType

قيم نوع CoAP (2 بت عدد صحيح بدون إشارة).

المهام

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
)

تقوم هذه الوظيفة بتحويل حقل SZX لخيار CoAP Block إلى حجم الكتلة الفعلي.

تفاصيل

المعلمات

[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
)

هذه الوظيفة تلحق خيار Block2.

تفاصيل

المعلمات

`[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
)

تُلحق هذه الوظيفة خيار Content Format CoAP كما هو محدد في https://tools.ietf.org/html/rfc7252#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
)

هذه الوظيفة تلحق خيار Max-Age.

تفاصيل

المعلمات

`[in,out] aMessage`	مؤشر إلى رسالة CoAP.
`[in] aMaxAge`	قيمة الحد الأقصى للعمر.

إرجاع القيم

`OT_ERROR_NONE`	تم إلحاق الخيار بنجاح.
`OT_ERROR_INVALID_ARGS`	نوع الخيار ليس مساويًا أو أكبر من نوع الخيار الأخير.
`OT_ERROR_NO_BUFS`	يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageAppendObserveOption

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
)

تُلحق هذه الوظيفة خيار Proxy-Uri.

تفاصيل

المعلمات

`[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
)

تقوم هذه الوظيفة بإلحاق خيار CoAP بعدد صحيح بدون إشارة كما هو محدد في https://tools.ietf.org/html/rfc7252#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-Path.

تفاصيل

المعلمات

`[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
)

تعمل هذه الوظيفة على تهيئة رسالة الاستجابة.

ملاحظة: يتم تعيين كل من معرف الرسالة aRequest المميز وفقًا aRequest .

تفاصيل

المعلمات

`[in,out] aResponse`	مؤشر إلى رسالة استجابة CoAP.
`[in] aRequest`	مؤشر إلى رسالة طلب CoAP.
`[in] aType`	نوع رسالة CoAP.
`[in] aCode`	رمز رسالة CoAP.

إرجاع القيم

`OT_ERROR_NONE`	تمت تهيئة رسالة الاستجابة بنجاح.
`OT_ERROR_NO_BUFS`	تتوفر مخازن رسائل مؤقتة غير كافية لتهيئة رسالة الاستجابة.

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 جديدة.

ملاحظة: إذا كانت aSettings "NULL" ، يتم تمكين أمان طبقة الارتباط ويتم تعيين أولوية الرسالة على OT_MESSAGE_PRIORITY_NORMAL افتراضيًا.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aSettings`	مؤشر إلى إعدادات الرسالة أو NULL لضبط الإعدادات الافتراضية.

عائدات

مؤشر إلى المخزن المؤقت للرسالة أو 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
)

ترسل هذه الوظيفة طلب CoAP.

في حالة توقع استجابة لطلب ما ، يجب تقديم معلومات عن الوظيفة والسياق. في حالة عدم توقع أي استجابة ، يجب أن تكون هذه الوسائط مؤشرات NULL.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر للرسالة المراد إرسالها.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aHandler`	مؤشر وظيفة يتم استدعاؤه عند استقبال الاستجابة أو انتهاء المهلة.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.

إرجاع القيم

`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.

هذه الوظيفة متاحة عند تمكين تكوين OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

في حالة توقع استجابة لطلب ما ، يجب تقديم معلومات عن الوظيفة والسياق. إذا كان من المتوقع أن تكون الاستجابة حكيمة ، فيجب توفير وظيفة ربط خاصة بها. في حالة عدم توقع أي استجابة ، يجب أن تكون هذه الوسائط مؤشرات NULL.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر للرسالة المراد إرسالها.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aHandler`	مؤشر وظيفة يتم استدعاؤه عند استقبال الاستجابة أو انتهاء المهلة.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
`[in] aTransmitHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الصادرة.
`[in] aReceiveHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الحكيمة الواردة.

إرجاع القيم

`OT_ERROR_NONE`	تم إرسال رسالة CoAP بنجاح.
`OT_ERROR_NO_BUFS`	فشل في تخصيص بيانات إعادة الإرسال.

otCoapSendRequestBlockWiseWithParameters

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.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر للرسالة المراد إرسالها.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aHandler`	مؤشر وظيفة يتم استدعاؤه عند استقبال الاستجابة أو انتهاء المهلة.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
`[in] aTxParameters`	مؤشر لمعلمات الإرسال لهذا الطلب. استخدم NULL للافتراضيات.
`[in] aTransmitHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الصادرة.
`[in] aReceiveHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الحكيمة الواردة.

إرجاع القيم

`OT_ERROR_NONE`	تم إرسال رسالة CoAP بنجاح.
`OT_ERROR_NO_BUFS`	فشل في تخصيص بيانات إعادة الإرسال.

otCoapSendRequestWithParameters

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

ترسل هذه الوظيفة طلب CoAP مع معلمات الإرسال المخصصة.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر للرسالة المراد إرسالها.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aHandler`	مؤشر وظيفة يتم استدعاؤه عند استقبال الاستجابة أو انتهاء المهلة.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
`[in] aTxParameters`	مؤشر لمعلمات الإرسال لهذا الطلب. استخدم NULL للافتراضيات. خلاف ذلك ، يجب أن تستوفي المعلمات المعطاة الشروط التالية: لا يتجاوز mMaxRetransmit OT_COAP_MAX_RETRANSMIT. يجب ألا يكون mAckRandomFactorNumerator / mAckRandomFactorDenominator أقل من 1.0. يجب ألا يتجاوز عمر الصرف المحسوب uint32_t.

إرجاع القيم

`OT_ERROR_INVALID_ARGS`	`aTxParameters` غير صالح.
`OT_ERROR_NONE`	تم إرسال رسالة CoAP بنجاح.
`OT_ERROR_NO_BUFS`	فشل في تخصيص بيانات إعادة الإرسال.

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

07 بداد 1650

ترسل هذه الوظيفة كتلة استجابة CoAP من الخادم.

هذه الوظيفة متاحة عند تمكين تكوين OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر إلى استجابة CoAP للإرسال.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
`[in] aTransmitHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الصادرة.

إرجاع القيم

`OT_ERROR_NONE`	نجح في إدراج رسالة استجابة CoAP في قائمة الانتظار.
`OT_ERROR_NO_BUFS`	تتوفر مخازن مؤقتة غير كافية لإرسال استجابة CoAP.

otCoapSendResponseBlockWiseWithParameters

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

ترسل هذه الوظيفة كتلة استجابة CoAP من الخادم مع معلمات إرسال مخصصة.

هذه الوظيفة متاحة عند تمكين تكوين OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر إلى استجابة CoAP للإرسال.
`[in] aMessageInfo`	مؤشر لمعلومات الرسالة المرتبطة بـ `aMessage` .
`[in] aTxParameters`	مؤشر لمعلمات الإرسال لهذه الاستجابة. استخدم NULL للافتراضيات.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
`[in] aTransmitHook`	مؤشر لوظيفة الخطاف لنقل الكتلة الصادرة.

إرجاع القيم

`OT_ERROR_NONE`	نجح في إدراج رسالة استجابة CoAP في قائمة الانتظار.
`OT_ERROR_NO_BUFS`	تتوفر مخازن مؤقتة غير كافية لإرسال استجابة CoAP.

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.

otCoapSetDefaultHandler

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

تعيّن هذه الوظيفة المعالج الافتراضي لطلبات CoAP غير المعالجة.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aHandler`	مؤشر وظيفة يتم استدعاؤه عند وصول طلب لم تتم معالجته.
`[in] aContext`	مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

تبدأ هذه الوظيفة خادم CoAP.

تفاصيل

المعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aPort`	منفذ UDP المحلي المراد الارتباط به.

إرجاع القيم

`OT_ERROR_NONE`	تم بدء تشغيل خادم CoAP بنجاح.
`OT_ERROR_FAILED`	فشل بدء تشغيل خادم CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

تعمل هذه الوظيفة على إيقاف خادم CoAP.

تفاصيل

المعلمات

[in] aInstance

مؤشر إلى مثيل OpenThread.

إرجاع القيم

OT_ERROR_NONE

تم إيقاف خادم CoAP بنجاح.

وحدات الماكرو

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

أقصى طول رمزي كما هو محدد (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

الحد الأدنى من مهلة ACK بالمللي ثانية بدعم من OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

منفذ CoAP الافتراضي ، كما هو محدد في RFC 7252.

CoAP

ملخص

التعداد

النوع

المهام

الهياكل

التعداد

otCoapBlockSzx

otCoapCode

otCoapOptionContentFormat

otCoapOptionType

otCoapType

النوع

otCoapBlockSzx

otCoapBlockwiseReceiveHook

otCoapBlockwiseResource

otCoapBlockwiseTransmitHook

otCoapCode

otCoapOption

otCoapOptionContentFormat

otCoapOptionIterator

otCoapOptionType

otCoapRequestHandler

otCoapResource

otCoapResponseHandler

otCoapTxParameters

otCoapType

المهام

otCoapAddBlockWiseResource

otCoapAddResource

otCoapBlockSizeFromExponent

otCoapMessageAppendBlock1Option

otCoapMessageAppendBlock2Option

otCoapMessageAppendContentFormatOption

otCoapMessageAppendMaxAgeOption

otCoapMessageAppendObserveOption

otCoapMessageAppendOption

otCoapMessageAppendProxyUriOption

otCoapMessageAppendUintOption

otCoapMessageAppendUriPathOptions

otCoapMessageAppendUriQueryOption

otCoapMessageCodeToString

otCoapMessageGenerateToken

otCoapMessageGetCode

otCoapMessageGetMessageId

otCoapMessageGetToken

otCoapMessageGetTokenLength

otCoapMessageGetType

otCoapMessageInit

otCoapMessageInitResponse

otCoapMessageSetPayloadMarker

otCoapMessageSetToken

otCoapNewMessage

otCoapOptionIteratorGetFirstOption

otCoapOptionIteratorGetFirstOptionMatching

otCoapOptionIteratorGetNextOption

otCoapOptionIteratorGetNextOptionMatching

otCoapOptionIteratorGetOptionUintValue

otCoapOptionIteratorGetOptionValue

otCoapOptionIteratorInit

otCoapRemoveBlockWiseResource

otCoapRemoveResource

otCoapSendRequest

otCoapSendRequestBlockWise

otCoapSendRequestBlockWiseWithParameters

otCoapSendRequestWithParameters

otCoapSendResponse

otCoapSendResponseBlockWise

otCoapSendResponseBlockWiseWithParameters

otCoapSendResponseWithParameters

otCoapSetDefaultHandler

otCoapStart

otCoapStop

وحدات الماكرو

OT_COAP_CODE

OT_COAP_DEFAULT_TOKEN_LENGTH

OT_COAP_MAX_RETRANSMIT

OT_COAP_MAX_TOKEN_LENGTH

OT_COAP_MIN_ACK_TIMEOUT

OT_DEFAULT_COAP_PORT