كوب

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

الملخّص

الوظائف المتوفّرة في هذه الوحدة متاحة عند تفعيل ميزة واجهة برمجة تطبيقات CoAP (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))
}
عدد
قيم رمز CAP.
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 مَعلمة typetype
أس عدد قوالب COAP.
otCoapBlockwiseReceiveHook)(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) مَعلمة typetype
يتم استدعاء مؤشر الدالة هذا عند تلقّي رسالة CoAP مع خيار النقل المعتمد من ناحية الحظر.
otCoapBlockwiseResource مَعلمة typetype
تمثل هذه البنية مورد CoAP مع النقل باتّجاه الحظر.
otCoapBlockwiseTransmitHook)(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) مَعلمة typetype
يتم استدعاء مؤشر الدالة هذا قبل إرسال الحظر التالي في عملية حظر الملكية.
otCoapCode مَعلمة typetype
enum otCoapCode
قيم رمز CAP.
otCoapOption مَعلمة typetype
struct otCoapOption
تمثل هذه البنية خيار CoAP.
otCoapOptionContentFormat مَعلمة typetype
رموز تنسيق محتوى CoAP
otCoapOptionIterator مَعلمة typetype
تعمل هذه البنية كمكرر لخيارات CoAP.
otCoapOptionType مَعلمة typetype
أرقام خيارات CoAP.
otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) مَعلمة typetype
void(*
يتم استدعاء مؤشر الدالة هذا عند تلقّي طلب CoAP باستخدام مسار Uri محدد.
otCoapResource مَعلمة typetype
تمثل هذه البنية مورد CoAP.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) مَعلمة typetype
void(*
يتم استدعاء مؤشر الدالة هذا عند تلقّي استجابة CoAP أو عند انتهاء مهلة الطلب.
otCoapTxParameters مَعلمة typetype
تمثل هذه البنية معلمات إرسال CoAP.
otCoapType مَعلمة typetype
enum otCoapType
قيم نوع CoAP (عدد صحيح غير موقَّع 2 بت).

الدوال

otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
تضيف هذه الدالة مورد حظر الحظر إلى خادم CoAP.
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
void
تضيف هذه الدالة موردًا إلى خادم CoAP.
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
uint16_t
تحوِّل هذه الدالة حقل خيار حظر SZX إلى حجم الكتلة الفعلي.
otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
تضيف هذه الدالة الخيار Block1.
otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
تضيف هذه الدالة الخيار Block2.
otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
تُلحِق هذه الدالة خيار CoAP بتنسيق المحتوى كما هو محدَّد في https://tools.ietf.org/html/rfc7252#page-92.
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
تضيف هذه الدالة خيار Max-Age.
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)
تضيف هذه الدالة خيارَ Proxy-Uri.
otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
تضيف هذه الدالة خيار CoAP لعدد صحيح غير موقَّع كما هو مُحدَّد في https://tools.ietf.org/html/rfc7252#section-3.2.
otCoapMessageAppendUriPathOptions(otMessage *aMessage, const char *aUriPath)
تضيف هذه الدالة خيار Uri-Path.
otCoapMessageAppendUriQueryOption(otMessage *aMessage, const char *aUriQuery)
تضيف هذه الدالة خيار معرّف موارد منتظم (URI) واحد.
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)
ترسل هذه الدالة طلب CoAP.
otCoapSendRequestBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
ترسل هذه الدالة طلب CoAP على مستوى الحظر.
otCoapSendRequestBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
ترسل هذه الدالة طلب CoAP على مستوى الحظر باستخدام معلّمات نقل مخصّصة.
otCoapSendRequestWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
ترسل هذه الدالة طلب CoAP مع معلّمات النقل المخصّصة.
otCoapSendResponse(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
ترسل هذه الدالة استجابة CoAP من الخادم.
otCoapSendResponseBlockWise(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
ترسل هذه الدالة استجابة CoAP على مستوى الحظر من الخادم.
otCoapSendResponseBlockWiseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
ترسل هذه الدالة حظر CoAP على مستوى الحظر من الخادم باستخدام مُعلّمات الإرسال المخصّصة.
otCoapSendResponseWithParameters(otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
ترسل هذه الدالة استجابة 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.

otCoapTxParameters

تمثل هذه البنية معلمات إرسال CoAP.

التعدادات

otCoapBlockSzx

 otCoapBlockSzx

أس عدد قوالب COAP.

رمز otCoapCode

 otCoapCode

قيم رمز CAP.

المنشآت الفندقية
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

application/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

app/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application/exi: ["كفاءة تنسيق XML (EXI) تنسيق 1.0 (الإصدار الثاني)"، شباط (فبراير) 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

application/json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application/json-patch+json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

application/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

application/senml+cbor: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI

application/senml-exi: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON

application/senml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML

application/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

application/sensml+json: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML

application/sensml+xml: [RFC8428]

OT_COAP_OPTION_CONTENT_FORMAT_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

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

الخادم الوكيل-Uri

OT_COAP_OPTION_SIZE1

الحجم1.

OT_COAP_OPTION_SIZE2

size2 (RFC7959)

OT_COAP_OPTION_URI_HOST

معرّف الموارد المنتظم (URI) المضيف

OT_COAP_OPTION_URI_PATH

معرّف موارد منتظم (URI)

OT_COAP_OPTION_URI_PORT

معرّف الموارد المنتظم (URI) - المنفذ

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.

otCoapBlockwiseReceiveHok

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

يتم استدعاء مؤشر الدالة هذا عند تلقّي رسالة CoAP مع خيار النقل المعتمد من ناحية الحظر.

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_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 مع النقل باتّجاه الحظر.

otCoapBlockwiseTransmitHok

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

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

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_CONFIG_COAP_BlockWISE_TRANSFER_ENABLE.

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

قيم رمز CAP.

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.

مقبض otCoapResponse

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

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

التفاصيل
المعلَمات
[in] aContext
مؤشر للسياق الخاص بالتطبيق.
[in] aMessage
مؤشر إلى المخزن المؤقت للرسائل يحتوي على الرد. فارغ في حال عدم تلقي أي رد.
[in] aMessageInfo
مؤشر لمعلومات aMessage. فارغ في حال عدم تلقي أي رد.
[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 إلى حجم الكتلة الفعلي.

التفاصيل
المعلَمات
[in] aSize
حظر حجم الأُس
طلبات الإرجاع
قيمة الأُس الفعلية.

otCoapMessageExtensionBlock1Option

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

otCoapMessageExtensionBlock2Option

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

otCoapMessageExtensionContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

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

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

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

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aContentFormat
أحد تنسيقات المحتوى المدرجة في otCoapOptionContentFormat أعلاه.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageExtensionMaxAgeOption

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

otCoapMessageExtensionObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

تضيف هذه الدالة خيار "الملاحظة".

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aObserve
لاحظ قيمة الحقل.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageExtensionOption

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

تضيف هذه الدالة خيار CoAP في الرأس.

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aNumber
رقم خيار CAP.
[in] aLength
طول خيار CoAP.
[in] aValue
مؤشر إلى قيمة CoAP.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessagePrefixProxyUriOption

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

تضيف هذه الدالة خيارَ Proxy-Uri.

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aUriPath
مؤشر إلى سلسلة يتم إنهاؤها فارغًا.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageAttachmentUintOption

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
رقم خيار CAP.
[in] aValue
قيمة عدد صحيح غير موقعة من خيار CoAP.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.
راجع أيضًا:
otCoapMessageGetOptionUintValue

otCoapMessageExtensionUriPathOptions

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

تضيف هذه الدالة خيار Uri-Path.

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aUriPath
مؤشر إلى سلسلة يتم إنهاؤها فارغًا.
قيم الإرجاع
OT_ERROR_NONE
تم إلحاق الخيار بنجاح.
OT_ERROR_INVALID_ARGS
نوع الخيار ليس مساويًا لنوع الخيار الأخير أو أكبر منه.
OT_ERROR_NO_BUFS
يتجاوز طول الخيار حجم المخزن المؤقت.

otCoapMessageExtensionUriQueryOption

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

تضيف هذه الدالة خيار معرّف موارد منتظم (URI) واحد.

التفاصيل
المعلَمات
[in,out] aMessage
مؤشر إلى رسالة CoAP.
[in] aUriQuery
مؤشر إلى سلسلة يتم إنهاؤها فارغًا، ويجب أن يحتوي على زوج key=value واحد.
قيم الإرجاع
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.
طلبات الإرجاع
تمثّل هذه الخاصية قيمة الرمز.

otCoapMessageGetId

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
مؤشر رسالة استجابة CAP.
[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 جديدة.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aSettings
مؤشر إلى إعدادات الرسالة أو فارغ لوضع الإعدادات التلقائية.
طلبات الإرجاع
إشارة إلى المخزن المؤقت للرسائل أو فارغ في حال عدم توفر ذاكرة تخزين مؤقت للرسائل أو كانت المعلمات غير صالحة.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

تعرض هذه الدالة مؤشرًا إلى الخيار الأول.

التفاصيل
المعلَمات
[in,out] aIterator
مؤشر إلى تكرار خيار رسالة CoAP.
طلبات الإرجاع
مؤشر إلى الخيار الأول وفي حال عدم وجود أي خيار، يتم عرض المؤشر "خالٍ".

otCoapOptionIteratorGetFirstOptionMatching

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

تعرض هذه الدالة مؤشرًا للخيار الأول الذي يطابق رقم الخيار المحدّد.

التفاصيل
المعلَمات
[in] aIterator
مؤشر إلى تكرار خيار رسالة CoAP.
[in] aOption
تم البحث عن رقم الخيار.
طلبات الإرجاع
مؤشر إلى خيار المطابقة الأول. وفي حال عدم وجود أي خيار مطابقة، يتم عرض المؤشر "خالٍ".

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

تعرض هذه الدالة مؤشرًا للخيار التالي.

التفاصيل
المعلَمات
[in,out] aIterator
مؤشر إلى تكرار خيار رسالة CoAP.
طلبات الإرجاع
مؤشر إلى الخيار التالي في حال عدم وجود أي خيارات أخرى، يتم عرض المؤشر "خالٍ".

otCoapOptionIteratorGetNextOptionMatching

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

تعرض هذه الدالة مؤشرًا للخيار التالي يطابق رقم الخيار المحدّد.

التفاصيل
المعلَمات
[in] aIterator
مؤشر إلى تكرار خيار رسالة CoAP.
[in] aOption
تم البحث عن رقم الخيار.
طلبات الإرجاع
مؤشر إلى خيار المطابقة التالي. وفي حال عدم وجود خيار آخر للمطابقة، يتم عرض المؤشر "خالٍ".

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.
اطّلع أيضًا على:
otCoapMessageExtensionUintOption

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.

إذا كان من المتوقع الرد على الطلب، يجب تقديم معلومات عن الدالة والسياق المعنيّ. في حال عدم توقُّع استجابة، يجب أن تكون هذه الوسيطات فارغة.

التفاصيل
المعلَمات
[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 على مستوى الحظر.

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_CONFIG_COAP_BlockWISE_TRANSFER_ENABLE.

إذا كان من المتوقع الرد على الطلب، يجب تقديم معلومات عن الدالة والسياق المعنيّ. إذا كان من المتوقع أن تكون الاستجابة من ناحية الحظر، يجب تقديم وظيفة مرتبطة ذات صلة. في حال عدم توقُّع استجابة، يجب أن تكون هذه الوسيطات فارغة.

التفاصيل
المعلَمات
[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 على مستوى الحظر باستخدام معلّمات نقل مخصّصة.

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_CONFIG_COAP_BlockWISE_TRANSFER_ENABLE.

إذا كان من المتوقع الرد على الطلب، يجب تقديم معلومات عن الدالة والسياق المعنيّ. إذا كان من المتوقع أن تكون الاستجابة من ناحية الحظر، يجب تقديم وظيفة مرتبطة ذات صلة. في حال عدم توقُّع استجابة، يجب أن تكون هذه الوسيطات فارغة.

التفاصيل
المعلَمات
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aMessage
مؤشر الرسالة التي سيتم إرسالها.
[in] aMessageInfo
مؤشر إلى معلومات الرسالة المرتبطة بـ aMessage.
[in] aHandler
مؤشر دالة يتم استدعاؤه عند استقبال الردود أو انتهاء المهلة.
[in] aContext
مؤشر لمعلومات السياق العشوائية. يمكن أن يكون فارغًا إذا لم يتم استخدامه.
[in] aTxParameters
مؤشر إلى معلمات الإرسال لهذا الطلب. استخدام "خالٍ" للإعدادات التلقائية
[in] aTransmitHook
مؤشّر إلى وظيفة ربط لإجراء النقل الكتلي الصادر.
[in] aReceiveHook
مؤشّر إلى وظيفة مرتبطة لإجراء النقل الوارد بطريقة الحظر
قيم الإرجاع
OT_ERROR_NONE
تم إرسال رسالة CoAP بنجاح.
OT_ERROR_NO_BUFS
تعذّر تخصيص بيانات إعادة الإرسال.

otCoapSendRequestParameters

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
مؤشر إلى معلمات الإرسال لهذا الطلب. استخدام "خالٍ" للإعدادات التلقائية وبخلاف ذلك، يجب أن تتوافق المعلمات المقدّمة مع الشروط التالية:
  1. لا يزيد mMaxReTransmit عن OT_COAP_MAX_RETRANSMIT.
  2. يجب ألا يكون mAck والعجائن / mAck والعجلة الفعلية أقل من 1.0.
  3. يجب ألا يتجاوز وقت التحويل المحسوب 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 على مستوى الحظر من الخادم.

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_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 على مستوى الحظر من الخادم باستخدام مُعلّمات الإرسال المخصّصة.

تتوفر هذه الدالة عند تفعيل ضبط OpenGLيجب أن يتم ضبط تهيئة {7}CREATE_CONFIG_COAP_BlockWISE_TRANSFER_ENABLE.

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

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

يتم دعم الحد الأقصى للإرسال.

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.

المراجع

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