קואפ

מודול זה כולל פונקציות ששולטות בתקשורת של CoAP.

סיכום

הפונקציות במודול זה זמינות כשמפעילים את התכונה CoAP API (OPENTHREAD_CONFIG_COAP_API_ENABLE).

הדמיות

otCoapBlockSzx Enum
פריטים בגודל בלוק CoAP.
otCoapCode{
  OT_COAP_CODE_EMPTY = (((( 0 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_GET = (((( 0 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_POST = (((( 0 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_PUT = (((( 0 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_DELETE = (((( 0 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_RESPONSE_MIN = (((( 2 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_CREATED = (((( 2 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_DELETED = (((( 2 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_VALID = (((( 2 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_CHANGED = (((( 2 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_CONTENT = (((( 2 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_CONTINUE = (((( 2 )&0x7) << 5) | (( 31 )&0x1f)),
  OT_COAP_CODE_BAD_REQUEST = (((( 4 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_UNAUTHORIZED = (((( 4 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_OPTION = (((( 4 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_FORBIDDEN = (((( 4 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_NOT_FOUND = (((( 4 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_METHOD_NOT_ALLOWED = (((( 4 )&0x7) << 5) | (( 5 )&0x1f)),
  OT_COAP_CODE_NOT_ACCEPTABLE = (((( 4 )&0x7) << 5) | (( 6 )&0x1f)),
  OT_COAP_CODE_REQUEST_INCOMPLETE = (((( 4 )&0x7) << 5) | (( 8 )&0x1f)),
  OT_COAP_CODE_PRECONDITION_FAILED = (((( 4 )&0x7) << 5) | (( 12 )&0x1f)),
  OT_COAP_CODE_REQUEST_TOO_LARGE = (((( 4 )&0x7) << 5) | (( 13 )&0x1f)),
  OT_COAP_CODE_UNSUPPORTED_FORMAT = (((( 4 )&0x7) << 5) | (( 15 )&0x1f)),
  OT_COAP_CODE_INTERNAL_ERROR = (((( 5 )&0x7) << 5) | (( 0 )&0x1f)),
  OT_COAP_CODE_NOT_IMPLEMENTED = (((( 5 )&0x7) << 5) | (( 1 )&0x1f)),
  OT_COAP_CODE_BAD_GATEWAY = (((( 5 )&0x7) << 5) | (( 2 )&0x1f)),
  OT_COAP_CODE_SERVICE_UNAVAILABLE = (((( 5 )&0x7) << 5) | (( 3 )&0x1f)),
  OT_COAP_CODE_GATEWAY_TIMEOUT = (((( 5 )&0x7) << 5) | (( 4 )&0x1f)),
  OT_COAP_CODE_PROXY_NOT_SUPPORTED = (((( 5 )&0x7) << 5) | (( 5 )&0x1f))
}
Enum
ערכי קוד CoAP.
otCoapOptionContentFormat{
  OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN = 0,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0 = 16,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0 = 17,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1 = 18,
  OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT = 40,
  OT_COAP_OPTION_CONTENT_FORMAT_XML = 41,
  OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM = 42,
  OT_COAP_OPTION_CONTENT_FORMAT_EXI = 47,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON = 50,
  OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON = 51,
  OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON = 52,
  OT_COAP_OPTION_CONTENT_FORMAT_CBOR = 60,
  OT_COAP_OPTION_CONTENT_FORMAT_CWT = 61,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT = 96,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC = 97,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN = 98,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY = 101,
  OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET = 102,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON = 110,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON = 111,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR = 112,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR = 113,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI = 114,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI = 115,
  OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON = 256,
  OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML = 310,
  OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML = 311
}
Enum
קודים לפורמט תוכן של CoAP.
otCoapOptionType{
  OT_COAP_OPTION_IF_MATCH = 1,
  OT_COAP_OPTION_URI_HOST = 3,
  OT_COAP_OPTION_E_TAG = 4,
  OT_COAP_OPTION_IF_NONE_MATCH = 5,
  OT_COAP_OPTION_OBSERVE = 6,
  OT_COAP_OPTION_URI_PORT = 7,
  OT_COAP_OPTION_LOCATION_PATH = 8,
  OT_COAP_OPTION_URI_PATH = 11,
  OT_COAP_OPTION_CONTENT_FORMAT = 12,
  OT_COAP_OPTION_MAX_AGE = 14,
  OT_COAP_OPTION_URI_QUERY = 15,
  OT_COAP_OPTION_ACCEPT = 17,
  OT_COAP_OPTION_LOCATION_QUERY = 20,
  OT_COAP_OPTION_BLOCK2 = 23,
  OT_COAP_OPTION_BLOCK1 = 27,
  OT_COAP_OPTION_SIZE2 = 28,
  OT_COAP_OPTION_PROXY_URI = 35,
  OT_COAP_OPTION_PROXY_SCHEME = 39,
  OT_COAP_OPTION_SIZE1 = 60
}
Enum
מספרי אפשרויות של CoAP.
otCoapType{
  OT_COAP_TYPE_CONFIRMABLE = 0,
  OT_COAP_TYPE_NON_CONFIRMABLE = 1,
  OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
  OT_COAP_TYPE_RESET = 3
}
Enum
ערכי סוג CoAP (מספר שלם ללא חתימה של 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
enum otCoapCode
ערכי קוד 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-Path נתון.
otCoapResource typedef
מבנה זה מייצג משאב של CoAP.
otCoapResponseHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
קריאה לפונקציה הזו נקראת כשמתקבלת תגובה ל-CoAP או בזמן הקצוב לבקשה.
otCoapTxParameters typedef
מבנה זה מייצג את הפרמטרים של השידור מ-CoAP.
otCoapType typedef
enum otCoapType
ערכי סוג CoAP (מספר שלם ללא חתימה של 2 ביט).

פונקציות

otCoapAddBlockWiseResource(otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
פונקציה זו מוסיפה משאב נחסם חסימה לשרת CoAP.
otCoapAddResource(otInstance *aInstance, otCoapResource *aResource)
void
פונקציה זו מוסיפה משאב לשרת CoAP.
otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)
uint16_t
הפונקציה הזאת ממירה שדה SZX של אפשרות חסימה ב-CoAP לגודל הבלוק בפועל.
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)
פונקציה זו מצרפת את האפשרות Coup לפורמט תוכן, כפי שצוין בכתובת https://tools.ietf.org/html/rfc7252#page-92.
otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)
הפונקציה הזו מצרפת אפשרות של גיל מקסימלי.
otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)
פונקציה זו מוסיפה אפשרות 'תצפית'.
otCoapMessageAppendOption(otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
פונקציה זו מצרפת אפשרות של CoAP בכותרת.
otCoapMessageAppendProxyUriOption(otMessage *aMessage, const char *aUriPath)
הפונקציה הזו מצורפת אפשרות של 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)
הפונקציה הזו מפעילה הודעת תגובה.
otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)
void
הפונקציה הזו מגדירה את ערך הקוד.
otCoapMessageSetPayloadMarker(otMessage *aMessage)
פונקציה זו מוסיפה את המטען הייעודי (payload סמן) המציין את התחלת המטען הייעודי (payload) לכותרת ה-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

אין תמיכה בשרת proxy.

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

Application/cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application/exi: ["יעילות פורמט XML יעיל (EXI) פורמט 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

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

יישום/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

תג אלקטרוני.

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

שרת proxy.

OT_COAP_OPTION_PROXY_URI

שרת Proxy

OT_COAP_OPTION_SIZE1

מידה1.

OT_COAP_OPTION_SIZE2

גודל2 (RFC7959)

OT_COAP_OPTION_URI_HOST

URI-Host.

OT_COAP_OPTION_URI_PATH

נתיב-יורי.

OT_COAP_OPTION_URI_PORT

אורי-פורט.

OT_COAP_OPTION_URI_QUERY

URI-Query.

סוג 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 עם אפשרות העברה בצורה חכמה.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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)

קריאה לפונקציה הזו נשלחת לפני שהחסימה הבאה נשלחת בהעברה שמחייבת חסימה.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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-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
לא התקבלה תשובה או אישור במהלך תקופת הזמן הקצוב לתפוגה.

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 לגודל הבלוק בפועל.

פרטים
פרמטרים
[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
)

פונקציה זו מצרפת את האפשרות Coup לפורמט תוכן, כפי שצוין בכתובת https://tools.ietf.org/html/rfc7252#page-92.

יש לבצע קריאה זו לפני הגדרת otCoapMessageSetloadloader אם יש לכלול מטען ייעודי בהודעה.

הפונקציה היא wrapper נוח סביב otCoapMessageAppendUintOption. אם הקוד של סוג הפורמט הרצוי אינו מופיע ב-otCoapOptionContentFormat, יש להשתמש בפונקציית הבסיס הזו.

פרטים
פרמטרים
[in,out] aMessage
מצביע להודעה של CoAP.
[in] aContentFormat
אחד מהפורמטים של התוכן המפורטים למעלה ב-otCoapOptionContentFormat:
ערכי החזרה
OT_ERROR_NONE
האפשרות נוספה בהצלחה.
OT_ERROR_INVALID_ARGS
סוג האפשרות אינו שווה לסוג האפשרות האחרון או גדול ממנו.
OT_ERROR_NO_BUFS
אורך האפשרות חורג מגודל המאגר.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

הפונקציה הזו מצרפת אפשרות של גיל מקסימלי.

פרטים
פרמטרים
[in,out] aMessage
מצביע להודעה של CoAP.
[in] aMaxAge
הערך 'גיל מקסימלי'.
ערכי החזרה
OT_ERROR_NONE
האפשרות נוספה בהצלחה.
OT_ERROR_INVALID_ARGS
סוג האפשרות אינו שווה לסוג האפשרות האחרון או גדול ממנו.
OT_ERROR_NO_BUFS
אורך האפשרות חורג מגודל המאגר.

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
אין מספיק מאגרי נתונים זמינים לאתחול הודעת התגובה.

otCoapMessageSetCode

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

הפונקציה הזו מגדירה את ערך הקוד.

פרטים
פרמטרים
[in,out] aMessage
מצביע להודעה של CoAP לאתחול.
[in] aCode
קוד ההודעה של CoAP.

OTCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

פונקציה זו מוסיפה את המטען הייעודי (payload סמן) המציין את התחלת המטען הייעודי (payload) לכותרת ה-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.

otCoapOptionIteratorGetFirstOptionOptioning

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.

otCoapOptionIteratorGetNextOptionOptionMATCHing

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

otCoapOptionIteratorGetOptionValueValue

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 באופן חכם.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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 באופן חכם עם פרמטרים מותאמים של שידור.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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. ערך זה לא יכול להיות קטן מ-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 באופן חכם.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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 עם פרמטרים מותאמים של שידור.

הפונקציה הזו זמינה כאשר מופעלת התצורה של OPEN_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]

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

מאקרו של עוזר להגדיר ערכים של קוד CoAP.

OT_COAP_DEFAULT_IMAGE_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

אורך אסימון כברירת מחדל.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

שידור חוזר מקסימלי שנתמך על ידי OpenThread.

OT_COAP_MAX_IMAGE_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

אורך אסימון מקסימלי כפי שצוין (RFC 7252).

OT_COAP_MIN_ACK_DECREASE

 OT_COAP_MIN_ACK_TIMEOUT 1000

זמן קצוב מינימלי של ACK באלפיות שנייה שנתמך על ידי OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

יציאת ברירת מחדל של CoAP, כפי שצוינה ב-RFC 7252.

מקורות מידע

מקור העזר של OpenThread ב-API הוא מקוד המקור, והוא זמין ב-GitHub. למידע נוסף או כדי לתרום לתיעוד שלנו, יש לעיין בקטע משאבים.