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

Halaman ini diterjemahkan oleh Cloud Translation API.

coAP

Modul ini mencakup fungsi yang mengontrol komunikasi CoAP.

Ringkasan

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

Enumerasi
`otCoapBlockSzx`	enum Pangkat 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 Konten 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 (bilangan bulat tanpa tanda tangan 2 bit).

Typedef
`otCoapBlockSzx`	typedef `enum otCoapBlockSzx` Pangkat Ukuran Blok CoAP.
`otCoapBlockwiseReceiveHook)(void aContext, const uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore, uint32_t aTotalLength)`	typedef `otError(*` Pointer dipanggil saat pesan CoAP dengan opsi transfer block-wise diterima.
`otCoapBlockwiseResource`	typedef `struct otCoapBlockwiseResource` Mewakili resource CoAP dengan transfer block-wise.
`otCoapBlockwiseTransmitHook)(void aContext, uint8_t aBlock, uint32_t aPosition, uint16_t aBlockLength, bool aMore)`	typedef `otError(*` Pointer dipanggil sebelum blok berikutnya dalam transfer block-wise dikirim.
`otCoapCode`	typedef `enum otCoapCode` Nilai Kode CoAP.
`otCoapOption`	typedef `struct otCoapOption` Mewakili opsi CoAP.
`otCoapOptionContentFormat`	typedef `enum otCoapOptionContentFormat` Kode Format Konten CoAP.
`otCoapOptionIterator`	typedef `struct otCoapOptionIterator` Berfungsi sebagai iterator untuk opsi CoAP.
`otCoapOptionType`	typedef `enum otCoapOptionType` Nomor Opsi CoAP.
`otCoapRequestHandler)(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo)`	typedef `void(*` Pointer dipanggil saat permintaan CoAP dengan Uri-Path tertentu diterima.
`otCoapResource`	typedef `struct otCoapResource` Mewakili resource CoAP.
`otCoapResponseHandler)(void aContext, otMessage aMessage, const otMessageInfo *aMessageInfo, otError aResult)`	typedef `void(*` Pointer dipanggil saat respons CoAP diterima atau pada waktu tunggu permintaan.
`otCoapTxParameters`	typedef `struct otCoapTxParameters` Merepresentasikan parameter transmisi CoAP.
`otCoapType`	typedef `enum otCoapType` Nilai Jenis CoAP (bilangan bulat tanpa tanda tangan 2 bit).

