Google berkomitmen untuk mendorong terwujudnya keadilan ras bagi komunitas Kulit Hitam. Lihat caranya.

CoAP

Modul ini mencakup fungsi-fungsi yang mengontrol komunikasi CoAP.

Ringkasan

Fungsi dalam modul ini tersedia ketika fitur CoAP API ( OPENTHREAD_CONFIG_COAP_API_ENABLE ) diaktifkan.

Pencacahan

otCoapBlockSzx enum
Eksponen Ukuran Blok 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
Nilai Kode 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
Kode Format Isi 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
Nomor Opsi CoAP.
otCoapType {
OT_COAP_TYPE_CONFIRMABLE = 0,
OT_COAP_TYPE_NON_CONFIRMABLE = 1,
OT_COAP_TYPE_ACKNOWLEDGMENT = 2,
OT_COAP_TYPE_RESET = 3
}
enum
Nilai Jenis CoAP (2 bit unsigned integer).

Typedefs

otCoapBlockSzx typedef
Eksponen Ukuran Blok CoAP.
otCoapBlockwiseReceiveHook )(void *aContext, const uint8_t *aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength) typedef
Penunjuk fungsi ini dipanggil ketika pesan CoAP dengan opsi transfer blok-bijaksana diterima.
otCoapBlockwiseResource typedef
Struktur ini mewakili sumber CoAP dengan transfer blok-bijaksana.
otCoapBlockwiseTransmitHook )(void *aContext, uint8_t *aBlock, uint32_t aPosition, uint16_t *aBlockLength, bool *aMore) typedef
Penunjuk fungsi ini dipanggil sebelum blok berikutnya dalam transfer bijak dikirim.
otCoapCode typedef
Nilai Kode CoAP.
otCoapOption typedef
struct otCoapOption
Struktur ini mewakili opsi CoAP.
otCoapOptionContentFormat typedef
Kode Format Isi CoAP.
otCoapOptionIterator typedef
Struktur ini bertindak sebagai iterator untuk opsi CoAP.
otCoapOptionType typedef
Nomor Opsi CoAP.
otCoapRequestHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Penunjuk fungsi ini dipanggil ketika permintaan CoAP dengan Uri-Path tertentu diterima.
otCoapResource typedef
Struktur ini mewakili sumber CoAP.
otCoapResponseHandler )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo, otError aResult) typedef
void(*
Penunjuk fungsi ini dipanggil saat respons CoAP diterima atau saat permintaan habis.
otCoapTxParameters typedef
Struktur ini mewakili parameter transmisi CoAP.
otCoapType typedef
Nilai Jenis CoAP (2 bit unsigned integer).

Fungsi

otCoapAddBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
Fungsi ini menambahkan sumber daya blokir ke server CoAP.
otCoapAddResource ( otInstance *aInstance, otCoapResource *aResource)
void
Fungsi ini menambahkan sumber daya ke server CoAP.
otCoapBlockSizeFromExponent ( otCoapBlockSzx aSize)
uint16_t
Fungsi ini mengubah bidang SZX opsi Blok CoAP ke ukuran blok sebenarnya.
otCoapMessageAppendBlock1Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Fungsi ini menambahkan opsi Block1.
otCoapMessageAppendBlock2Option ( otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)
Fungsi ini menambahkan opsi Block2.
otCoapMessageAppendContentFormatOption ( otMessage *aMessage, otCoapOptionContentFormat aContentFormat)
Fungsi ini menambahkan opsi CoAP Format Konten sebagaimana ditentukan di https://tools.ietf.org/html/rfc7252#page-92 .
otCoapMessageAppendMaxAgeOption ( otMessage *aMessage, uint32_t aMaxAge)
Fungsi ini menambahkan opsi Usia Maks.
otCoapMessageAppendObserveOption ( otMessage *aMessage, uint32_t aObserve)
Fungsi ini menambahkan opsi Amati.
otCoapMessageAppendOption ( otMessage *aMessage, uint16_t aNumber, uint16_t aLength, const void *aValue)
Fungsi ini menambahkan opsi CoAP di header.
otCoapMessageAppendProxyUriOption ( otMessage *aMessage, const char *aUriPath)
Fungsi ini menambahkan opsi Proxy-Uri.
otCoapMessageAppendUintOption ( otMessage *aMessage, uint16_t aNumber, uint32_t aValue)
Fungsi ini menambahkan opsi CoAP bilangan bulat tak bertanda tangan seperti yang ditentukan di https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapMessageAppendUriPathOptions ( otMessage *aMessage, const char *aUriPath)
Fungsi ini menambahkan opsi Uri-Path.
otCoapMessageAppendUriQueryOption ( otMessage *aMessage, const char *aUriQuery)
Fungsi ini menambahkan satu opsi Uri-Query.
otCoapMessageCodeToString (const otMessage *aMessage)
const char *
Metode ini mengembalikan Kode CoAP sebagai string yang dapat dibaca manusia.
otCoapMessageGenerateToken ( otMessage *aMessage, uint8_t aTokenLength)
void
Fungsi ini mengatur panjang Token dan mengacak nilainya.
otCoapMessageGetCode (const otMessage *aMessage)
Fungsi ini mengembalikan nilai Kode.
otCoapMessageGetMessageId (const otMessage *aMessage)
uint16_t
Fungsi ini mengembalikan nilai ID Pesan.
otCoapMessageGetToken (const otMessage *aMessage)
const uint8_t *
Fungsi ini mengembalikan pointer ke nilai Token.
otCoapMessageGetTokenLength (const otMessage *aMessage)
uint8_t
Fungsi ini mengembalikan panjang Token.
otCoapMessageGetType (const otMessage *aMessage)
Fungsi ini mengembalikan nilai Type.
otCoapMessageInit ( otMessage *aMessage, otCoapType aType, otCoapCode aCode)
void
Fungsi ini menginisialisasi header CoAP.
otCoapMessageInitResponse ( otMessage *aResponse, const otMessage *aRequest, otCoapType aType, otCoapCode aCode)
Fungsi ini menginisialisasi pesan respons.
otCoapMessageSetPayloadMarker ( otMessage *aMessage)
Fungsi ini menambahkan Payload Marker yang menunjukkan awal payload ke header CoAP.
otCoapMessageSetToken ( otMessage *aMessage, const uint8_t *aToken, uint8_t aTokenLength)
Fungsi ini menetapkan nilai dan panjang Token di header.
otCoapNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
Fungsi ini membuat pesan CoAP baru.
otCoapOptionIteratorGetFirstOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Fungsi ini mengembalikan penunjuk ke opsi pertama.
otCoapOptionIteratorGetFirstOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Fungsi ini mengembalikan penunjuk ke opsi pertama yang cocok dengan nomor opsi yang ditentukan.
otCoapOptionIteratorGetNextOption ( otCoapOptionIterator *aIterator)
const otCoapOption *
Fungsi ini mengembalikan penunjuk ke opsi berikutnya.
otCoapOptionIteratorGetNextOptionMatching ( otCoapOptionIterator *aIterator, uint16_t aOption)
const otCoapOption *
Fungsi ini mengembalikan penunjuk ke opsi berikutnya yang cocok dengan nomor opsi yang ditentukan.
otCoapOptionIteratorGetOptionUintValue ( otCoapOptionIterator *aIterator, uint64_t *aValue)
Fungsi ini mengisi nilai opsi saat ini menjadi aValue dengan asumsi nilai saat ini adalah integer tak bertanda yang dikodekan sesuai dengan https://tools.ietf.org/html/rfc7252#section-3.2 .
otCoapOptionIteratorGetOptionValue ( otCoapOptionIterator *aIterator, void *aValue)
Fungsi ini mengisi nilai opsi saat ini ke dalam aValue .
otCoapOptionIteratorInit ( otCoapOptionIterator *aIterator, const otMessage *aMessage)
Fungsi ini menginisialisasi iterator untuk opsi dalam pesan yang diberikan.
otCoapRemoveBlockWiseResource ( otInstance *aInstance, otCoapBlockwiseResource *aResource)
void
Fungsi ini menghapus sumber daya blokir dari server CoAP.
otCoapRemoveResource ( otInstance *aInstance, otCoapResource *aResource)
void
Fungsi ini menghapus sumber daya dari server CoAP.
otCoapSendRequest ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext)
Fungsi ini mengirimkan permintaan CoAP.
otCoapSendRequestBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
Fungsi ini mengirimkan permintaan CoAP secara blok.
otCoapSendRequestBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)
Fungsi ini mengirimkan permintaan CoAP dengan bijak dengan parameter transmisi khusus.
otCoapSendRequestWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, otCoapResponseHandler aHandler, void *aContext, const otCoapTxParameters *aTxParameters)
Fungsi ini mengirimkan permintaan CoAP dengan parameter transmisi khusus.
otCoapSendResponse ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Fungsi ini mengirimkan respons CoAP dari server.
otCoapSendResponseBlockWise ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
Fungsi ini mengirimkan respons CoAP dari server.
otCoapSendResponseBlockWiseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)
Fungsi ini mengirimkan respons CoAP secara blokir dari server dengan parameter transmisi khusus.
otCoapSendResponseWithParameters ( otInstance *aInstance, otMessage *aMessage, const otMessageInfo *aMessageInfo, const otCoapTxParameters *aTxParameters)
Fungsi ini mengirimkan respons CoAP dari server dengan parameter transmisi khusus.
otCoapSetDefaultHandler ( otInstance *aInstance, otCoapRequestHandler aHandler, void *aContext)
void
Fungsi ini menyetel penangan default untuk permintaan CoAP yang tidak tertangani.
otCoapStart ( otInstance *aInstance, uint16_t aPort)
Fungsi ini memulai server CoAP.
otCoapStop ( otInstance *aInstance)
Fungsi ini menghentikan server CoAP.

