Google cam kết thúc đẩy công bằng chủng tộc cho Cộng đồng người da đen. Xem cách thực hiện.
Trang này được dịch bởi Cloud Translation API.
Switch to English

CoAP

Mô-đun này bao gồm các chức năng điều khiển giao tiếp CoAP.

Tóm lược

Các chức năng trong mô-đun này khả dụng khi tính năng API OPENTHREAD_CONFIG_COAP_API_ENABLE ( OPENTHREAD_CONFIG_COAP_API_ENABLE ) được bật.

Bảng kê

otCoapBlockSize enum
Số mũ kích thước khối 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
Giá trị mã 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
Mã định dạng nội dung 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_PROXY_URI = 35,
OT_COAP_OPTION_PROXY_SCHEME = 39,
OT_COAP_OPTION_SIZE1 = 60
}
enum
Số tùy chọn CoAP.
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
enum
Giá trị kiểu CoAP (số nguyên không dấu 2 bit).

Typedefs

otCoapBlockSize typedef
Số mũ kích thước khối CoAP.
otCoapCode typedef
Giá trị mã CoAP.
otCoapOption typedef
struct otCoapOption
Cấu trúc này đại diện cho một tùy chọn CoAP.
otCoapOptionContentFormat typedef
Mã định dạng nội dung CoAP.
otCoapOptionIterator typedef
Cấu trúc này hoạt động như một trình lặp cho các tùy chọn CoAP.
otCoapOptionType typedef
Số tùy chọn CoAP.
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Con trỏ hàm này được gọi khi nhận được yêu cầu CoAP với Uri-Path nhất định.
otCoapResource typedef
Cấu trúc này đại diện cho một tài nguyên CoAP.
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
Con trỏ hàm này được gọi khi nhận được phản hồi CoAP hoặc khi yêu cầu hết thời gian chờ.
otCoapTxParameters typedef
Cấu trúc này đại diện cho các tham số truyền CoAP.
otCoapType typedef
Giá trị kiểu CoAP (số nguyên không dấu 2 bit).

Chức năng

otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
Chức năng này thêm một tài nguyên vào máy chủ CoAP.
otCoapBlockSizeFromExponent ( otCoapBlockSize aSize)
uint16_t
Hàm này chuyển đổi trường SZX tùy chọn CoAP Block thành kích thước khối thực.
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSize aSize)
Hàm này thêm một tùy chọn Block1.
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSize aSize)
Chức năng này thêm một tùy chọn Block2.
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
Hàm này gắn thêm tùy chọn CoAP Định dạng Nội dung như được chỉ định trong https://tools.ietf.org/html/rfc7252#page-92 .
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)
Hàm này thêm tùy chọn Max-Age.
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)
Chức năng này thêm tùy chọn Quan sát.
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
Hàm này thêm một tùy chọn CoAP trong tiêu đề.
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath)
Chức năng này thêm tùy chọn Proxy-Uri.
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
Hàm này gắn một tùy chọn CoAP số nguyên không dấu như được chỉ định trong https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath)
Hàm này thêm tùy chọn Uri-Path.
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery)
Hàm này thêm vào một tùy chọn Uri-Query.
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
Phương thức này trả về Mã CoAP dưới dạng chuỗi con người có thể đọc được.
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)
void
Hàm này đặt độ dài Token và ngẫu nhiên hóa giá trị của nó.
otCoapMessageGetCode (const otMessage *aMessage)
Hàm này trả về giá trị Mã.
otCoapMessageGetMessageId (const otMessage *aMessage)
uint16_t
Hàm này trả về giá trị ID tin nhắn.
otCoapMessageGetToken (const otMessage *aMessage)
const uint8_t *
Hàm này trả về một con trỏ đến giá trị Token.
otCoapMessageGetTokenLength (const otMessage *aMessage)
uint8_t
Hàm này trả về độ dài mã thông báo.
otCoapMessageGetType (const otMessage *aMessage)
Hàm này trả về giá trị Kiểu.
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
Hàm này khởi tạo tiêu đề CoAP.
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
Hàm này khởi tạo một thông báo phản hồi.
otCoapMessageSetPayloadMarker ( otMessage *aMessage)
Chức năng này thêm Payload Marker cho biết điểm bắt đầu của payload vào tiêu đề CoAP.
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
Hàm này đặt giá trị và độ dài Mã thông báo trong tiêu đề.
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
Chức năng này tạo một thông báo CoAP mới.
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Hàm này trả về một con trỏ đến tùy chọn đầu tiên.
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Hàm này trả về một con trỏ đến tùy chọn đầu tiên phù hợp với số tùy chọn đã chỉ định.
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Hàm này trả về một con trỏ đến tùy chọn tiếp theo.
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Hàm này trả về một con trỏ đến tùy chọn tiếp theo khớp với số tùy chọn đã chỉ định.
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *aValue)
Hàm này điền giá trị tùy chọn hiện tại vào aValue giả sử giá trị hiện tại là một số nguyên không dấu được mã hóa theo https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue)
Hàm này điền giá trị tùy chọn hiện tại vào aValue .
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage)
Hàm này khởi tạo một trình lặp cho các tùy chọn trong thông báo đã cho.
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
Chức năng này xóa tài nguyên khỏi máy chủ CoAP.
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
Hàm này gửi một yêu cầu CoAP.
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
Hàm này gửi một yêu cầu CoAP với các tham số truyền tùy chỉnh.
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Chức năng này gửi phản hồi CoAP từ máy chủ.
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
Chức năng này gửi phản hồi CoAP từ máy chủ với các tham số truyền tùy chỉnh.
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
Hàm này đặt trình xử lý mặc định cho các yêu cầu CoAP chưa được xử lý.
otCoapStart ( otInstance *aInstance, uint16_t aPort)
Chức năng này khởi động máy chủ CoAP.
otCoapStop ( otInstance *aInstance)
Chức năng này dừng máy chủ CoAP.