Fungsi
`otCoapAddBlockWiseResource(otInstance aInstance, otCoapBlockwiseResource aResource)`	`void` Menambahkan resource block-wise ke server CoAP.
`otCoapAddResource(otInstance aInstance, otCoapResource aResource)`	`void` Menambahkan resource ke server CoAP.
`otCoapBlockSizeFromExponent(otCoapBlockSzx aSize)`	`uint16_t` Mengonversi kolom SZX opsi CoAP Block ke ukuran blok yang sebenarnya.
`otCoapMessageAppendBlock1Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` Menambahkan opsi Block1.
`otCoapMessageAppendBlock2Option(otMessage *aMessage, uint32_t aNum, bool aMore, otCoapBlockSzx aSize)`	`otError` Menambahkan opsi Block2.
`otCoapMessageAppendContentFormatOption(otMessage *aMessage, otCoapOptionContentFormat aContentFormat)`	`otError` Menambahkan opsi CoAP Format Konten seperti yang ditentukan di https://tools.ietf.org/html/rfc7252#page-92.
`otCoapMessageAppendMaxAgeOption(otMessage *aMessage, uint32_t aMaxAge)`	`otError` Menambahkan opsi Usia Maks.
`otCoapMessageAppendObserveOption(otMessage *aMessage, uint32_t aObserve)`	`otError` Menambahkan opsi Observasi.
`otCoapMessageAppendOption(otMessage aMessage, uint16_t aNumber, uint16_t aLength, const void aValue)`	`otError` Menambahkan opsi CoAP di header.
`otCoapMessageAppendProxyUriOption(otMessage aMessage, const char aUriPath)`	`otError` Menambahkan opsi Proxy-Uri.
`otCoapMessageAppendUintOption(otMessage *aMessage, uint16_t aNumber, uint32_t aValue)`	`otError` Menambahkan opsi CoAP bilangan bulat tanpa tanda tangan seperti yang ditentukan dalam https://tools.ietf.org/html/rfc7252#section-3.2.
`otCoapMessageAppendUriPathOptions(otMessage aMessage, const char aUriPath)`	`otError` Menambahkan opsi Jalur URI.
`otCoapMessageAppendUriQueryOption(otMessage aMessage, const char aUriQuery)`	`otError` Menambahkan satu opsi Kueri URI.
`otCoapMessageCodeToString(const otMessage *aMessage)`	`const char *` Menampilkan Kode CoAP sebagai string yang dapat dibaca manusia.
`otCoapMessageGenerateToken(otMessage *aMessage, uint8_t aTokenLength)`	`void` Menetapkan panjang Token dan mengacak nilainya.
`otCoapMessageGetCode(const otMessage *aMessage)`	`otCoapCode` Menampilkan nilai Kode.
`otCoapMessageGetMessageId(const otMessage *aMessage)`	`uint16_t` Menampilkan nilai ID Pesan.
`otCoapMessageGetToken(const otMessage *aMessage)`	`const uint8_t *` Menampilkan pointer ke nilai Token.
`otCoapMessageGetTokenLength(const otMessage *aMessage)`	`uint8_t` Menampilkan panjang Token.
`otCoapMessageGetType(const otMessage *aMessage)`	`otCoapType` Menampilkan nilai Jenis.
`otCoapMessageInit(otMessage *aMessage, otCoapType aType, otCoapCode aCode)`	`void` Menginisialisasi header CoAP.
`otCoapMessageInitResponse(otMessage aResponse, const otMessage aRequest, otCoapType aType, otCoapCode aCode)`	`otError` Menginisialisasi pesan respons.
`otCoapMessageSetCode(otMessage *aMessage, otCoapCode aCode)`	`void` Menetapkan nilai Kode.
`otCoapMessageSetPayloadMarker(otMessage *aMessage)`	`otError` Menambahkan Penanda Payload yang menunjukkan awal payload ke header CoAP.
`otCoapMessageSetToken(otMessage aMessage, const uint8_t aToken, uint8_t aTokenLength)`	`otError` Menetapkan nilai dan panjang Token di header.
`otCoapNewMessage(otInstance aInstance, const otMessageSettings aSettings)`	`otMessage *` Membuat pesan CoAP baru.
`otCoapOptionIteratorGetFirstOption(otCoapOptionIterator *aIterator)`	`const otCoapOption *` Menampilkan pointer ke opsi pertama.
`otCoapOptionIteratorGetFirstOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)`	`const otCoapOption *` Menampilkan pointer ke opsi pertama yang cocok dengan nomor opsi yang ditentukan.
`otCoapOptionIteratorGetNextOption(otCoapOptionIterator *aIterator)`	`const otCoapOption *` Menampilkan pointer ke opsi berikutnya.
`otCoapOptionIteratorGetNextOptionMatching(otCoapOptionIterator *aIterator, uint16_t aOption)`	`const otCoapOption *` Menampilkan pointer ke opsi berikutnya yang cocok dengan nomor opsi yang ditentukan.
`otCoapOptionIteratorGetOptionUintValue(otCoapOptionIterator aIterator, uint64_t aValue)`	`otError` Mengisi nilai opsi saat ini menjadi `aValue` dengan asumsi nilai saat ini adalah bilangan bulat tanpa tanda tangan yang dienkode sesuai dengan https://tools.ietf.org/html/rfc7252#section-3.2.
`otCoapOptionIteratorGetOptionValue(otCoapOptionIterator aIterator, void aValue)`	`otError` Mengisi nilai opsi saat ini ke `aValue`.
`otCoapOptionIteratorInit(otCoapOptionIterator aIterator, const otMessage aMessage)`	`otError` Menginisialisasi iterator untuk opsi pada pesan yang diberikan.
`otCoapRemoveBlockWiseResource(otInstance aInstance, otCoapBlockwiseResource aResource)`	`void` Menghapus resource block-wise dari server CoAP.
`otCoapRemoveResource(otInstance aInstance, otCoapResource aResource)`	`void` Menghapus resource dari server CoAP.
`otCoapSendRequest(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext)`	`otError` Mengirim permintaan CoAP.
`otCoapSendRequestBlockWise(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` Mengirim permintaan CoAP secara block-wise.
`otCoapSendRequestBlockWiseWithParameters(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters, otCoapBlockwiseTransmitHook aTransmitHook, otCoapBlockwiseReceiveHook aReceiveHook)`	`otError` Mengirim permintaan CoAP secara block-wise dengan parameter transmisi kustom.
`otCoapSendRequestWithParameters(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, otCoapResponseHandler aHandler, void aContext, const otCoapTxParameters *aTxParameters)`	`otError` Mengirim permintaan CoAP dengan parameter transmisi kustom.
`otCoapSendResponse(otInstance aInstance, otMessage aMessage, const otMessageInfo *aMessageInfo)`	`otError` Mengirim respons CoAP dari server.
`otCoapSendResponseBlockWise(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, void aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` Mengirim respons CoAP secara blok dari server.
`otCoapSendResponseBlockWiseWithParameters(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters, void *aContext, otCoapBlockwiseTransmitHook aTransmitHook)`	`otError` Mengirim respons CoAP secara blok-wise dari server dengan parameter transmisi kustom.
`otCoapSendResponseWithParameters(otInstance aInstance, otMessage aMessage, const otMessageInfo aMessageInfo, const otCoapTxParameters aTxParameters)`	`otError` Mengirim respons CoAP dari server dengan parameter transmisi kustom.
`otCoapSetDefaultHandler(otInstance aInstance, otCoapRequestHandler aHandler, void aContext)`	`void` Menetapkan pengendali default untuk permintaan CoAP yang tidak tertangani.
`otCoapStart(otInstance *aInstance, uint16_t aPort)`	`otError` Memulai server CoAP.
`otCoapStop(otInstance *aInstance)`	`otError` Menghentikan server CoAP.

Struct
otCoapBlockwiseResource	Mewakili resource CoAP dengan transfer block-wise.
otCoapOption	Mewakili opsi CoAP.
otCoapOptionIterator	Berfungsi sebagai iterator untuk opsi CoAP.
otCoapResource	Mewakili resource CoAP.
otCoapTxParameters	Merepresentasikan parameter transmisi CoAP.