Structs

otCoapBlockwiseResource

Struktur ini mewakili sumber CoAP dengan transfer blok-bijaksana.

otCoapOption

Struktur ini mewakili opsi CoAP.

otCoapOptionIterator

Struktur ini bertindak sebagai iterator untuk opsi CoAP.

otCoapResource

Struktur ini mewakili sumber CoAP.

otCoapTxParameters

Struktur ini mewakili parameter transmisi CoAP.

Pencacahan

otCoapBlockSzx

 otCoapBlockSzx

Eksponen Ukuran Blok CoAP.

otCoapCode

 otCoapCode

Nilai Kode CoAP.

Properti
OT_COAP_CODE_BAD_GATEWAY

Gateway Buruk.

OT_COAP_CODE_BAD_OPTION

Opsi Buruk.

OT_COAP_CODE_BAD_REQUEST

Permintaan yang buruk.

OT_COAP_CODE_CHANGED

Berubah.

OT_COAP_CODE_CONTENT

Kandungan.

OT_COAP_CODE_CONTINUE

RFC7959 Lanjutkan.

OT_COAP_CODE_CREATED

Dibuat.

OT_COAP_CODE_DELETE

Menghapus.

OT_COAP_CODE_DELETED

Dihapus.

OT_COAP_CODE_EMPTY

