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

UDP

Modul ini menyertakan fungsi yang mengontrol komunikasi UDP.

Ringkasan

Enumerasi
otNetifIdentifier{
  OT_NETIF_UNSPECIFIED = 0,
  OT_NETIF_THREAD,
  OT_NETIF_BACKBONE
} 		enum
Enumerasi ini menentukan ID antarmuka jaringan OpenThread.

Typedef
otNetifIdentifier typedef
Enumerasi ini menentukan ID antarmuka jaringan OpenThread.
otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
bool(*
Callback ini memungkinkan OpenThread menyediakan pengendali tertentu untuk pesan UDP tertentu.
otUdpReceive)(void *aContext, otMessage *aMessage, const otMessageInfo *aMessageInfo) typedef
void(*
Callback ini memungkinkan OpenThread menginformasikan aplikasi dari pesan UDP yang diterima.
otUdpReceiver typedef
struct otUdpReceiver
Struktur ini mewakili penerima UDP.
otUdpSocket typedef
struct otUdpSocket
Struktur ini mewakili soket UDP.

Fungsi
otUdpAddReceiver(otInstance *aInstance, otUdpReceiver *aUdpReceiver)
Fungsi ini menambahkan penerima UDP.
otUdpBind(otInstance *aInstance, otUdpSocket *aSocket, const otSockAddr *aSockName, otNetifIdentifier aNetif)
Mengikat 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 head of list yang ditautkan dari UDP Sockets.
otUdpIsOpen(otInstance *aInstance, const otUdpSocket *aSocket)
bool
Periksa apakah soket UDP terbuka.
otUdpNewMessage(otInstance *aInstance, const otMessageSettings *aSettings)
Mengalokasikan 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 mengirim pesan UDP tanpa soket.

Struct
otUdpReceiver

Struktur ini mewakili penerima UDP.

otUdpSocket

Struktur ini mewakili soket UDP.

Enumerasi

otNetifIdentifier

 otNetifIdentifier

Enumerasi ini menentukan ID antarmuka jaringan OpenThread.

Properti
OT_NETIF_BACKBONE

Antarmuka Backbone.

OT_NETIF_THREAD

Antarmuka Thread.

OT_NETIF_UNSPECIFIED

Antarmuka jaringan tidak ditentukan.

Typedef

otNetifIdentifier

enum otNetifIdentifier otNetifIdentifier

Enumerasi ini menentukan ID antarmuka jaringan OpenThread.

otUdpHandler

bool(* otUdpHandler)(void *aContext, const otMessage *aMessage, const otMessageInfo *aMessageInfo)

Callback ini memungkinkan OpenThread menyediakan pengendali tertentu untuk pesan UDP tertentu.

Detail
Nilai yang Ditampilkan
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 menginformasikan aplikasi dari pesan UDP yang diterima.

Penerima

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
Pointer ke instance OpenThread.
[in] aUdpReceiver
Pointer ke penerima UDP.
Nilai yang Ditampilkan
OT_ERROR_NONE
Penerima berhasil ditambahkan.
OT_ERROR_ALREADY
Penerima UDP sudah ditambahkan.

otUdpBind

otError otUdpBind(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  const otSockAddr *aSockName,
  otNetifIdentifier aNetif
)

Mengikat soket UDP/IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
[in] aSockName
Pointer ke struktur alamat soket IPv6.
[in] aNetif
Antarmuka jaringan untuk diikat.
Nilai yang Ditampilkan
OT_ERROR_NONE
Operasi ikat berhasil.
OT_ERROR_FAILED
Gagal mengikat soket UDP.

otUdpTutup

otError otUdpClose(
  otInstance *aInstance,
  otUdpSocket *aSocket
)

Tutup soket UDP/IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
Nilai yang Ditampilkan
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
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
[in] aSockName
Pointer ke struktur alamat soket IPv6.
Nilai yang Ditampilkan
OT_ERROR_NONE
Operasi penyambungan berhasil.
OT_ERROR_FAILED
Gagal menghubungkan soket UDP.

otUdpGetSocket

otUdpSocket * otUdpGetSockets(
  otInstance *aInstance
)

Fungsi ini mendapatkan head of list yang ditautkan dari UDP Sockets.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Hasil
Pointer ke kepala daftar tertaut UDP Soket.

otUdpIsTerbuka

bool otUdpIsOpen(
  otInstance *aInstance,
  const otUdpSocket *aSocket
)

Periksa apakah soket UDP terbuka.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
Hasil
Apakah soket UDP terbuka.

Pesan baru

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

Mengalokasikan buffer pesan baru untuk mengirim pesan UDP.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSettings
Pointer ke setelan pesan atau NULL untuk menggunakan setelan default.
Hasil
Pointer ke buffer pesan atau NULL jika buffer pesan tidak tersedia atau parameter tidak valid.
Lihat juga:
otMessageFree

otUdpBuka

otError otUdpOpen(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otUdpReceive aCallback,
  void *aContext
)

Buka soket UDP/IPv6.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
[in] aCallback
Pointer ke fungsi callback aplikasi.
[in] aContext
Pointer ke konteks khusus aplikasi.
Nilai yang Ditampilkan
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
Pointer ke instance OpenThread.
[in] aUdpReceiver
Pointer ke penerima UDP.
Nilai yang Ditampilkan
OT_ERROR_NONE
Penerima berhasil dihapus.
OT_ERROR_NOT_FOUND
Penerima UDP tidak ditambahkan.

otUdpKirim

otError otUdpSend(
  otInstance *aInstance,
  otUdpSocket *aSocket,
  otMessage *aMessage,
  const otMessageInfo *aMessageInfo
)

Kirim pesan UDP/IPv6.

Jika nilai yang ditampilkan adalah OT_ERROR_NONE, OpenThread mengambil alih kepemilikan aMessage, dan pemanggil tidak boleh lagi merujuk aMessage. Jika nilai pengembalian tidak OT_ERROR_NONE, pemanggil mempertahankan kepemilikan aMessage, termasuk mengosongkan aMessage jika buffer pesan tidak lagi diperlukan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSocket
Pointer ke struktur soket UDP.
[in] aMessage
Pointer ke buffer pesan.
[in] aMessageInfo
Pointer ke struktur info pesan.

Detail
Nilai yang Ditampilkan
OT_ERROR_NONE
Pesan berhasil dijadwalkan untuk dikirim.
OT_ERROR_INVALID_ARGS
Argumen yang tidak valid diberikan.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak cukup untuk menambahkan header UDP dan IPv6.

otUdpSendDatagram

otError otUdpSendDatagram(
  otInstance *aInstance,
  otMessage *aMessage,
  otMessageInfo *aMessageInfo
)

Fungsi ini mengirim pesan UDP tanpa soket.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMessage
Pointer ke pesan tanpa header UDP.
[in] aMessageInfo
Pointer ke info pesan yang terkait dengan aMessage.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengantrekan pesan ke antarmuka output.
OT_ERROR_NO_BUFS
Buffer yang tersedia tidak cukup untuk menambahkan header IPv6.

Resource

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