Enumerasi

{i>otCoapBlockSzx<i}

 otCoapBlockSzx

Pangkat Ukuran Blok CoAP.

Kode {i>otCoap<i}

 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`	Diubah.
`OT_COAP_CODE_CONTENT`	Konten.
`OT_COAP_CODE_CONTINUE`	Lanjutkan RFC7959.
`OT_COAP_CODE_CREATED`	Dibuat.
`OT_COAP_CODE_DELETE`	Hapus.
`OT_COAP_CODE_DELETED`	Dihapus.
`OT_COAP_CODE_EMPTY`	Kode pesan kosong.
`OT_COAP_CODE_FORBIDDEN`	Akses Dilarang.
`OT_COAP_CODE_GATEWAY_TIMEOUT`	Waktu Tunggu Gateway.
`OT_COAP_CODE_GET`	Dapatkan.
`OT_COAP_CODE_INTERNAL_ERROR`	Galat Server Internal.
`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`	Postingan.
`OT_COAP_CODE_PRECONDITION_FAILED`	Prasyarat Gagal.
`OT_COAP_CODE_PROXY_NOT_SUPPORTED`	Proxy Tidak Didukung.
`OT_COAP_CODE_PUT`	Masukan.
`OT_COAP_CODE_REQUEST_INCOMPLETE`	Entitas Permintaan RFC7959 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 sah.
`OT_COAP_CODE_UNSUPPORTED_FORMAT`	Format Konten Tidak Didukung.
`OT_COAP_CODE_VALID`	Valid.

{i>otCoapOptionContentFormat<i}

 otCoapOptionContentFormat

Kode Format Konten 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`	aplikasi/coap-group+json: [RFC7390]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT`	application/cose; cose-type="cose-encrypt": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0`	application/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`	application/cose; cose-type="cose-mac": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0`	application/cose; cose-type="cose-mac0": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN`	application/cose; cose-type="cose-sign": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1`	application/cose; cose-type="cose-sign1": [RFC8152]
`OT_COAP_OPTION_CONTENT_FORMAT_CWT`	aplikasi/cwt: [RFC8392]
`OT_COAP_OPTION_CONTENT_FORMAT_EXI`	aplikasi/exi: ["Ecommerce XML Interchange (EXI) Format 1.0 (Second Edition)", 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 link: [RFC6690]
`OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON`	application/merge-patch+json: [RFC7396]
`OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM`	aplikasi/octet-stream: [RFC2045][RFC2046]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR`	application/senml+cbor: [RFC8428]
`OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI`	aplikasi/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`	teks/biasa; charset=utf-8: [RFC2046][RFC3676][RFC5147]
`OT_COAP_OPTION_CONTENT_FORMAT_XML`	application/xml: [RFC3023]

{i>otCoapOptionType<i}

 otCoapOptionType

Nomor Opsi CoAP.

Properti
`OT_COAP_OPTION_ACCEPT`	Setujui.
`OT_COAP_OPTION_BLOCK1`	Blok1 (RFC7959)
`OT_COAP_OPTION_BLOCK2`	Blok2 (RFC7959)
`OT_COAP_OPTION_CONTENT_FORMAT`	Format-Konten.
`OT_COAP_OPTION_E_TAG`	ETag.
`OT_COAP_OPTION_IF_MATCH`	Jika Cocok.
`OT_COAP_OPTION_IF_NONE_MATCH`	Jika-Tidak Ada-Kecocokan.
`OT_COAP_OPTION_LOCATION_PATH`	Jalur Lokasi.
`OT_COAP_OPTION_LOCATION_QUERY`	Kueri Lokasi.
`OT_COAP_OPTION_MAX_AGE`	Usia Maks.
`OT_COAP_OPTION_OBSERVE`	Perhatikan [RFC7641].
`OT_COAP_OPTION_PROXY_SCHEME`	{i>Proxy-Scheme<i}.
`OT_COAP_OPTION_PROXY_URI`	Proxy-Uri.
`OT_COAP_OPTION_SIZE1`	Ukuran1.
`OT_COAP_OPTION_SIZE2`	Ukuran2 (RFC7959)
`OT_COAP_OPTION_URI_HOST`	URI-Host.
`OT_COAP_OPTION_URI_PATH`	Jalur URI.
`OT_COAP_OPTION_URI_PORT`	Porta URI.
`OT_COAP_OPTION_URI_QUERY`	Kueri URI.

{i>otCoapType<i}

 otCoapType

Nilai Jenis CoAP (bilangan bulat tanpa tanda tangan 2 bit).

Properti
`OT_COAP_TYPE_ACKNOWLEDGMENT`	Konfirmasi.
`OT_COAP_TYPE_CONFIRMABLE`	Dapat dikonfirmasi.
`OT_COAP_TYPE_NON_CONFIRMABLE`	Tidak dapat dikonfirmasi.
`OT_COAP_TYPE_RESET`	Reset.

Typedef

{i>otCoapBlockSzx<i}

enum otCoapBlockSzx otCoapBlockSzx

Pangkat Ukuran Blok CoAP.

{i>otCoapBlockwiseReceiveHook<i}

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

Pointer dipanggil saat pesan CoAP dengan opsi transfer block-wise diterima.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail

Parameter

`[in] aContext`	Pointer ke konteks khusus aplikasi.
`[in] aBlock`	Pointer ke segmen blok.
`[in] aPosition`	Posisi `aBlock` dalam urutan dalam byte.
`[in] aBlockLength`	Panjang segmen blok dalam byte.
`[in] aMore`	Tandai jika ada segmen blok lainnya yang mengikuti.
`[in] aTotalLength`	Panjang total dalam byte informasi yang ditransfer (ditunjukkan dengan opsi Size1 atau Size2).

Nilai Hasil

`OT_ERROR_NONE`	Segmen blok berhasil disimpan.
`OT_ERROR_NO_BUFS`	Tidak ada lagi memori untuk menyimpan blok.
`OT_ERROR_NO_FRAME_RECEIVED`	Segmen blok tidak ada.

{i>otCoapBlockwiseResource<i}

struct otCoapBlockwiseResource otCoapBlockwiseResource

Mewakili resource CoAP dengan transfer block-wise.

{i>otCoapBlockwiseTransmitHook<i}

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

Pointer dipanggil sebelum blok berikutnya dalam transfer block-wise dikirim.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Dengan mengubah nilai aBlockLength, ukuran blok di seluruh bursa dinegosiasi ulang. Sebaiknya lakukan hal ini setelah blok pertama diterima karena perubahan berikutnya dapat menyebabkan masalah dengan implementasi CoAP lainnya.

Detail

Parameter

`[in] aContext`	Pointer ke konteks khusus aplikasi.
`[in,out] aBlock`	Pointer tempat segmen blok dapat ditulis.
`[in] aPosition`	Posisi dalam urutan untuk mendapatkan segmen blok.
`[in,out] aBlockLength`	Saat entri, panjang segmen blok maksimum dalam byte.
`[out] aMore`	Pointer ke tanda jika lebih banyak segmen blok akan mengikuti.

Nilai Hasil

`OT_ERROR_NONE`	Tidak ada kesalahan.
`OT_ERROR_INVALID_ARGS`	Blok di `aPosition` tidak ada.

Kode {i>otCoap<i}

enum otCoapCode otCoapCode

Nilai Kode CoAP.

Opsi OtCoap

struct otCoapOption otCoapOption

Mewakili opsi CoAP.

{i>otCoapOptionContentFormat<i}

enum otCoapOptionContentFormat otCoapOptionContentFormat

Kode Format Konten CoAP.

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

otCoapOptionIterator

struct otCoapOptionIterator otCoapOptionIterator

Berfungsi sebagai iterator untuk opsi CoAP.

{i>otCoapOptionType<i}

enum otCoapOptionType otCoapOptionType

Nomor Opsi CoAP.

{i>otCoapRequestHandler<i}

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

Pointer dipanggil saat permintaan CoAP dengan Uri-Path tertentu diterima.

Detail

Parameter

`[in] aContext`	Pointer ke informasi konteks arbitrer.
`[in] aMessage`	Pointer ke pesan.
`[in] aMessageInfo`	Pointer ke info pesan untuk `aMessage`.

{i>otCoapResource<i}

struct otCoapResource otCoapResource

Mewakili resource CoAP.

otCoapResponseHandler

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

Pointer dipanggil saat respons CoAP diterima atau pada waktu tunggu permintaan.

Detail

Parameter

`[in] aContext`	Pointer ke konteks khusus aplikasi.
`[in] aMessage`	Pointer ke buffering pesan yang berisi respons. NULL jika tidak ada respons yang diterima.
`[in] aMessageInfo`	Pointer ke info pesan untuk `aMessage`. NULL jika tidak ada respons yang diterima.
`[in] aResult`	Hasil dari transaksi CoAP.

Nilai Hasil

`OT_ERROR_NONE`	Respons berhasil diterima.
`OT_ERROR_ABORT`	Transaksi CoAP direset oleh peer.
`OT_ERROR_RESPONSE_TIMEOUT`	Tidak ada respons atau konfirmasi yang diterima selama periode waktu tunggu.

Parameter otCoapTx

struct otCoapTxParameters otCoapTxParameters

Merepresentasikan parameter transmisi CoAP.

{i>otCoapType<i}

enum otCoapType otCoapType

Nilai Jenis CoAP (bilangan bulat tanpa tanda tangan 2 bit).

Fungsi

{i>otCoapAddBlockWiseResource<i}

void otCoapAddBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Menambahkan resource block-wise ke server CoAP.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aResource`	Pointer ke resource.

{i>otCoapAddResource<i}

void otCoapAddResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Menambahkan resource ke server CoAP.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aResource`	Pointer ke resource.

{i>otCoapBlockSizeFromExponent<i}

uint16_t otCoapBlockSizeFromExponent(
  otCoapBlockSzx aSize
)

Mengonversi kolom SZX opsi CoAP Block ke ukuran blok yang sebenarnya.

Detail

Parameter

[in] aSize

Eksponen ukuran blok.

Pengembalian

Nilai eksponen ukuran sebenarnya.

otCoapMessageAppendBlock1Option

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

Menambahkan opsi Block1.

Detail

Parameter

`[in,out] aMessage`	Pointer 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.

Nilai Hasil

`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
)

Menambahkan opsi Block2.

Detail

Parameter

`[in,out] aMessage`	Pointer 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.

Nilai Hasil

`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.

{i>otCoapMessageAppendContentFormatOption<i}

otError otCoapMessageAppendContentFormatOption(
  otMessage *aMessage,
  otCoapOptionContentFormat aContentFormat
)

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.

Fungsi ini merupakan wrapper praktis seputar otCoapMessageAppendUintOption, dan jika kode jenis format yang diinginkan tidak tercantum dalam otCoapOptionContentFormat, fungsi dasar ini harus digunakan.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aContentFormat`	Salah satu format konten yang tercantum dalam otCoapOptionContentFormat di atas.

Nilai Hasil

`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
)