Kode pesan kosong.

OT_COAP_CODE_FORBIDDEN

Terlarang.

OT_COAP_CODE_GATEWAY_TIMEOUT

Gateway Timeout.

OT_COAP_CODE_GET

Dapatkan.

OT_COAP_CODE_INTERNAL_ERROR

Kesalahan server dari dalam.

OT_COAP_CODE_METHOD_NOT_ALLOWED

Metode Tidak Diizinkan.

OT_COAP_CODE_NOT_ACCEPTABLE

Tidak dapat diterima.

OT_COAP_CODE_NOT_FOUND

Tidak ditemukan.

OT_COAP_CODE_NOT_IMPLEMENTED

Tidak Diterapkan.

OT_COAP_CODE_POST

Pos.

OT_COAP_CODE_PRECONDITION_FAILED

Prasyarat Gagal.

OT_COAP_CODE_PROXY_NOT_SUPPORTED

Proxying Tidak Didukung.

OT_COAP_CODE_PUT

Taruh.

OT_COAP_CODE_REQUEST_INCOMPLETE

RFC7959 Permintaan Entitas Tidak Lengkap.

OT_COAP_CODE_REQUEST_TOO_LARGE

Entitas Permintaan Terlalu Besar.

OT_COAP_CODE_RESPONSE_MIN

2.00

OT_COAP_CODE_SERVICE_UNAVAILABLE

Layanan tidak tersedia.

OT_COAP_CODE_UNAUTHORIZED

Tidak resmi.

OT_COAP_CODE_UNSUPPORTED_FORMAT

Format Konten Tidak Didukung.

OT_COAP_CODE_VALID

Sah.

otCoapOptionContentFormat

 otCoapOptionContentFormat

Kode Format Isi CoAP.

Daftar lengkapnya didokumentasikan di https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

Properti
OT_COAP_OPTION_CONTENT_FORMAT_CBOR

aplikasi / cbor: [RFC7049]

OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON

application / coap-group + json: [RFC7390]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT

aplikasi / cose; cose-type = "cose-encrypt": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0

aplikasi / cose; cose-type = "cose-encrypt0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY

aplikasi / cose-key: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET

application / cose-key-set: [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC

aplikasi / cose; cose-type = "cose-mac": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0

aplikasi / cose; cose-type = "cose-mac0": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN

aplikasi / cose; cose-type = "cose-sign": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1

aplikasi / cose; cose-type = "cose-sign1": [RFC8152]

OT_COAP_OPTION_CONTENT_FORMAT_CWT

application / cwt: [RFC8392]

OT_COAP_OPTION_CONTENT_FORMAT_EXI

application / exi: ["Efficient XML Interchange (EXI) Format 1.0 (Edisi Kedua)", Februari 2014]

OT_COAP_OPTION_CONTENT_FORMAT_JSON

application / json: [RFC7159]

OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON

application / json-patch + json: [RFC6902]

OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT

aplikasi / format-tautan: [RFC6690]

OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON

application / merge-patch + json: [RFC7396]

OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM

aplikasi / aliran oktet: [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

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

teks / biasa; charset = utf-8: [RFC2046] [RFC3676] [RFC5147]

OT_COAP_OPTION_CONTENT_FORMAT_XML

aplikasi / xml: [RFC3023]

otCoapOptionType

 otCoapOptionType

otCoapType

 otCoapType

Nilai Jenis CoAP (2 bit unsigned integer).

Properti
OT_COAP_TYPE_ACKNOWLEDGMENT

Pengakuan.

OT_COAP_TYPE_CONFIRMABLE

Dapat dikonfirmasi.

OT_COAP_TYPE_NON_CONFIRMABLE

Tidak dapat dikonfirmasi.

OT_COAP_TYPE_RESET

Setel ulang.

Typedefs

otCoapBlockSzx

enum otCoapBlockSzx otCoapBlockSzx

Eksponen Ukuran Blok CoAP.

otCoapBlockwiseReceiveHook

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

Penunjuk fungsi ini dipanggil ketika pesan CoAP dengan opsi transfer blok-bijaksana diterima.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail
Parameter
[in] aContext
Penunjuk ke konteks khusus aplikasi.
[in] aBlock
Penunjuk ke segmen blok.
[in] aPosition
Posisi aBlock secara berurutan dalam byte.
[in] aBlockLength
Panjang segmen blok dalam byte.
[in] aMore
Tandai jika lebih banyak segmen blok mengikuti.
[in] aTotalLength
Panjang total dalam byte dari informasi yang ditransfer (ditunjukkan dengan opsi Size1 atau Size2).
Kembalikan Nilai
OT_ERROR_NONE
Segmen blok berhasil disimpan.
OT_ERROR_NO_BUFS
Tidak ada lagi memori untuk menyimpan blok.
OT_ERROR_NO_FRAME_RECEIVED
Blokir segmen hilang.

otCoapBlockwiseResource

struct otCoapBlockwiseResource otCoapBlockwiseResource

Struktur ini mewakili sumber CoAP dengan transfer blok-bijaksana.

otCoapBlockwiseTransmitHook

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

Penunjuk fungsi ini dipanggil sebelum blok berikutnya dalam transfer bijak dikirim.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Dengan mengubah nilai aBlockLength, ukuran blok dari seluruh pertukaran dinegosiasikan ulang. Direkomendasikan untuk melakukan ini setelah blok pertama diterima karena perubahan selanjutnya dapat menyebabkan masalah dengan implementasi CoAP lainnya.

Detail
Parameter
[in] aContext
Penunjuk ke konteks khusus aplikasi.
[in,out] aBlock
Penunjuk ke tempat segmen blok dapat ditulis.
[in] aPosition
Posisi secara berurutan untuk mendapatkan segmen blok.
[in,out] aBlockLength
Pada entri, panjang segmen blok maksimum dalam byte.
[out] aMore
Sebuah penunjuk ke bendera jika lebih banyak segmen blok akan mengikuti.
Kembalikan Nilai
OT_ERROR_NONE
Tidak ada kesalahan.
OT_ERROR_INVALID_ARGS
Blokir di aPosition tidak ada.

otCoapCode

enum otCoapCode otCoapCode

Nilai Kode CoAP.

otCoapOption

struct otCoapOption otCoapOption

Struktur ini mewakili opsi CoAP.

otCoapOptionContentFormat

enum otCoapOptionContentFormat otCoapOptionContentFormat

Kode Format Isi CoAP.

Daftar lengkapnya didokumentasikan di https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

Struktur ini bertindak sebagai iterator untuk opsi CoAP.

otCoapOptionType

enum otCoapOptionType otCoapOptionType

Nomor Opsi CoAP.

otCoapRequestHandler

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

Penunjuk fungsi ini dipanggil ketika permintaan CoAP dengan Uri-Path tertentu diterima.

Detail
Parameter
[in] aContext
Penunjuk ke informasi konteks arbitrer.
[in] aMessage
Penunjuk ke pesan.
[in] aMessageInfo
aMessage ke info pesan untuk aMessage .

otCoapResource

struct otCoapResource otCoapResource

Struktur ini mewakili sumber CoAP.

otCoapResponseHandler

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

Penunjuk fungsi ini dipanggil saat respons CoAP diterima atau saat permintaan habis.

Detail
Parameter
[in] aContext
Penunjuk ke konteks khusus aplikasi.
[in] aMessage
Sebuah pointer ke buffer pesan yang berisi respons. NULL jika tidak ada respon yang diterima.
[in] aMessageInfo
aMessage ke info pesan untuk aMessage . NULL jika tidak ada respon yang diterima.
[in] aResult
Hasil dari transaksi CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Tanggapan berhasil diterima.
OT_ERROR_ABORT
Transaksi CoAP diatur ulang oleh rekan.
OT_ERROR_RESPONSE_TIMEOUT
Tidak ada tanggapan atau pengakuan yang diterima selama periode batas waktu.

otCoapTxParameters

struct otCoapTxParameters otCoapTxParameters

Struktur ini mewakili parameter transmisi CoAP.

otCoapType

enum otCoapType otCoapType

Nilai Jenis CoAP (2 bit unsigned integer).

Fungsi

otCoapAddBlockWiseResource

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Fungsi ini menambahkan sumber daya dengan blokir ke server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aResource
Penunjuk ke sumber daya.

otCoapAddResource

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Fungsi ini menambahkan sumber daya ke server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aResource
Penunjuk ke sumber daya.

otCoapBlockSizeFromExponent

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

Fungsi ini mengubah bidang SZX opsi Blok CoAP ke ukuran blok sebenarnya.

Detail
Parameter
[in] aSize
Eksponen ukuran blok.
Kembali
Nilai eksponen ukuran sebenarnya.

otCoapMessageAppendBlock1Option

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

Fungsi ini menambahkan opsi Block1.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aNum
Nomor blok saat ini.
[in] aMore
Boolean untuk menunjukkan lebih banyak blok yang akan dikirim.
[in] aSize
Eksponen Ukuran Blok.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendBlock2Option

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

Fungsi ini menambahkan opsi Block2.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aNum
Nomor blok saat ini.
[in] aMore
Boolean untuk menunjukkan lebih banyak blok yang akan dikirim.
[in] aSize
Eksponen Ukuran Blok.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendContentFormatOption

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

Fungsi ini menambahkan opsi CoAP Format Konten seperti yang ditentukan di https://tools.ietf.org/html/rfc7252#page-92 .

Ini harus dipanggil sebelum menyetel otCoapMessageSetPayloadMarker jika payload akan disertakan dalam pesan.

Fungsinya adalah pembungkus praktis di sekitar otCoapMessageAppendUintOption, dan jika kode jenis format yang diinginkan tidak terdaftar di otCoapOptionContentFormat, fungsi dasar ini harus digunakan.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aContentFormat
Salah satu format konten yang tercantum di otCoapOptionContentFormat di atas.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendMaxAgeOption

otError otCoapMessageAppendMaxAgeOption(
  otMessage *aMessage,
  uint32_t aMaxAge
)

Fungsi ini menambahkan opsi Usia Maks.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aMaxAge
Nilai Usia Maks.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendObserveOption

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Fungsi ini menambahkan opsi Amati.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aObserve
Amati nilai bidang.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendOption

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

Fungsi ini menambahkan opsi CoAP di header.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aNumber
Nomor Opsi CoAP.
[in] aLength
Panjang Opsi CoAP.
[in] aValue
Penunjuk ke nilai CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendProxyUriOption

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

Fungsi ini menambahkan opsi Proxy-Uri.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aUriPath
Sebuah pointer ke string yang diakhiri NULL.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendUintOption

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

Fungsi ini menambahkan opsi CoAP bilangan bulat tak bertanda tangan seperti yang ditentukan di https://tools.ietf.org/html/rfc7252#section-3.2 .

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aNumber
Nomor Opsi CoAP.
[in] aValue
Nilai integer tidak bertanda tangan Opsi CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.
Lihat juga:
otCoapMessageGetOptionUintValue

otCoapMessageAppendUriPathOptions

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

Fungsi ini menambahkan opsi Uri-Path.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aUriPath
Sebuah pointer ke string yang diakhiri NULL.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageAppendUriQueryOption

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

Fungsi ini menambahkan satu opsi Uri-Query.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aUriQuery
Sebuah pointer ke string yang diakhiri NULL, yang harus berisi pasangan kunci = nilai tunggal.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menambahkan opsi.
OT_ERROR_INVALID_ARGS
Jenis opsi tidak sama atau lebih besar dari jenis opsi terakhir.
OT_ERROR_NO_BUFS
Panjang opsi melebihi ukuran buffer.

otCoapMessageCodeToString

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Metode ini mengembalikan Kode CoAP sebagai string yang dapat dibaca manusia.

@ mengembalikan Kode CoAP sebagai string.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.

otCoapMessageGenerateToken

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Fungsi ini mengatur panjang Token dan mengacak nilainya.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aTokenLength
Panjang Token untuk disetel.

otCoapMessageGetCode

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Fungsi ini mengembalikan nilai Kode.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.
Kembali
Nilai Kode.

otCoapMessageGetMessageId

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Fungsi ini mengembalikan nilai ID Pesan.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.
Kembali
Nilai ID Pesan.

otCoapMessageGetToken

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Fungsi ini mengembalikan pointer ke nilai Token.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.
Kembali
Penunjuk ke nilai Token.

otCoapMessageGetTokenLength

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Fungsi ini mengembalikan panjang Token.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.
Kembali
Panjang Token.

otCoapMessageGetType

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Fungsi ini mengembalikan nilai Type.

Detail
Parameter
[in] aMessage
Penunjuk ke pesan CoAP.
Kembali
Nilai Jenis.

otCoapMessageInit

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

Fungsi ini menginisialisasi header CoAP.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP untuk menginisialisasi.
[in] aType
Jenis pesan CoAP.
[in] aCode
Kode pesan CoAP.

otCoapMessageInitResponse

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

Fungsi ini menginisialisasi pesan respons.

Detail
Parameter
[in,out] aResponse
Penunjuk ke pesan tanggapan CoAP.
[in] aRequest
Penunjuk ke pesan permintaan CoAP.
[in] aType
Jenis pesan CoAP.
[in] aCode
Kode pesan CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menginisialisasi pesan tanggapan.
OT_ERROR_NO_BUFS
Buffer pesan yang tersedia tidak mencukupi untuk menginisialisasi pesan tanggapan.

otCoapMessageSetPayloadMarker

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Fungsi ini menambahkan Payload Marker yang menunjukkan awal payload ke header CoAP.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Payload Marker berhasil ditambahkan.
OT_ERROR_NO_BUFS
Header Payload Marker melebihi ukuran buffer.

otCoapMessageSetToken

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

Fungsi ini menetapkan nilai dan panjang Token di header.

Detail
Parameter
[in,out] aMessage
Penunjuk ke pesan CoAP.
[in] aToken
Penunjuk ke nilai Token.
[in] aTokenLength
Panjangnya aToken .
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur nilai Token.
OT_ERROR_NO_BUFS
Buffer tidak cukup untuk mengatur nilai Token.

otCoapNewMessage

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

Fungsi ini membuat pesan CoAP baru.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aSettings
Sebuah penunjuk ke pengaturan pesan atau NULL untuk mengatur pengaturan default.
Kembali
Sebuah pointer ke buffer pesan atau NULL jika tidak ada buffer pesan yang tersedia atau parameter tidak valid.

otCoapOptionIteratorGetFirstOption

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

Fungsi ini mengembalikan penunjuk ke opsi pertama.

Detail
Parameter
[in,out] aIterator
Penunjuk ke iterator opsi pesan CoAP.
Kembali
Penunjuk ke opsi pertama. Jika tidak ada opsi yang ada, pointer NULL dikembalikan.

otCoapOptionIteratorGetFirstOptionMatching

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

Fungsi ini mengembalikan penunjuk ke opsi pertama yang cocok dengan nomor opsi yang ditentukan.

Detail
Parameter
[in] aIterator
Penunjuk ke iterator opsi pesan CoAP.
[in] aOption
Nomor opsi dicari.
Kembali
Penunjuk ke opsi pencocokan pertama. Jika tidak ada opsi yang cocok, pointer NULL dikembalikan.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Fungsi ini mengembalikan penunjuk ke opsi berikutnya.

Detail
Parameter
[in,out] aIterator
Penunjuk ke iterator opsi pesan CoAP.
Kembali
Penunjuk ke opsi berikutnya. Jika tidak ada lagi pilihan yang ada, pointer NULL dikembalikan.

otCoapOptionIteratorGetNextOptionMatching

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

Fungsi ini mengembalikan penunjuk ke opsi berikutnya yang cocok dengan nomor opsi yang ditentukan.

Detail
Parameter
[in] aIterator
Penunjuk ke iterator opsi pesan CoAP.
[in] aOption
Nomor opsi dicari.
Kembali
Penunjuk ke opsi pencocokan berikutnya. Jika tidak ada opsi pencocokan lebih lanjut, pointer NULL dikembalikan.

otCoapOptionIteratorGetOptionUintValue

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

Fungsi ini mengisi nilai opsi saat ini menjadi aValue dengan asumsi nilai saat ini adalah bilangan bulat tak bertanda yang dikodekan sesuai dengan https://tools.ietf.org/html/rfc7252#section-3.2 .

Detail
Parameter
[in,out] aIterator
Penunjuk ke iterator opsi pesan CoAP.
[out] aValue
Penunjuk ke integer yang tidak ditandatangani untuk menerima nilai opsi.
Kembalikan Nilai
OT_ERROR_NONE
Nilai berhasil diisi.
OT_ERROR_NOT_FOUND
Tidak ada opsi saat ini.
OT_ERROR_NO_BUFS
Nilai terlalu panjang untuk dimasukkan ke dalam uint64_t.
Lihat juga:
otCoapMessageAppendUintOption

otCoapOptionIteratorGetOptionValue

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Fungsi ini mengisi nilai opsi saat ini ke dalam aValue .

Detail
Parameter
[in,out] aIterator
Penunjuk ke iterator opsi pesan CoAP.
[out] aValue
Sebuah pointer ke buffer untuk menerima nilai opsi.
Kembalikan Nilai
OT_ERROR_NONE
Nilai berhasil diisi.
OT_ERROR_NOT_FOUND
Tidak ada opsi saat ini.

otCoapOptionIteratorInit

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

Fungsi ini menginisialisasi iterator untuk opsi dalam pesan yang diberikan.

Detail
Parameter
[in,out] aIterator
Penunjuk ke iterator opsi pesan CoAP.
[in] aMessage
Penunjuk ke pesan CoAP.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil dijalankan.
OT_ERROR_PARSE
Status pesan tidak konsisten.

otCoapRemoveBlockWiseResource

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Fungsi ini menghapus sumber daya blokir dari server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aResource
Penunjuk ke sumber daya.

otCoapRemoveResource

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Fungsi ini menghapus sumber daya dari server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aResource
Penunjuk ke sumber daya.

otCoapSendRequest

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

Fungsi ini mengirimkan permintaan CoAP.

Jika respons untuk permintaan diharapkan, fungsi dan konteks informasi masing-masing harus disediakan. Jika tidak ada respons yang diharapkan, argumen ini harus berupa pointer NULL.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Penunjuk ke pesan yang akan dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aHandler
Sebuah penunjuk fungsi yang akan dipanggil pada penerimaan respons atau batas waktu.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengirim pesan CoAP.
OT_ERROR_NO_BUFS
Gagal mengalokasikan data transmisi ulang.

otCoapSendRequestBlockWise

otError otCoapSendRequestBlockWise(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

Fungsi ini mengirimkan permintaan CoAP secara blok.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Jika respons untuk permintaan diharapkan, fungsi dan konteks informasi masing-masing harus disediakan. Jika respon diharapkan dari segi blok, fungsi hook masing-masing harus disediakan. Jika tidak ada respons yang diharapkan, argumen ini harus berupa pointer NULL.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Penunjuk ke pesan yang akan dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aHandler
Sebuah penunjuk fungsi yang akan dipanggil pada penerimaan respons atau batas waktu.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
[in] aTransmitHook
Sebuah pointer ke fungsi hook untuk transfer keluar blok-bijaksana.
[in] aReceiveHook
Sebuah penunjuk ke fungsi hook untuk transfer bijak-blok yang masuk.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengirim pesan CoAP.
OT_ERROR_NO_BUFS
Gagal mengalokasikan data transmisi ulang.

otCoapSendRequestBlockWiseWithParameters

otError otCoapSendRequestBlockWiseWithParameters(
  otInstance *aInstance,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo,
  otCoapResponseHandler aHandler,
  void *aContext,
  const otCoapTxParameters *aTxParameters,
  otCoapBlockwiseTransmitHook aTransmitHook,
  otCoapBlockwiseReceiveHook aReceiveHook
)

Fungsi ini mengirimkan permintaan CoAP dengan bijak dengan parameter transmisi khusus.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Jika respons untuk permintaan diharapkan, fungsi dan konteks informasi masing-masing harus disediakan. Jika respon diharapkan dari segi blok, fungsi hook masing-masing harus disediakan. Jika tidak ada respons yang diharapkan, argumen ini harus berupa pointer NULL.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Penunjuk ke pesan yang akan dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aHandler
Sebuah penunjuk fungsi yang akan dipanggil pada penerimaan respons atau batas waktu.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
[in] aTxParameters
Sebuah penunjuk ke parameter transmisi untuk permintaan ini. Gunakan NULL sebagai default.
[in] aTransmitHook
Sebuah pointer ke fungsi hook untuk transfer keluar blok-bijaksana.
[in] aReceiveHook
Sebuah penunjuk ke fungsi hook untuk transfer bijak-blok yang masuk.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengirim pesan CoAP.
OT_ERROR_NO_BUFS
Gagal mengalokasikan data transmisi ulang.

otCoapSendRequestWithParameters

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

Fungsi ini mengirimkan permintaan CoAP dengan parameter transmisi khusus.

Jika respons untuk permintaan diharapkan, fungsi dan konteks informasi masing-masing harus disediakan. Jika tidak ada respons yang diharapkan, argumen ini harus berupa pointer NULL.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Penunjuk ke pesan yang akan dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aHandler
Sebuah penunjuk fungsi yang akan dipanggil pada penerimaan respons atau batas waktu.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
[in] aTxParameters
Sebuah penunjuk ke parameter transmisi untuk permintaan ini. Gunakan NULL sebagai default. Jika tidak, parameter yang diberikan harus memenuhi ketentuan berikut:
  1. mMaxRetransmit tidak lebih dari OT_COAP_MAX_RETRANSMIT.
  2. mAckRandomFactorNumerator / mAckRandomFactorDenominator tidak boleh di bawah 1.0.
  3. Waktu hidup pertukaran yang dihitung tidak boleh melebihi uint32_t.
Kembalikan Nilai
OT_ERROR_INVALID_ARGS
aTxParameters tidak valid.
OT_ERROR_NONE
Berhasil mengirim pesan CoAP.
OT_ERROR_NO_BUFS
Gagal mengalokasikan data transmisi ulang.

otCoapSendResponse

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

Fungsi ini mengirimkan respons CoAP dari server.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Sebuah pointer ke respon CoAP untuk dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan tanggapan CoAP.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk mengirim tanggapan CoAP.

otCoapSendResponseBlockWise

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

Fungsi ini mengirimkan respons CoAP dari server.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Sebuah pointer ke respon CoAP untuk dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
[in] aTransmitHook
Sebuah pointer ke fungsi hook untuk transfer keluar blok-bijaksana.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan tanggapan CoAP.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk mengirim tanggapan CoAP.

otCoapSendResponseBlockWiseWithParameters

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

Fungsi ini mengirimkan respons CoAP secara blokir dari server dengan parameter transmisi khusus.

Fungsi ini tersedia saat konfigurasi OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Sebuah pointer ke respon CoAP untuk dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aTxParameters
Sebuah penunjuk ke parameter transmisi untuk respon ini. Gunakan NULL sebagai default.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.
[in] aTransmitHook
Sebuah pointer ke fungsi hook untuk transfer keluar blok-bijaksana.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan tanggapan CoAP.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk mengirim tanggapan CoAP.

otCoapSendResponseWithParameters

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

Fungsi ini mengirimkan respons CoAP dari server dengan parameter transmisi khusus.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Sebuah pointer ke respon CoAP untuk dikirim.
[in] aMessageInfo
aMessage ke info pesan yang terkait dengan aMessage .
[in] aTxParameters
Sebuah penunjuk ke parameter transmisi untuk respon ini. Gunakan NULL sebagai default.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mengantrekan pesan tanggapan CoAP.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk mengirim tanggapan CoAP.

otCoapSetDefaultHandler

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

Fungsi ini menyetel penangan default untuk permintaan CoAP yang tidak tertangani.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aHandler
Sebuah penunjuk fungsi yang akan dipanggil ketika permintaan yang tidak tertangani tiba.
[in] aContext
Sebuah penunjuk ke informasi konteks yang berubah-ubah. Mungkin NULL jika tidak digunakan.

otCoapStart

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Fungsi ini memulai server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aPort
Porta UDP lokal yang akan diikat.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil memulai server CoAP.
OT_ERROR_FAILED
Gagal memulai server CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Fungsi ini menghentikan server CoAP.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil menghentikan server CoAP.

Makro

OT_COAP_CODE

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

Makro pembantu untuk menentukan nilai CoAP Code.

OT_COAP_DEFAULT_TOKEN_LENGTH

 OT_COAP_DEFAULT_TOKEN_LENGTH 2

Panjang token default.

OT_COAP_MAX_RETRANSMIT

 OT_COAP_MAX_RETRANSMIT 20

Max retransmit didukung oleh OpenThread.

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Panjang token maksimum seperti yang ditentukan (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Batas waktu ACK minimal dalam milidetik yang didukung oleh OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Port CoAP default, seperti yang ditentukan dalam RFC 7252.