Cấu trúc

otCoapOption

Cấu trúc này đại diện cho một tùy chọn CoAP.

otCoapOptionIterator

Cấu trúc này hoạt động như một trình lặp cho các tùy chọn CoAP.

otCoapResource

Cấu trúc này đại diện cho một tài nguyên CoAP.

otCoapTxParameters

Cấu trúc này đại diện cho các tham số truyền CoAP.

Bảng kê

otCoapBlockSize

 otCoapBlockSize

Số mũ kích thước khối CoAP.

otCoapCode

 otCoapCode

Giá trị mã CoAP.

Tính chất
OT_COAP_CODE_BAD_GATEWAY

Cổng xấu.

OT_COAP_CODE_BAD_OPTION

Tùy chọn tồi.

OT_COAP_CODE_BAD_REQUEST

Yêu cầu không hợp lệ.

OT_COAP_CODE_CHANGED

Đã thay đổi.

OT_COAP_CODE_CONTENT

Nội dung.

OT_COAP_CODE_CONTINUE

RFC7959 Tiếp tục.

OT_COAP_CODE_CREATED

Tạo.

OT_COAP_CODE_DELETE

Xóa bỏ.

OT_COAP_CODE_DELETED

Đã xóa.

OT_COAP_CODE_EMPTY

Mã tin nhắn trống.

OT_COAP_CODE_FORBIDDEN

Cấm.

OT_COAP_CODE_GATEWAY_TIMEOUT

Cổng Time-out.

OT_COAP_CODE_GET

Được.

OT_COAP_CODE_INTERNAL_ERROR

Lỗi máy chủ nội bộ.

OT_COAP_CODE_METHOD_NOT_ALLOWED

Phương pháp không được phép.

OT_COAP_CODE_NOT_ACCEPTABLE

Không thể chấp nhận.

OT_COAP_CODE_NOT_FOUND

Không tìm thấy.

OT_COAP_CODE_NOT_IMPLEMENTED

Không được thực hiện.

OT_COAP_CODE_POST

Bài đăng.

OT_COAP_CODE_PRECONDITION_FAILED

Điều kiện tiên quyết không thành công.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxy không được hỗ trợ.

OT_COAP_CODE_PUT

Đặt.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 Thực thể Yêu cầu Chưa hoàn thành.

OT_COAP_CODE_REQUEST_TOO_LARGE

