UDP Modul ini mencakup fungsi yang mengontrol komunikasi UDP.
Ringkasan Typedefs otUdpHandler )(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)
typedef bool(*
Callback ini memungkinkan OpenThread menyediakan penangan khusus untuk pesan UDP tertentu.
otUdpReceive )(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo)
typedef void(*
Callback ini memungkinkan OpenThread untuk menginformasikan aplikasi pesan UDP yang diterima.
otUdpReceiver
typedef Struktur ini mewakili penerima UDP.
otUdpSocket
typedef Struktur ini mewakili soket UDP.
Fungsi otUdpAddReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Fungsi ini menambahkan penerima UDP.
otUdpBind ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
Ikat soket UDP / IPv6.
otUdpClose ( otInstance *aInstance, otUdpSocket *aSocket)
Tutup soket UDP / IPv6.
otUdpConnect ( otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName)
Hubungkan soket UDP / IPv6.
otUdpGetSockets ( otInstance *aInstance)
Fungsi ini mendapatkan kepala dari daftar Soket UDP yang tertaut.
otUdpNewMessage ( otInstance *aInstance, const otMessageSettings *aSettings)
Alokasikan buffer pesan baru untuk mengirim pesan UDP.
otUdpOpen ( otInstance *aInstance, otUdpSocket *aSocket, otUdpReceive aCallback, void *aContext)
Buka soket UDP / IPv6.
otUdpRemoveReceiver ( otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Fungsi ini menghapus penerima UDP.
otUdpSend ( otInstance *aInstance, otUdpSocket *aSocket, otMessage *aMessage, const otMessageInfo *aMessageInfo)
Kirim pesan UDP / IPv6.
otUdpSendDatagram ( otInstance *aInstance, otMessage *aMessage, otMessageInfo *aMessageInfo)
Fungsi ini mengirimkan pesan UDP tanpa soket.
Typedefs otUdpHandler bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) Callback ini memungkinkan OpenThread menyediakan penangan khusus untuk pesan UDP tertentu.
Detail Kembalikan Nilai true
Pesan ditangani oleh penerima ini dan tidak boleh diproses lebih lanjut.
false
Pesan tidak ditangani oleh penerima ini.
otUdpReceive void(* otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) Callback ini memungkinkan OpenThread untuk menginformasikan aplikasi pesan UDP yang diterima.
otUdpReceiver struct otUdpReceiver otUdpReceiver Struktur ini mewakili penerima UDP.
otUdpSocket struct otUdpSocket otUdpSocket Struktur ini mewakili soket UDP.
Fungsi otUdpAddReceiver otError otUdpAddReceiver(
otInstance *aInstance,
otUdpReceiver *aUdpReceiver
) Fungsi ini menambahkan penerima UDP.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aUdpReceiver
Penunjuk ke penerima UDP.
Kembalikan Nilai OT_ERROR_NONE
Penerima berhasil ditambahkan.
OT_ERROR_ALREADY
Penerima UDP telah ditambahkan.
otUdpBind otError otUdpBind(
otInstance *aInstance,
otUdpSocket *aSocket,
const otSockAddr *aSockName
) Ikat soket UDP / IPv6.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSocket
Penunjuk ke struktur soket UDP.
[in] aSockName
Penunjuk ke struktur alamat soket IPv6.
Kembalikan Nilai OT_ERROR_NONE
Operasi pengikatan berhasil.
OT_ERROR_FAILED
Gagal mengikat soket UDP.
otUdpClose otError otUdpClose(
otInstance *aInstance,
otUdpSocket *aSocket
) Tutup soket UDP / IPv6.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSocket
Penunjuk ke struktur soket UDP.
Kembalikan Nilai OT_ERROR_NONE
Berhasil menutup soket.
OT_ERROR_FAILED
Gagal menutup Soket UDP.
otUdpConnect otError otUdpConnect(
otInstance *aInstance,
otUdpSocket *aSocket,
const otSockAddr *aSockName
) Hubungkan soket UDP / IPv6.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSocket
Penunjuk ke struktur soket UDP.
[in] aSockName
Penunjuk ke struktur alamat soket IPv6.
Kembalikan Nilai OT_ERROR_NONE
Operasi koneksi berhasil.
OT_ERROR_FAILED
Gagal menghubungkan soket UDP.
otUdpGetSockets otUdpSocket * otUdpGetSockets(
otInstance *aInstance
) Fungsi ini mendapatkan kepala dari daftar Soket UDP yang tertaut.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
Kembali Penunjuk ke kepala daftar tertaut Soket UDP.
otUdpNewMessage otMessage * otUdpNewMessage(
otInstance *aInstance,
const otMessageSettings *aSettings
) Alokasikan buffer pesan baru untuk mengirim pesan UDP.
Catatan: Jika aSettings
adalah 'NULL', keamanan lapisan tautan diaktifkan dan prioritas pesan disetel ke OT_MESSAGE_PRIORITY_NORMAL secara default.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSettings
Sebuah penunjuk ke pengaturan pesan atau NULL untuk menggunakan pengaturan default.
Kembali Sebuah pointer ke buffer pesan atau NULL jika tidak ada buffer pesan yang tersedia atau parameter tidak valid.
Lihat juga: otMessageFree otUdpOpen otError otUdpOpen(
otInstance *aInstance,
otUdpSocket *aSocket,
otUdpReceive aCallback,
void *aContext
) Buka soket UDP / IPv6.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSocket
Penunjuk ke struktur soket UDP.
[in] aCallback
Sebuah penunjuk ke fungsi panggilan balik aplikasi.
[in] aContext
Penunjuk ke konteks khusus aplikasi.
Kembalikan Nilai OT_ERROR_NONE
Berhasil membuka soket.
OT_ERROR_FAILED
Gagal membuka soket.
otUdpRemoveReceiver otError otUdpRemoveReceiver(
otInstance *aInstance,
otUdpReceiver *aUdpReceiver
) Fungsi ini menghapus penerima UDP.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aUdpReceiver
Penunjuk ke penerima UDP.
Kembalikan Nilai OT_ERROR_NONE
Penerima berhasil dihapus.
OT_ERROR_NOT_FOUND
Penerima UDP tidak ditambahkan.
otUdpSend otError otUdpSend(
otInstance *aInstance,
otUdpSocket *aSocket,
otMessage *aMessage,
const otMessageInfo *aMessageInfo
) Kirim pesan UDP / IPv6.
Jika nilai yang dikembalikan OT_ERROR_NONE, OpenThread mengambil kepemilikan aMessage
, dan pemanggil seharusnya tidak lagi mereferensikan aMessage
. Jika nilai kembalian bukan OT_ERROR_NONE, pemanggil tetap memiliki kepemilikan aMessage
, termasuk membebaskan aMessage
jika buffer pesan tidak lagi diperlukan.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aSocket
Penunjuk ke struktur soket UDP.
[in] aMessage
Sebuah penunjuk ke buffer pesan.
[in] aMessageInfo
Penunjuk ke struktur info pesan.
Detail Kembalikan Nilai OT_ERROR_NONE
Pesan berhasil dijadwalkan untuk dikirim.
OT_ERROR_INVALID_ARGS
Argumen yang diberikan tidak valid.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk menambahkan header UDP dan IPv6.
otUdpSendDatagram otError otUdpSendDatagram(
otInstance *aInstance,
otMessage *aMessage,
otMessageInfo *aMessageInfo
) Fungsi ini mengirimkan pesan UDP tanpa soket.
Detail Parameter [in] aInstance
Penunjuk ke instance OpenThread.
[in] aMessage
Penunjuk ke pesan tanpa header UDP.
[in] aMessageInfo
aMessage
ke info pesan yang terkait dengan aMessage
.
Kembalikan Nilai OT_ERROR_NONE
Berhasil mengantrekan pesan ke antarmuka keluaran.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak mencukupi untuk menambahkan header IPv6.