Menambahkan opsi Usia Maks.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aMaxAge`	Nilai Usia Maks.

Nilai Hasil

`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.

{i>otCoapMessageAppendObservationOption<i}

otError otCoapMessageAppendObserveOption(
  otMessage *aMessage,
  uint32_t aObserve
)

Menambahkan opsi Observasi.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aObserve`	Mengamati nilai kolom.

Nilai Hasil

`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.

{i>otCoapMessageAppendOption<i}

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

Menambahkan opsi CoAP di header.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aNumber`	Nomor Opsi CoAP.
`[in] aLength`	Durasi Opsi CoAP.
`[in] aValue`	Pointer ke nilai CoAP.

Nilai Hasil

`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
)

Menambahkan opsi Proxy-Uri.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aUriPath`	Pointer ke string yang dihentikan NULL.

Nilai Hasil

`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.

{i>otCoapMessageAppendUintOption<i}

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

Menambahkan opsi CoAP bilangan bulat tanpa tanda tangan seperti yang ditentukan dalam https://tools.ietf.org/html/rfc7252#section-3.2.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aNumber`	Nomor Opsi CoAP.
`[in] aValue`	Nilai bilangan bulat tidak bertanda tangan Opsi CoAP.

Nilai Hasil

`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

{i>otCoapMessageAppendUriPathOptions<i}

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

Menambahkan opsi Jalur URI.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aUriPath`	Pointer ke string yang dihentikan NULL.

