تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

كواب

تتضمن هذه الوحدة وظائف تتحكم في اتصالات 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 (عدد صحيح بت غير موقّع)

أنواع المحددات
`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-Path محدد.
`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 (عدد صحيح بت غير موقّع)

الدوال
`otCoapAddBlockWiseResource(otInstance aInstance, otCoapBlockwiseResource aResource)`	`void` لإضافة مورد خاضع للحظر إلى خادم CoAP.
`otCoapAddResource(otInstance aInstance, otCoapResource aResource)`	`void` لإضافة مورد إلى خادم CoAP.
`otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)`	`uint16_t` تحوِّل حقل SZX في خيار الحظر الكوري إلى حجم الوحدة الفعلي.
`otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` تُرفِق خيار الحظر 1.
`otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` تُرفِق خيار الحظر 2.
`otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)`	`otError` يُرفِق خيار CoAP بتنسيق المحتوى كما هو مُوضَّح في https://tools.ietf.org/html/rfc7252#page-92.
`otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)`	`otError` تُرفِق خيار الحد الأقصى للعمر.
`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` تعرض قيمة Type.
`otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)`	`void` لإعداد عنوان CoAP.
`otCoapMessageInitResponse(otMessage aResponse, const otMessage aRequest, otCoapType aType, otCoapCode aCode)`	`otError` لإعداد رسالة رد.
`otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)`	`void` لضبط قيمة الرمز
`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` تُرسِل هذه السياسة طلبًا تحظر إمكانية الوصول إلى التطبيق.
`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-PARAMs/core- parameterss.xhtml#content-formats

أماكن إقامة
`OT_COAP_OPTION_CONTENT_FORMAT_CBOR`	التطبيق/cbor: [RFC7049]
`OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON`	app/coap-group+json: [RFC7390]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT`	app/cose; cose-type="cose-encrypt": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0`	app/cose; cose-type="cose-encrypt0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY`	app/cose-key: [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET`	app/cose-key-set: [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC`	app/cose; cose-type="cose-mac": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0`	app/cose; cose-type="cose-mac0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN`	application/cose; cose-type="cose-sign": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1`	app/cose; cose-type="cose-sign1": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_CWT`	app/cwt: [RFC8392]
`OT_COAP_OPTION_CONTENT_FORMAT_EXI`	app/exi: ["Efficient XML Interchange (EXI) Format 1.0 (الإصدار الثاني)", شباط (فبراير) 2014]
`OT_COAP_OPTION_CONTENT_FORMAT_JSON`	app/json: [RFC7159]
`OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON`	app/json-patch+json: [RFC6902]
`OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT`	app/link-format: [RFC6690]
`OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON`	application/merge-patch+json: [RFC7396]
`OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM`	app/octet-stream: [RFC2045][RFC2046]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR`	app/senml+cbor: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI`	application/senml-exi: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON`	app/senml+json: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML`	app/senml+xml: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR`	application/sensml+cbor: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI`	application/sensml-exi: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON`	app/sensml+json: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML`	app/sensml+xml: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN`	text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147]
`OT_COAP_OPTION_CONTENT_FORMAT_XML`	application/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`	علامة 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`	معرّف الموارد المنتظم (URI) للخادم الوكيل
`OT_COAP_OPTION_SIZE1`	الحجم 1.
`OT_COAP_OPTION_SIZE2`	الحجم 2 (RFC7959)
`OT_COAP_OPTION_URI_HOST`	معرف الموارد المنتظم (URI)
`OT_COAP_OPTION_URI_PATH`	Uri-Path.
`OT_COAP_OPTION_URI_PORT`	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

otCoapBlockwisewiseHook

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`	إجمالي الطول بالبايت للمعلومات المنقولة (المشار إليه بخيار المقاس 1 أو المقاس 2)

قيم الإرجاع

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

otCoapCode

enum otCoapCode otCoapCode

قيم رمز CoAP.

خيار otCoap

struct otCoapOption otCoapOption

يمثل خيار CoAP.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

رموز تنسيق محتوى CoAP

تم توثيق القائمة الكاملة على https://www.iana.org/assignments/core-PARAMs/core- parameterss.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-Path محدد.

التفاصيل

المَعلمات

`[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`	لم يتم تلقّي أيّ ردّ أو إقرار خلال فترة المهلة.

معلّمات otCoapTx

struct otCoapTxParameters otCoapTxParameters

يمثل معلمات نقل CoAP.

نوع 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
)