Yêu cầu đối tượng quá lớn.

OT_COAP_CODE_RESPONSE_MIN

2,00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Dịch vụ Không sẵn có.

OT_COAP_CODE_UNAUTHORIZED

Không được phép.

OT_COAP_CODE_UNSUPPORTED_FORMAT

Định dạng-Nội dung không được hỗ trợ.

OT_COAP_CODE_VALID

Có hiệu lực.

otCoapOptionContentFormat

 otCoapOptionContentFormat

Mã định dạng nội dung CoAP.

Danh sách đầy đủ được ghi lại tại https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

Tính chất
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

ứng dụng / cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application / coap-group + json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

ứng dụng / cose; cose-type = "cose-encode": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

ứng dụng / cose; cose-type = "cose-encode0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

ứng dụng / khóa cose: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

application / cose-key-set: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

ứng dụng / cose; cose-type = "cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

ứng dụng / cose; cose-type = "cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

ứng dụng / cose; cose-type = "cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

ứng dụng / cose; cose-type = "cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

ứng dụng / cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application / exi: ["Định dạng trao đổi XML hiệu quả (EXI) 1.0 (Phiên bản thứ hai)", tháng 2 năm 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

ứng dụng / json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application / json-patch + json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

ứng dụng / định dạng liên kết: [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

văn bản / thuần túy; charset = utf-8: [RFC2046] [RFC3676] [RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

ứng dụng / xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

Số tùy chọn CoAP.

Tính chất
OT_COAP_OPTION_ACCEPT

Chấp nhận.

OT_COAP_OPTION_BLOCK1

Khối 1 (RFC7959)

OT_COAP_OPTION_BLOCK2

Khối 2 (RFC7959)

OT_COAP_OPTION_CONTENT_FORMAT

Nội dung-Định dạng.

OT_COAP_OPTION_E_TAG

ETag.

OT_COAP_OPTION_IF_MATCH

Nếu-Đối sánh.

OT_COAP_OPTION_IF_NONE_MATCH

Nếu-Không-Khớp.

OT_COAP_OPTION_LOCATION_PATH

Vị trí-Đường dẫn.

OT_COAP_OPTION_LOCATION_QUERY

Vị trí-Truy vấn.

OT_COAP_OPTION_MAX_AGE

Tuổi tối đa.

OT_COAP_OPTION_OBSERVE

Quan sát [RFC7641].

OT_COAP_OPTION_PROXY_SCHEME

Proxy-Scheme.

OT_COAP_OPTION_PROXY_URI

Proxy-Uri.

OT_COAP_OPTION_SIZE1

Kích thước 1.

OT_COAP_OPTION_URI_HOST

Máy chủ lưu trữ nước tiểu.

OT_COAP_OPTION_URI_PATH

Đường dẫn nước tiểu.

OT_COAP_OPTION_URI_PORT

Cổng Uri.

OT_COAP_OPTION_URI_QUERY

Truy vấn nước tiểu.

otCoapType

 otCoapType

Giá trị kiểu CoAP (số nguyên không dấu 2 bit).

Tính chất
OT_COAP_TYPE_ACKNOWLEDGMENT

Nhìn nhận.

OT_COAP_TYPE_CONFIRMABLE

Có thể xác nhận.

OT_COAP_TYPE_NON_CONFIRMABLE

Không thể xác nhận.

OT_COAP_TYPE_RESET

Cài lại.

Typedefs

otCoapBlockSize

enum otCoapBlockSize otCoapBlockSize

Số mũ kích thước khối CoAP.

otCoapCode

enum otCoapCode otCoapCode

Giá trị mã CoAP.

otCoapOption

struct otCoapOption otCoapOption

Cấu trúc này đại diện cho một tùy chọn CoAP.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

Mã định dạng nội dung CoAP.

Danh sách đầy đủ được ghi lại tại https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

Cấu trúc này hoạt động như một trình lặp cho các tùy chọn CoAP.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

Số tùy chọn CoAP.

otCoapRequestHandler

void(* otCoapRequestHandler)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)

Con trỏ hàm này được gọi khi nhận được yêu cầu CoAP với Uri-Path nhất định.

Chi tiết
Thông số
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý.
[in] aMessage
Một con trỏ đến tin nhắn.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn cho aMessage .

otCoapResource

struct otCoapResource otCoapResource

Cấu trúc này đại diện cho một tài nguyên CoAP.

otCoapResponseHandler

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

Con trỏ hàm này được gọi khi nhận được phản hồi CoAP hoặc khi yêu cầu hết thời gian chờ.

Chi tiết
Thông số
[in] aContext
Một con trỏ đến ngữ cảnh dành riêng cho ứng dụng.
[in] aMessage
Một con trỏ đến bộ đệm thư có chứa phản hồi. NULL nếu không nhận được phản hồi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn cho aMessage . NULL nếu không nhận được phản hồi.
[in] aResult
Kết quả của giao dịch CoAP.
Giá trị trả lại
OT_ERROR_NONE
Đã nhận được phản hồi thành công.
OT_ERROR_ABORT
Một giao dịch CoAP đã được đặt lại bởi ngang hàng.
OT_ERROR_RESPONSE_TIMEOUT
Không nhận được phản hồi hoặc xác nhận trong khoảng thời gian chờ.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

Cấu trúc này đại diện cho các tham số truyền CoAP.

otCoapType

enum otCoapType otCoapType

Giá trị kiểu CoAP (số nguyên không dấu 2 bit).

Chức năng

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Chức năng này thêm một tài nguyên vào máy chủ CoAP.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aResource
Một con trỏ đến tài nguyên.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSize aSize
)

Hàm này chuyển đổi trường SZX tùy chọn CoAP Block thành kích thước khối thực.

Chi tiết
Thông số
[in] aSize
Số mũ kích thước khối.
Lợi nhuận
Giá trị số mũ kích thước thực tế.

otCoapMessageAppendBlock1Option

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

Chức năng này thêm một tùy chọn Block1.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aNum
Số khối hiện tại.
[in] aMore
Boolean để chỉ ra nhiều khối hơn sẽ được gửi.
[in] aSize
Số mũ kích thước khối.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendBlock2Option

otError otCoapMessageAppendBlock2Option(
  otMessage *aMessage,
  uint32_t aNum,
  bool aMore,
  otCoapBlockSize aSize
)

Chức năng này thêm một tùy chọn Block2.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aNum
Số khối hiện tại.
[in] aMore
Boolean để chỉ ra nhiều khối hơn sẽ được gửi.
[in] aSize
Số mũ kích thước khối.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

Hàm này gắn thêm tùy chọn CoAP Định dạng Nội dung như được chỉ định trong https://tools.ietf.org/html/rfc7252#page-92 .

Điều này phải được gọi trước khi thiết lập otCoapMessageSetPayloadMarker nếu một tải trọng được đưa vào thư.

Hàm là một trình bao bọc tiện lợi xung quanh otCoapMessageAppendUintOption và nếu mã loại định dạng mong muốn không được liệt kê trong otCoapOptionContentFormat, thì hàm cơ sở này sẽ được sử dụng thay thế.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aContentFormat
Một trong những định dạng nội dung được liệt kê trong otCoapOptionContentFormat ở trên.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Hàm này thêm tùy chọn Max-Age.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aMaxAge
Giá trị Max-Age.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Chức năng này thêm tùy chọn Quan sát.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aObserve
Quan sát giá trị trường.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendOption

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

Hàm này thêm một tùy chọn CoAP trong tiêu đề.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aNumber
Số tùy chọn CoAP.
[in] aLength
Độ dài tùy chọn CoAP.
[in] aValue
Một con trỏ đến giá trị CoAP.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendProxyUriOption

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

Chức năng này thêm tùy chọn Proxy-Uri.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aUriPath
Một con trỏ đến một chuỗi được kết thúc bằng NULL.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendUintOption

otError otCoapMessageAppendUintOption(
  otMessage *aMessage,
  uint16_t aNumber,
  uint32_t aValue
)

Hàm này thêm một tùy chọn CoAP số nguyên không dấu như được chỉ định trong https://tools.ietf.org/html/rfc7252#section-3.2 .

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aNumber
Số tùy chọn CoAP.
[in] aValue
Giá trị số nguyên không dấu của CoAP Option.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.
Xem thêm:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

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

Hàm này thêm tùy chọn Uri-Path.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aUriPath
Một con trỏ đến một chuỗi được kết thúc bằng NULL.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageAppendUriQueryOption

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

Hàm này thêm vào một tùy chọn Uri-Query.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aUriQuery
Một con trỏ đến chuỗi được kết thúc bằng NULL, phải chứa một cặp khóa = giá trị.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm thành công tùy chọn.
OT_ERROR_INVALID_ARGS
Loại tùy chọn không bằng hoặc lớn hơn loại tùy chọn cuối cùng.
OT_ERROR_NO_BUFS
Chiều dài tùy chọn vượt quá kích thước bộ đệm.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Phương thức này trả về Mã CoAP dưới dạng chuỗi có thể đọc được của con người.

@ trả về Mã CoAP dưới dạng chuỗi.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Hàm này đặt độ dài Token và ngẫu nhiên hóa giá trị của nó.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aTokenLength
Độ dài của Mã thông báo cần đặt.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Hàm này trả về giá trị Mã.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.
Lợi nhuận
Giá trị mã.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Hàm này trả về giá trị ID tin nhắn.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.
Lợi nhuận
Giá trị ID tin nhắn.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Hàm này trả về một con trỏ đến giá trị Token.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.
Lợi nhuận
Một con trỏ đến giá trị Mã thông báo.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Hàm này trả về độ dài mã thông báo.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.
Lợi nhuận
Độ dài mã thông báo.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Hàm này trả về giá trị Kiểu.

Chi tiết
Thông số
[in] aMessage
Một con trỏ đến thông báo CoAP.
Lợi nhuận
Giá trị Loại.

otCoapMessageInit

void otCoapMessageInit(
  otMessage *aMessage,
  otCoapType aType,
  otCoapCode aCode
)

Hàm này khởi tạo tiêu đề CoAP.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP để khởi tạo.
[in] aType
Loại tin nhắn CoAP.
[in] aCode
Mã tin nhắn CoAP.

otCoapMessageInitResponse

otError otCoapMessageInitResponse(
  otMessage *aResponse,
  const otMessage *aRequest,
  otCoapType aType,
  otCoapCode aCode
)

Hàm này khởi tạo một thông báo phản hồi.

Chi tiết
Thông số
[in,out] aResponse
Một con trỏ đến thông báo phản hồi CoAP.
[in] aRequest
Một con trỏ đến thông báo yêu cầu CoAP.
[in] aType
Loại tin nhắn CoAP.
[in] aCode
Mã tin nhắn CoAP.
Giá trị trả lại
OT_ERROR_NONE
Đã khởi tạo thành công thông báo phản hồi.
OT_ERROR_NO_BUFS
Không đủ bộ đệm thông báo có sẵn để khởi tạo thông báo phản hồi.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Chức năng này thêm Payload Marker cho biết điểm bắt đầu của payload vào tiêu đề CoAP.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
Giá trị trả lại
OT_ERROR_NONE
Đã thêm Payload Marker thành công.
OT_ERROR_NO_BUFS
Header Payload Marker vượt quá kích thước bộ đệm.

otCoapMessageSetToken

otError otCoapMessageSetToken(
  otMessage *aMessage,
  const uint8_t *aToken,
  uint8_t aTokenLength
)

Hàm này đặt giá trị và độ dài Mã thông báo trong tiêu đề.

Chi tiết
Thông số
[in,out] aMessage
Một con trỏ đến thông báo CoAP.
[in] aToken
Một con trỏ đến giá trị Mã thông báo.
[in] aTokenLength
Độ dài của aToken .
Giá trị trả lại
OT_ERROR_NONE
Đặt thành công giá trị Mã thông báo.
OT_ERROR_NO_BUFS
Không đủ bộ đệm để đặt giá trị Mã thông báo.

otCoapNewMessage

otMessage * otCoapNewMessage(
  otInstance *aInstance,
  const otMessageSettings *aSettings
)

Chức năng này tạo một thông báo CoAP mới.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aSettings
Một con trỏ đến cài đặt tin nhắn hoặc NULL để đặt cài đặt mặc định.
Lợi nhuận
Một con trỏ đến bộ đệm thông báo hoặc NULL nếu không có bộ đệm thông báo nào hoặc các tham số không hợp lệ.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

Hàm này trả về một con trỏ đến tùy chọn đầu tiên.

Chi tiết
Thông số
[in,out] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
Lợi nhuận
Một con trỏ đến tùy chọn đầu tiên. Nếu không có tùy chọn nào thì con trỏ NULL được trả về.

otCoapOptionIteratorGetFirstOptionMatching

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

Hàm này trả về một con trỏ đến tùy chọn đầu tiên phù hợp với số tùy chọn đã chỉ định.

Chi tiết
Thông số
[in] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
[in] aOption
Số tùy chọn được tìm kiếm.
Lợi nhuận
Một con trỏ đến tùy chọn kết hợp đầu tiên. Nếu không có tùy chọn phù hợp nào thì con trỏ NULL được trả về.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Hàm này trả về một con trỏ đến tùy chọn tiếp theo.

Chi tiết
Thông số
[in,out] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
Lợi nhuận
Một con trỏ đến tùy chọn tiếp theo. Nếu không có thêm tùy chọn nào thì con trỏ NULL được trả về.

otCoapOptionIteratorGetNextOptionMatching

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

Hàm này trả về một con trỏ đến tùy chọn tiếp theo khớp với số tùy chọn đã chỉ định.

Chi tiết
Thông số
[in] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
[in] aOption
Số tùy chọn được tìm kiếm.
Lợi nhuận
Một con trỏ đến tùy chọn kết hợp tiếp theo. Nếu không có tùy chọn so khớp nào hiện tại thì con trỏ NULL được trả về.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

Hàm này điền giá trị tùy chọn hiện tại vào aValue giả sử giá trị hiện tại là một số nguyên không dấu được mã hóa theo https://tools.ietf.org/html/rfc7252#section-3.2 .

Chi tiết
Thông số
[in,out] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
[out] aValue
Một con trỏ đến một số nguyên không dấu để nhận giá trị tùy chọn.
Giá trị trả lại
OT_ERROR_NONE
Giá trị được điền thành công.
OT_ERROR_NOT_FOUND
Không có tùy chọn hiện tại.
OT_ERROR_NO_BUFS
Giá trị quá dài để vừa với uint64_t.
Xem thêm:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Hàm này điền giá trị tùy chọn hiện tại vào aValue .

Chi tiết
Thông số
[in,out] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
[out] aValue
Một con trỏ tới bộ đệm để nhận giá trị tùy chọn.
Giá trị trả lại
OT_ERROR_NONE
Đã điền thành công giá trị.
OT_ERROR_NOT_FOUND
Không có tùy chọn hiện tại.

otCoapOptionIteratorInit

otError otCoapOptionIteratorInit(
  otCoapOptionIterator *aIterator,
  const otMessage *aMessage
)

Hàm này khởi tạo một trình lặp cho các tùy chọn trong thông báo đã cho.

Chi tiết
Thông số
[in,out] aIterator
Một con trỏ đến trình lặp tùy chọn thông báo CoAP.
[in] aMessage
Một con trỏ đến thông báo CoAP.
Giá trị trả lại
OT_ERROR_NONE
Đã khởi tạo thành công.
OT_ERROR_PARSE
Trạng thái thông báo không nhất quán.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Chức năng này xóa tài nguyên khỏi máy chủ CoAP.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aResource
Một con trỏ đến tài nguyên.

otCoapSendRequest

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

Hàm này gửi một yêu cầu CoAP.

Nếu mong đợi một phản hồi cho một yêu cầu, thông tin về chức năng và ngữ cảnh tương ứng phải được cung cấp. Nếu không có phản hồi được mong đợi, các đối số này phải là con trỏ NULL.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Một con trỏ đến tin nhắn để gửi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn được liên kết với aMessage .
[in] aHandler
Một con trỏ chức năng sẽ được gọi khi nhận phản hồi hoặc thời gian chờ.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý. Có thể là NULL nếu không được sử dụng.
Giá trị trả lại
OT_ERROR_NONE
Đã gửi thành công tin nhắn CoAP.
OT_ERROR_NO_BUFS
Không thể phân bổ dữ liệu truyền lại.

otCoapSendRequestWithParameters

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

Hàm này gửi một yêu cầu CoAP với các tham số truyền tùy chỉnh.

Nếu mong đợi một phản hồi cho một yêu cầu, thông tin về chức năng và ngữ cảnh tương ứng phải được cung cấp. Nếu không có phản hồi được mong đợi, các đối số này phải là con trỏ NULL.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Một con trỏ đến tin nhắn để gửi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn được liên kết với aMessage .
[in] aHandler
Một con trỏ chức năng sẽ được gọi khi nhận phản hồi hoặc thời gian chờ.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý. Có thể là NULL nếu không được sử dụng.
[in] aTxParameters
Một con trỏ đến các tham số truyền cho yêu cầu này. Sử dụng NULL cho các giá trị mặc định. Nếu không, các tham số được cung cấp phải đáp ứng các điều kiện sau:
  1. mMaxRetransmit không quá OT_COAP_MAX_RETRANSMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator không được dưới 1,0.
  3. Thời gian tồn tại của Exchange được tính toán không được làm tràn uint32_t.
Giá trị trả lại
OT_ERROR_INVALID_ARGS
aTxParameters không hợp lệ.
OT_ERROR_NONE
Đã gửi thành công tin nhắn CoAP.
OT_ERROR_NO_BUFS
Không thể phân bổ dữ liệu truyền lại.

otCoapSendResponse

otError otCoapSendResponse(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Chức năng này gửi phản hồi CoAP từ máy chủ.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Một con trỏ đến phản hồi CoAP để gửi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn được liên kết với aMessage .
Giá trị trả lại
OT_ERROR_NONE
Đã xếp hàng thành công thông báo phản hồi CoAP.
OT_ERROR_NO_BUFS
Không có đủ bộ đệm để gửi phản hồi CoAP.

otCoapSendResponseWithParameters

otError otCoapSendResponseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  const otCoapTxParameters *aTxParameters
)

Chức năng này gửi phản hồi CoAP từ máy chủ với các tham số truyền tùy chỉnh.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aMessage
Một con trỏ đến phản hồi CoAP để gửi.
[in] aMessageInfo
Một con trỏ đến thông tin tin nhắn được liên kết với aMessage .
[in] aTxParameters
Một con trỏ đến các tham số truyền cho phản hồi này. Sử dụng NULL cho các giá trị mặc định.
Giá trị trả lại
OT_ERROR_NONE
Đã xếp hàng thành công thông báo phản hồi CoAP.
OT_ERROR_NO_BUFS
Không có đủ bộ đệm để gửi phản hồi CoAP.

otCoapSetDefaultHandler

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

Hàm này đặt trình xử lý mặc định cho các yêu cầu CoAP chưa được xử lý.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aHandler
Một con trỏ hàm sẽ được gọi khi có yêu cầu chưa xử lý.
[in] aContext
Một con trỏ đến thông tin ngữ cảnh tùy ý. Có thể là NULL nếu không được sử dụng.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Chức năng này khởi động máy chủ CoAP.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
[in] aPort
Cổng UDP cục bộ để liên kết.
Giá trị trả lại
OT_ERROR_NONE
Khởi động thành công máy chủ CoAP.
OT_ERROR_FAILED
Không khởi động được máy chủ CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Chức năng này dừng máy chủ CoAP.

Chi tiết
Thông số
[in] aInstance
Một con trỏ đến một phiên bản OpenThread.
Giá trị trả lại
OT_ERROR_NONE
Đã dừng thành công máy chủ CoAP.

Macro

OT_COAP_CODE

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

Macro người trợ giúp để xác định giá trị Mã CoAP.

OT_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

Độ dài mã thông báo mặc định.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

Truyền lại tối đa được hỗ trợ bởi OpenThread.

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Độ dài mã thông báo tối đa như đã chỉ định (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Thời gian chờ ACK tối thiểu tính bằng mili giây được OpenThread hỗ trợ.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Cổng CoAP mặc định, như được chỉ định trong RFC 7252.