Nilai Hasil

`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.

{i>otCoapMessageAppendUriQueryOption<i}

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

Menambahkan satu opsi Kueri URI.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aUriQuery`	Pointer ke string yang dihentikan NULL, yang akan berisi satu pasangan kunci=nilai.

Nilai Hasil

`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.

{i>otCoapMessageCodeToString<i}

const char * otCoapMessageCodeToString(
  const otMessage *aMessage
)

Menampilkan Kode CoAP sebagai string yang dapat dibaca manusia.

@ mengembalikan Kode CoAP sebagai string.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

{i>otCoapMessageGenerateToken<i}

void otCoapMessageGenerateToken(
  otMessage *aMessage,
  uint8_t aTokenLength
)

Menetapkan panjang Token dan mengacak nilainya.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aTokenLength`	Panjang Token yang akan ditetapkan.

{i>otCoapMessageGetCode<i}

otCoapCode otCoapMessageGetCode(
  const otMessage *aMessage
)

Menampilkan nilai Kode.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

Pengembalian

Nilai Kode.

{i>otCoapMessageGetMessageId<i}

uint16_t otCoapMessageGetMessageId(
  const otMessage *aMessage
)

Menampilkan nilai ID Pesan.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

Pengembalian

Nilai ID Pesan.

{i>otCoapMessageGetToken<i}

const uint8_t * otCoapMessageGetToken(
  const otMessage *aMessage
)

Menampilkan pointer ke nilai Token.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

Pengembalian

Pointer ke nilai Token.

{i>otCoapMessageGetTokenLength<i}

uint8_t otCoapMessageGetTokenLength(
  const otMessage *aMessage
)

Menampilkan panjang Token.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

Pengembalian

Panjang Token.

{i>otCoapMessageGetType<i}

otCoapType otCoapMessageGetType(
  const otMessage *aMessage
)

Menampilkan nilai Jenis.

Detail

Parameter

[in] aMessage

Pointer ke pesan CoAP.

Pengembalian

Nilai Jenis.

{i>otCoapMessageInit<i}

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

Menginisialisasi header CoAP.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP yang akan diinisialisasi.
`[in] aType`	Jenis pesan CoAP.
`[in] aCode`	Kode pesan CoAP.

otCoapMessageInitResponse

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

Menginisialisasi pesan respons.

Catatan: ID dan token pesan ditetapkan sesuai dengan aRequest.

Detail

Parameter

`[in,out] aResponse`	Pointer ke pesan respons CoAP.
`[in] aRequest`	Pointer pesan permintaan CoAP.
`[in] aType`	Jenis pesan CoAP.
`[in] aCode`	Kode pesan CoAP.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil melakukan inisialisasi pesan respons.
`OT_ERROR_NO_BUFS`	Buffering pesan yang tersedia tidak memadai untuk melakukan inisialisasi pesan respons.

{i>otCoapMessageSetCode<i}

void otCoapMessageSetCode(
  otMessage *aMessage,
  otCoapCode aCode
)

