TREL - Stack Thread

Modul ini mendefinisikan API Thread Radio Encapsulation Link (TREL) untuk Thread Over Infrastructure.

Ringkasan

Fungsi dalam modul ini memerlukan OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE untuk diaktifkan.

Typedef
otTrelPeer typedef
struct otTrelPeer
Mewakili peer TREL.
otTrelPeerIterator typedef
uint16_t
Mewakili iterator untuk melakukan iterasi pada entri tabel peer TREL.

Fungsi
otTrelGetNextPeer(otInstance *aInstance, otTrelPeerIterator *aIterator)
const otTrelPeer *
Melakukan iterasi pada entri tabel pembanding dan mendapatkan entri berikutnya dari tabel tersebut.
otTrelInitPeerIterator(otInstance *aInstance, otTrelPeerIterator *aIterator)
void
Menginisialisasi iterator tabel peer.
otTrelIsEnabled(otInstance *aInstance)
bool
Menunjukkan apakah operasi TREL diaktifkan.
otTrelIsFilterEnabled(otInstance *aInstance)
bool
Menunjukkan apakah mode filter diaktifkan atau tidak.
otTrelSetEnabled(otInstance *aInstance, bool aEnable)
void
Mengaktifkan atau menonaktifkan operasi TREL.
otTrelSetFilterEnabled(otInstance *aInstance, bool aEnable)
void
Menetapkan mode filter (mengaktifkan/menonaktifkan pemfilteran).

Struct
otTrelPeer

Mewakili peer TREL.

Typedef

otTrelPeer

struct otTrelPeer otTrelPeer

Mewakili peer TREL.

otTrelPeerIterator

uint16_t otTrelPeerIterator

Mewakili iterator untuk melakukan iterasi pada entri tabel peer TREL.

Fungsi

otTrelGetNextPeer

const otTrelPeer * otTrelGetNextPeer(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

Melakukan iterasi pada entri tabel pembanding dan mendapatkan entri berikutnya dari tabel tersebut.

Detail
Parameter
[in] aInstance
Instance OpenThread.
[in] aIterator
Iterator. HARUS diinisialisasi.
Hasil
Pointer ke entri otTrelPeer berikutnya atau NULL jika tidak ada lagi entri dalam tabel.

otTrelInitPeerIterator

void otTrelInitPeerIterator(
  otInstance *aInstance,
  otTrelPeerIterator *aIterator
)

Menginisialisasi iterator tabel peer.

Detail
Parameter
[in] aInstance
Instance OpenThread.
[in] aIterator
Iterator yang akan diinisialisasi.

otTrelIsEnabled

bool otTrelIsEnabled(
  otInstance *aInstance
)

Menunjukkan apakah operasi TREL diaktifkan.

Detail
Parameter
[in] aInstance
Instance OpenThread.
Nilai Pengembalian
TRUE
jika operasi TREL diaktifkan.
FALSE
jika operasi TREL dinonaktifkan.

otTrelIsFilterEnabled

bool otTrelIsFilterEnabled(
  otInstance *aInstance
)

Menunjukkan apakah mode filter diaktifkan atau tidak.

Detail
Parameter
[in] aInstance
Instance OpenThread.
Nilai Pengembalian
TRUE
jika mode filter TREL diaktifkan.
FALSE
jika mode filter TREL dinonaktifkan.

otTrelSetEnabled

void otTrelSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Mengaktifkan atau menonaktifkan operasi TREL.

Jika aEnable bernilai benar (true), fungsi ini akan memulai penjelajahan DNS-SD yang sedang berlangsung pada nama layanan "_trel._udp" dalam domain penjelajahan lokal untuk menemukan perangkat lain yang mendukung TREL. Perangkat juga mendaftarkan layanan baru yang akan diiklankan menggunakan DNS-SD, dengan nama layanan "_trel._udp" yang menunjukkan dukungannya untuk TREL. Perangkat kemudian siap untuk menerima pesan TREL dari rekan.

Jika aEnable bernilai salah (false), fungsi ini akan menghentikan penjelajahan DNS-SD pada nama layanan "_trel._udp", berhenti mengiklankan layanan TREL DNS-SD, dan menghapus tabel peer TREL.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnable
Boolean untuk mengaktifkan/menonaktifkan operasi TREL.

otTrelSetFilterEnabled

void otTrelSetFilterEnabled(
  otInstance *aInstance,
  bool aEnable
)

Menetapkan mode filter (mengaktifkan/menonaktifkan pemfilteran).

Saat mode filter diaktifkan, semua traffic rx dan tx melalui antarmuka TREL akan dihapus secara otomatis. Ini terutama dimaksudkan untuk digunakan selama pengujian.

Tidak seperti otTrel{Enable/Disable}() yang sepenuhnya memulai/menghentikan operasi TREL, saat mode filter diaktifkan, antarmuka TREL akan terus diaktifkan.

Detail
Parameter
[in] aInstance
Instance OpenThread.
[in] aFiltered
TRUE untuk mengaktifkan mode filter, FALSE untuk menonaktifkan mode filter.

Referensi

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