Google is committed to advancing racial equity for Black communities. See how.

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
أسس حجم كتلة CoAP.
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
يتم استدعاء مؤشر الوظيفة هذا عند تلقي رسالة CoAP مع خيار النقل الكتلي.
otCoapBlockwiseResource typedef
يمثل هذا الهيكل مورد CoAP بنقل الكتلة.
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
يتم استدعاء مؤشر الوظيفة هذا قبل إرسال الكتلة التالية في النقل الكتلي.
otCoapCode typedef
قيم كود CoAP.
otCoapOption typedef
struct otCoapOption
يمثل هذا الهيكل خيار CoAP.
otCoapOptionContentFormat typedef
رموز تنسيق محتوى CoAP.
otCoapOptionIterator typedef
تعمل هذه البنية كمكرر لخيارات CoAP.
otCoapOptionType typedef
أرقام خيارات CoAP.
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا عند تلقي طلب CoAP مع مسار Uri محدد.
otCoapResource typedef
يمثل هذا الهيكل أحد موارد CoAP.
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
يتم استدعاء مؤشر الوظيفة هذا عند تلقي استجابة CoAP أو عند انتهاء مهلة الطلب.
otCoapTxParameters typedef
يمثل هذا الهيكل معلمات الإرسال CoAP.
otCoapType typedef
قيم نوع 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)
تُلحق هذه الوظيفة خيار 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-Query واحد.
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
تقوم هذه الطريقة بإرجاع رمز CoAP كسلسلة يمكن قراءتها بواسطة الإنسان.
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)
void
تحدد هذه الوظيفة طول الرمز وتقوم بترتيب قيمته بشكل عشوائي.
otCoapMessageGetCode (const otMessage *aMessage)
هذه الدالة ترجع قيمة الرمز.
otCoapMessageGetMessageId (const otMessage *aMessage)
uint16_t
تقوم هذه الوظيفة بإرجاع قيمة معرّف الرسالة.
otCoapMessageGetToken (const otMessage *aMessage)
const uint8_t *
تقوم هذه الدالة بإرجاع مؤشر إلى قيمة الرمز المميز.
otCoapMessageGetTokenLength (const otMessage *aMessage)
uint8_t
ترجع هذه الدالة طول الرمز المميز.
otCoapMessageGetType (const otMessage *aMessage)
ترجع هذه الدالة قيمة النوع.
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
تعمل هذه الوظيفة على تهيئة رأس CoAP.
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
تعمل هذه الوظيفة على تهيئة رسالة الاستجابة.
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

قيم كود 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 غير موجود.

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
)

هذه الوظيفة إلحاق خيار تنسيق 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
)

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

تفاصيل
العوامل
[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 جديدة.

تفاصيل
العوامل
[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.

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

تفاصيل
العوامل
[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 مع معلمات الإرسال المخصصة.

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

تفاصيل
العوامل
[in] aInstance
مؤشر إلى مثيل OpenThread.
[in] aMessage
مؤشر للرسالة المراد إرسالها.
[in] aMessageInfo
مؤشر إلى معلومات رسالة المرتبطة aMessage .
[in] aHandler
مؤشر وظيفة يتم استدعاؤه عند استقبال الاستجابة أو انتهاء المهلة.
[in] aContext
مؤشر إلى معلومات سياق عشوائية. قد يكون NULL إذا لم يتم استخدامه.
[in] aTxParameters
مؤشر لمعلمات الإرسال لهذا الطلب. استخدم NULL للافتراضيات. خلاف ذلك ، يجب أن تفي المعلمات المقدمة بالشروط التالية:
  1. لا يتجاوز mMaxRetransmit OT_COAP_MAX_RETRANSMIT.
  2. يجب ألا يكون mAckRandomFactorNumerator / mAckRandomFactorDenominator أقل من 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 من الخادم.

هذه الوظيفة متاحة عند تمكين تكوين 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.