Menetapkan nilai Kode.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP yang akan diinisialisasi.
`[in] aCode`	Kode pesan CoAP.

{i>otCoapMessageSetPayloadMarker<i}

otError otCoapMessageSetPayloadMarker(
  otMessage *aMessage
)

Menambahkan Penanda Payload yang menunjukkan awal payload ke header CoAP.

Detail

Parameter

[in,out] aMessage

Pointer ke pesan CoAP.

Nilai Hasil

`OT_ERROR_NONE`	Penanda Payload berhasil ditambahkan.
`OT_ERROR_NO_BUFS`	Penanda Payload Header melebihi ukuran buffer.

{i>otCoapMessageSetToken<i}

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

Menetapkan nilai dan panjang Token di header.

Detail

Parameter

`[in,out] aMessage`	Pointer ke pesan CoAP.
`[in] aToken`	Pointer ke nilai Token.
`[in] aTokenLength`	Panjang `aToken`.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil menetapkan nilai Token.
`OT_ERROR_NO_BUFS`	Buffering tidak cukup untuk menetapkan nilai Token.

{i>otCoapNewMessage<i}

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

Membuat pesan CoAP baru.

Catatan: Jika aSettings adalah 'NULL', keamanan lapisan link akan diaktifkan dan prioritas pesan akan ditetapkan ke OT_MESSAGE_PRIORITY_NORMAL secara default.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aSettings`	Pointer ke setelan pesan atau NULL untuk menetapkan pengaturan default.

Pengembalian

Pointer ke buffering pesan atau NULL jika tidak ada buffer pesan yang tersedia atau parameter tidak valid.

{i>otCoapOptionIteratorGetFirstOption<i}

const otCoapOption * otCoapOptionIteratorGetFirstOption(
  otCoapOptionIterator *aIterator
)

Menampilkan pointer ke opsi pertama.

Detail

Parameter

[in,out] aIterator

Pointer ke iterator opsi pesan CoAP.

Pengembalian

Pointer ke opsi pertama. Jika tidak ada opsi, pointer NULL akan ditampilkan.

Pencocokan otCoapOptionIteratorGetFirstOption

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

Menampilkan pointer ke opsi pertama yang cocok dengan nomor opsi yang ditentukan.

Detail

Parameter

`[in] aIterator`	Pointer ke iterator opsi pesan CoAP.
`[in] aOption`	Nomor opsi yang dicari.

Pengembalian

Pointer ke opsi pencocokan pertama. Jika tidak ada opsi yang cocok, pointer NULL akan ditampilkan.

otCoapOptionIteratorGetNextOption

const otCoapOption * otCoapOptionIteratorGetNextOption(
  otCoapOptionIterator *aIterator
)

Menampilkan pointer ke opsi berikutnya.

Detail

Parameter

[in,out] aIterator

Pointer ke iterator opsi pesan CoAP.

Pengembalian

Pointer ke opsi berikutnya. Jika tidak ada lagi opsi yang ada, pointer NULL akan ditampilkan.

Pencocokan otCoapOptionIteratorGetNextOption

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

Menampilkan pointer ke opsi berikutnya yang cocok dengan nomor opsi yang ditentukan.

Detail

Parameter

`[in] aIterator`	Pointer ke iterator opsi pesan CoAP.
`[in] aOption`	Nomor opsi yang dicari.

Pengembalian

Pointer ke opsi pencocokan berikutnya. Jika tidak ada opsi pencocokan lebih lanjut, pointer NULL akan ditampilkan.

{i>otCoapOptionIteratorGetOptionUintValue<i}

otError otCoapOptionIteratorGetOptionUintValue(
  otCoapOptionIterator *aIterator,
  uint64_t *aValue
)

Mengisi nilai opsi saat ini menjadi aValue dengan asumsi nilai saat ini adalah bilangan bulat tanpa tanda tangan yang dienkode sesuai dengan https://tools.ietf.org/html/rfc7252#section-3.2.

Detail

Parameter

`[in,out] aIterator`	Pointer ke iterator opsi pesan CoAP.
`[out] aValue`	Pointer ke bilangan bulat yang tidak ditandatangani untuk menerima nilai opsi.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengisi nilai.
`OT_ERROR_NOT_FOUND`	Tidak ada opsi saat ini.
`OT_ERROR_NO_BUFS`	Nilai terlalu panjang untuk dimuat dalam uint64_t.

Lihat juga:
otCoapMessageAppendUintOption

{i>otCoapOptionIteratorGetOptionValue<i}

otError otCoapOptionIteratorGetOptionValue(
  otCoapOptionIterator *aIterator,
  void *aValue
)

Mengisi nilai opsi saat ini ke aValue.

Detail

Parameter

`[in,out] aIterator`	Pointer ke iterator opsi pesan CoAP.
`[out] aValue`	Pointer ke buffering untuk menerima nilai opsi.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengisi nilai.
`OT_ERROR_NOT_FOUND`	Tidak ada opsi saat ini.

otCoapOptionIteratorInit

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

Menginisialisasi iterator untuk opsi pada pesan yang diberikan.

Detail

Parameter

`[in,out] aIterator`	Pointer ke iterator opsi pesan CoAP.
`[in] aMessage`	Pointer ke pesan CoAP.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil diinisialisasi.
`OT_ERROR_PARSE`	Status pesan tidak konsisten.

{i>otCoapRemoveBlockWiseResource<i}

void otCoapRemoveBlockWiseResource(
  otInstance *aInstance,
  otCoapBlockwiseResource *aResource
)

Menghapus resource block-wise dari server CoAP.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aResource`	Pointer ke resource.