تحوِّل حقل SZX في خيار الحظر الكوري إلى حجم الوحدة الفعلي.

التفاصيل

المَعلمات

[in] aSize

أُس حجم الحجم

المرتجعات

القيمة الأسية للحجم الفعلي.

otCoapMessageإضافةBlock1خيار

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

تُرفِق خيار الحظر 1.

التفاصيل

المَعلمات

`[in,out] aMessage`	مؤشر إلى رسالة CoAP.
`[in] aNum`	رقم الحظر الحالي
`[in] aMore`	منطقي للإشارة إلى أنه يجب إرسال المزيد من الوحدات الأساسية.
`[in] aSize`	أُس حجم الحجم

قيم الإرجاع

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

otCoapMessageMessageBlock2خيار

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`	يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageإضافةContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

يُرفِق خيار CoAP بتنسيق المحتوى كما هو مُوضَّح في https://tools.ietf.org/html/rfc7252#page-92.

يجب استدعاء هذه السياسة قبل ضبط otCoapMessageSetPayloadMarker إذا كان يجب تضمين الحمولة في الرسالة.

هذه الدالة هي برنامج تضمين صغير حول otCoapMessage ستظهرUintOption، وإذا لم يكن رمز نوع التنسيق المطلوب مُدرجًا في otCoapOptionContentFormat، يجب استخدام هذه الدالة الأساسية بدلاً من ذلك.

التفاصيل

المَعلمات

`[in,out] aMessage`	مؤشر إلى رسالة CoAP.
`[in] aContentFormat`	أحد تنسيقات المحتوى المدرَجة في otCoapOptionContentFormat أعلاه.

قيم الإرجاع

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

otCoapMessageMessageMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

تُرفِق خيار الحد الأقصى للعمر.

التفاصيل

المَعلمات

`[in,out] aMessage`	مؤشر إلى رسالة CoAP.
`[in] aMaxAge`	تمثّل هذه السمة قيمة العمر الأقصى.

قيم الإرجاع

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

otCoapMessageAttachObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

تُرفِق خيار "الملاحظة".

التفاصيل

المَعلمات

`[in,out] aMessage`	مؤشر إلى رسالة CoAP.
`[in] aObserve`	ملاحظة قيمة الحقل.

قيم الإرجاع

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

otCoapMessageMessageOption

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`	يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageإضافةProxyUriOption

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`	يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageMessageUintOption

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

otCoapMessageMessageUriPathOptions

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`	يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageMessageUriQueryOption

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
)

تعرض قيمة Type.

التفاصيل

المَعلمات

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

التفاصيل

المَعلمات

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

otCoapMessageSetLoadloadMarker

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.

otCoapOptionIteratorGetFirstOption Match

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.

otCoapOptionIteratorGetNextOptionالمطابقة

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.