{i>otCoapRemoveResource<i}

void otCoapRemoveResource(
  otInstance *aInstance,
  otCoapResource *aResource
)

Menghapus resource dari server CoAP.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aResource`	Pointer ke resource.

{i>otCoapSendRequest<i}

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

Mengirim permintaan CoAP.

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

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke pesan yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aHandler`	Pointer fungsi yang harus dipanggil pada penerimaan respons atau waktu tunggu.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengirim pesan CoAP.
`OT_ERROR_NO_BUFS`	Gagal mengalokasikan data transmisi ulang.

{i>otCoapSendRequestBlockWise<i}

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

Mengirim permintaan CoAP secara block-wise.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

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

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke pesan yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aHandler`	Pointer fungsi yang harus dipanggil pada penerimaan respons atau waktu tunggu.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.
`[in] aTransmitHook`	Pointer ke fungsi hook untuk transfer keluar melalui blok.
`[in] aReceiveHook`	Pointer ke fungsi hook untuk transfer berbasis blok yang masuk.

Nilai Hasil

`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
)

Mengirim permintaan CoAP secara block-wise dengan parameter transmisi kustom.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke pesan yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aHandler`	Pointer fungsi yang harus dipanggil pada penerimaan respons atau waktu tunggu.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.
`[in] aTxParameters`	Pointer ke parameter transmisi untuk permintaan ini. Gunakan NULL untuk default.
`[in] aTransmitHook`	Pointer ke fungsi hook untuk transfer keluar melalui blok.
`[in] aReceiveHook`	Pointer ke fungsi hook untuk transfer berbasis blok yang masuk.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengirim pesan CoAP.
`OT_ERROR_NO_BUFS`	Gagal mengalokasikan data transmisi ulang.
`OT_ERROR_INVALID_ARGS`	Argumen yang tidak valid diberikan.

otCoapSendRequestWithParameters

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

Mengirim permintaan CoAP dengan parameter transmisi kustom.

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

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke pesan yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aHandler`	Pointer fungsi yang harus dipanggil pada penerimaan respons atau waktu tunggu.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.
`[in] aTxParameters`	Pointer ke parameter transmisi untuk permintaan ini. Gunakan NULL untuk default. Jika tidak, parameter yang diberikan harus memenuhi kondisi berikut: mMaxRetransmit tidak lebih dari OT_COAP_MAX_RETRANSMIT. mAckRandomFactorNumerator / mAckRandomFactorDenominator tidak boleh di bawah 1,0. Masa aktif pertukaran yang dihitung tidak boleh melebihi uint32_t.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengirim pesan CoAP.
`OT_ERROR_NO_BUFS`	Gagal mengalokasikan data transmisi ulang.
`OT_ERROR_INVALID_ARGS`	Argumen yang tidak valid diberikan.

{i>otCoapSendResponse<i}

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

Mengirim respons CoAP dari server.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke respons CoAP yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengantrekan pesan respons CoAP.
`OT_ERROR_NO_BUFS`	Buffering yang tersedia tidak memadai untuk mengirim respons CoAP.

otCoapSendResponseBlockWise

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

Mengirim respons CoAP secara blok dari server.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke respons CoAP yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.
`[in] aTransmitHook`	Pointer ke fungsi hook untuk transfer keluar melalui blok.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengantrekan pesan respons CoAP.
`OT_ERROR_NO_BUFS`	Buffering yang tersedia tidak memadai untuk mengirim respons CoAP.

otCoapSendResponseBlockWiseWithParameters

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

Mengirim respons CoAP secara blok-wise dari server dengan parameter transmisi kustom.

Tersedia saat konfigurasi OPEN template_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE diaktifkan.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke respons CoAP yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aTxParameters`	Pointer ke parameter transmisi untuk respons ini. Gunakan NULL untuk default.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.
`[in] aTransmitHook`	Pointer ke fungsi hook untuk transfer keluar melalui blok.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengantrekan pesan respons CoAP.
`OT_ERROR_NO_BUFS`	Buffering yang tersedia tidak memadai untuk mengirim respons CoAP.
`OT_ERROR_INVALID_ARGS`	Argumen yang tidak valid diberikan.

otCoapSendResponseWithParameters

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

Mengirim respons CoAP dari server dengan parameter transmisi kustom.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aMessage`	Pointer ke respons CoAP yang akan dikirim.
`[in] aMessageInfo`	Pointer ke info pesan yang terkait dengan `aMessage`.
`[in] aTxParameters`	Pointer ke parameter transmisi untuk respons ini. Gunakan NULL untuk default.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil mengantrekan pesan respons CoAP.
`OT_ERROR_NO_BUFS`	Buffering yang tersedia tidak memadai untuk mengirim respons CoAP.
`OT_ERROR_INVALID_ARGS`	Argumen yang tidak valid diberikan.

{i>otCoapSetDefaultHandler<i}

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