يُرجى الاطّلاع أيضًا على:
otCoapMessageAttachUintOption

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`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.

قيم الإرجاع

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

تُرسِل هذه السياسة طلبًا تحظر إمكانية الوصول إلى التطبيق.

متاح عند تفعيل الإعداد OPENThread_CONFIG_COAP_BLOCKWISE_Transfer_ENABLE.

إذا كان من المتوقّع تلقّي ردّ على طلب، يجب تقديم معلومات حول الدالة والسياق. وإذا كان من المتوقّع أن تكون الاستجابة عبارة عن حظر، يجب توفير وظيفة ربط. إذا لم يكن من المتوقع الحصول على رد، يجب أن تكون هذه الوسيطات عبارة عن مؤشرات 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`	تعذّر تخصيص بيانات إعادة الإرسال.

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`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.
`[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`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.
`[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

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

تُرسِل استجابة CoAP محظورة من الخادم.

متاح عند تفعيل الإعداد OPENThread_CONFIG_COAP_BLOCKWISE_Transfer_ENABLE.

التفاصيل

المَعلمات

`[in] aInstance`	مؤشر إلى مثيل OpenThread.
`[in] aMessage`	مؤشر على استجابة CoAP للإرسال
`[in] aMessageInfo`	مؤشر إلى معلومات الرسالة المرتبطة بـ `aMessage`.
`[in] aContext`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.
`[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`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.
`[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`	مؤشر للمعلومات السياقية العشوائية. قد تكون فارغة في حال عدم استخدامها.

برنامج CoCoapStart

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

طول الرمز المميز التلقائي.

الوقت الإضافي: CO_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

الحد الأقصى لإعادة الإرسال المتوافق مع OpenThread.

الوقت الإضافي CO_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

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

الوقت الإضافي CO_COAP_MIN_ACK_ {8/}

 OT_COAP_MIN_ACK_TIMEOUT 1000

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

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

منفذ CoAP التلقائي، على النحو المحدَّد في RFC 7252.

الموارد

تبدأ مواضيع مراجع واجهة برمجة تطبيقات OpenThread من رمز المصدر، وهو متاح على GitHub. للحصول على مزيد من المعلومات أو للمساهمة في المستندات، يمكنك الاطّلاع على المراجع.

كواب

ملخّص

التعدادات

أنواع المحددات

الدوال

هياكل

التعدادات

otCoapBlockSzx

otCoapCode

otCoapOptionContentFormat

otCoapOptionType

نوع otCoapType

أنواع المحددات

otCoapBlockSzx

otCoapBlockwisewiseHook

otCoapBlockwiseResource

otCoapBlockwiseTransmitHook

otCoapCode

خيار otCoap

otCoapOptionContentFormat

برنامج otCoapOptionIterator

otCoapOptionType

otCoapRequestHandler

otCoapResource

otCoapResponseHandler

معلّمات otCoapTx

نوع otCoapType

الدوال

otCoapAddBlockWiseResource

otCoapAddResource

otCoapBlockSizeFromExponent

otCoapMessageإضافةBlock1خيار

otCoapMessageMessageBlock2خيار

otCoapMessageإضافةContentFormatOption

otCoapMessageMessageMaxAgeOption

otCoapMessageAttachObserveOption

otCoapMessageMessageOption

otCoapMessageإضافةProxyUriOption

otCoapMessageMessageUintOption

otCoapMessageMessageUriPathOptions

otCoapMessageMessageUriQueryOption

otCoapMessageCodeToString

otCoapMessagegenerateToken

otCoapMessageGetCode

otCoapMessageGetMessageId

otCoapMessageGetToken

otCoapMessageGetTokenLength

otCoapMessageGetType

otCoapMessageInit

otCoapMessageInitResponse

otCoapMessageSetCode

otCoapMessageSetLoadloadMarker

otCoapMessageSetToken

otCoapNewMessage

otCoapOptionIteratorGetFirstOption

otCoapOptionIteratorGetFirstOption Match

otCoapOptionIteratorGetNextOption

otCoapOptionIteratorGetNextOptionالمطابقة

otCoapOptionIteratorGetOptionUintValue

otCoapOptionIteratorGetOptionValue

otCoapOptionIteratorInit

otCoapRemoveBlockWiseResource

otCoapRemoveResource

otCoapSendRequest

otCoapSendRequestBlockWise

otCoapSendRequestBlockWiseWithParameters

otCoapSendRequestWithParameters

otCoapSendResponse

otCoapSendResponseBlockWise

otCoapSendResponseBlockWiseWithParameters

otCoapSendResponseWithParameters

otCoapSetDefaultHandler

برنامج CoCoapStart

برنامج otCoapStop

وحدات ماكرو

OT_COAP_CODE

OT_COAP_DEFAULT_TOKEN_LENGTH

الوقت الإضافي: CO_COAP_MAX_RETRANSMIT

الوقت الإضافي CO_COAP_MAX_TOKEN_LENGTH

الوقت الإضافي CO_COAP_MIN_ACK_ {8/}