Menetapkan pengendali default untuk permintaan CoAP yang tidak tertangani.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aHandler`	Pointer fungsi yang harus dipanggil saat permintaan yang tidak tertangani tiba.
`[in] aContext`	Pointer ke informasi konteks arbitrer. Mungkin NULL jika tidak digunakan.

{i>otCoapStart<i}

otError otCoapStart(
  otInstance *aInstance,
  uint16_t aPort
)

Memulai server CoAP.

Detail

Parameter

`[in] aInstance`	Pointer ke instance OpenThread.
`[in] aPort`	Port UDP lokal yang akan diikat.

Nilai Hasil

`OT_ERROR_NONE`	Berhasil memulai server CoAP.
`OT_ERROR_FAILED`	Gagal memulai server CoAP.

otCoapStop

otError otCoapStop(
  otInstance *aInstance
)

Menghentikan server CoAP.

Detail

Parameter

[in] aInstance

Pointer ke instance OpenThread.

Nilai Hasil

OT_ERROR_NONE

Berhasil menghentikan server CoAP.

Makro

OT_COAP_CODE

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

Makro helper 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

Transmisi ulang maksimum yang didukung oleh OpenThread.

OT_COAP_MAX_TOKEN_LENGTH

 OT_COAP_MAX_TOKEN_LENGTH 8

Panjang token maksimum sesuai yang ditentukan (RFC 7252).

OT_COAP_MIN_ACK_TIMEOUT

 OT_COAP_MIN_ACK_TIMEOUT 1000

Waktu tunggu ACK minimal dalam milidetik yang didukung oleh OpenThread.

OT_DEFAULT_COAP_PORT

 OT_DEFAULT_COAP_PORT 5683

Port CoAP default, seperti yang ditetapkan dalam RFC 7252.

Referensi

Topik Referensi OpenThread API berasal dari kode sumber, yang tersedia di GitHub. Untuk informasi selengkapnya, atau untuk berkontribusi ke dokumentasi kami, lihat Referensi.

coAP

Ringkasan

Enumerasi

Typedef

Fungsi

Struct

Enumerasi

{i>otCoapBlockSzx<i}

Kode {i>otCoap<i}

{i>otCoapOptionContentFormat<i}

{i>otCoapOptionType<i}

{i>otCoapType<i}

Typedef

{i>otCoapBlockSzx<i}

{i>otCoapBlockwiseReceiveHook<i}

{i>otCoapBlockwiseResource<i}

{i>otCoapBlockwiseTransmitHook<i}

Kode {i>otCoap<i}

Opsi OtCoap

{i>otCoapOptionContentFormat<i}

otCoapOptionIterator

{i>otCoapOptionType<i}

{i>otCoapRequestHandler<i}

{i>otCoapResource<i}

otCoapResponseHandler

Parameter otCoapTx

{i>otCoapType<i}

Fungsi

{i>otCoapAddBlockWiseResource<i}

{i>otCoapAddResource<i}

{i>otCoapBlockSizeFromExponent<i}

otCoapMessageAppendBlock1Option

otCoapMessageAppendBlock2Option

{i>otCoapMessageAppendContentFormatOption<i}

otCoapMessageAppendMaxAgeOption

{i>otCoapMessageAppendObservationOption<i}

{i>otCoapMessageAppendOption<i}

otCoapMessageAppendProxyUriOption

{i>otCoapMessageAppendUintOption<i}

{i>otCoapMessageAppendUriPathOptions<i}

{i>otCoapMessageAppendUriQueryOption<i}

{i>otCoapMessageCodeToString<i}

{i>otCoapMessageGenerateToken<i}

{i>otCoapMessageGetCode<i}

{i>otCoapMessageGetMessageId<i}

{i>otCoapMessageGetToken<i}

{i>otCoapMessageGetTokenLength<i}

{i>otCoapMessageGetType<i}

{i>otCoapMessageInit<i}

otCoapMessageInitResponse

{i>otCoapMessageSetCode<i}

{i>otCoapMessageSetPayloadMarker<i}

{i>otCoapMessageSetToken<i}

{i>otCoapNewMessage<i}

{i>otCoapOptionIteratorGetFirstOption<i}

Pencocokan otCoapOptionIteratorGetFirstOption

otCoapOptionIteratorGetNextOption

Pencocokan otCoapOptionIteratorGetNextOption

{i>otCoapOptionIteratorGetOptionUintValue<i}

{i>otCoapOptionIteratorGetOptionValue<i}

otCoapOptionIteratorInit

{i>otCoapRemoveBlockWiseResource<i}

{i>otCoapRemoveResource<i}

{i>otCoapSendRequest<i}

{i>otCoapSendRequestBlockWise<i}

otCoapSendRequestBlockWiseWithParameters

otCoapSendRequestWithParameters

{i>otCoapSendResponse<i}

otCoapSendResponseBlockWise

otCoapSendResponseBlockWiseWithParameters

otCoapSendResponseWithParameters

{i>otCoapSetDefaultHandler<i}

{i>otCoapStart<i}

otCoapStop

Makro

OT_COAP_CODE

OT_COAP_DEFAULT_TOKEN_LENGTH

OT_COAP_MAX_RETRANSMIT

OT_COAP_MAX_TOKEN_LENGTH

OT_COAP_MIN_ACK_TIMEOUT