router pembatas

Modul ini mencakup fungsi untuk mengelola data jaringan lokal dengan OpenThread Border Router.

Ringkasan

Typedef

otBorderRouterNetDataFullCallback)(void *aContext) typedef
void(*
Callback pointer fungsi yang dipanggil saat Data Jaringan (lokal atau pemimpin) penuh.

Fungsi

otBorderRouterAddOnMeshPrefix(otInstance *aInstance, const otBorderRouterConfig *aConfig)
Tambahkan konfigurasi router pembatas ke data jaringan lokal.
otBorderRouterAddRoute(otInstance *aInstance, const otExternalRouteConfig *aConfig)
Tambahkan konfigurasi rute eksternal ke data jaringan lokal.
otBorderRouterGetNetData(otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Memberikan salinan lengkap atau stabil dari Data Jaringan Thread lokal.
otBorderRouterGetNextOnMeshPrefix(otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Mendapatkan Awalan On Mesh berikutnya di Data Jaringan lokal.
otBorderRouterGetNextRoute(otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Mendapatkan rute eksternal berikutnya di Data Jaringan lokal.
otBorderRouterRegister(otInstance *aInstance)
Segera daftarkan data jaringan lokal dengan Leader.
otBorderRouterRemoveOnMeshPrefix(otInstance *aInstance, const otIp6Prefix *aPrefix)
Hapus konfigurasi router pembatas dari data jaringan lokal.
otBorderRouterRemoveRoute(otInstance *aInstance, const otIp6Prefix *aPrefix)
Hapus konfigurasi rute eksternal dari data jaringan lokal.
otBorderRouterSetNetDataFullCallback(otInstance *aInstance, otBorderRouterNetDataFullCallback aCallback, void *aContext)
void
Menetapkan callback untuk menunjukkan kapan Data Jaringan penuh.

Typedef

otBorderRouterNetDataFullCallback

void(* otBorderRouterNetDataFullCallback)(void *aContext)

Callback pointer fungsi yang dipanggil saat Data Jaringan (lokal atau pemimpin) penuh.

Detail
Parameter
[in] aContext
Pointer ke informasi konteks arbitrer.

Fungsi

otBorderRouterTambahOnMeshPrefix

otError otBorderRouterAddOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Tambahkan konfigurasi router pembatas ke data jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Pointer ke konfigurasi router pembatas.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menambahkan konfigurasi ke data jaringan lokal.
OT_ERROR_INVALID_ARGS
Satu atau beberapa parameter konfigurasi tidak valid.
OT_ERROR_NO_BUFS
Tidak tersedia cukup ruang untuk menambahkan konfigurasi ke data jaringan lokal.
Lihat juga:
otBorderRouterRemoveOnMeshPrefix
otBorderRouterRegister

otBorderRouterTambahRute

otError otBorderRouterAddRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Tambahkan konfigurasi rute eksternal ke data jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Pointer ke konfigurasi rute eksternal.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menambahkan konfigurasi ke data jaringan lokal.
OT_ERROR_INVALID_ARGS
Satu atau beberapa parameter konfigurasi tidak valid.
OT_ERROR_NO_BUFS
Tidak tersedia cukup ruang untuk menambahkan konfigurasi ke data jaringan lokal.
Lihat juga:
otBorderRouterRemoveRoute
otBorderRouterRegister

otBorderRouterGetNetData

otError otBorderRouterGetNetData(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

Memberikan salinan lengkap atau stabil dari Data Jaringan Thread lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aStable
TRUE saat menyalin versi stabil, FALSE saat menyalin versi lengkap.
[out] aData
Pointer ke buffering data.
[in,out] aDataLength
Saat masuk, ukuran buffer data yang ditunjukkan oleh aData. Saat keluar, jumlah byte yang disalin.

otBorderRouterGetNextOnMeshPrefix

otError otBorderRouterGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Mendapatkan Awalan On Mesh berikutnya di Data Jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri mesh pertama, tetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke informasi On Mesh Prefix.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan awalan On Mesh berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada awalan On Mesh berikutnya di Data Jaringan Thread.

otBorderRouterGetNextRoute

otError otBorderRouterGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

Mendapatkan rute eksternal berikutnya di Data Jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri rute eksternal pertama, rute harus ditetapkan ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke informasi Rute Eksternal.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan Rute Eksternal berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada entri rute eksternal berikutnya di Data Jaringan Thread.

otBorderRouterDaftar

otError otBorderRouterRegister(
  otInstance *aInstance
)

Segera daftarkan data jaringan lokal dengan Leader.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mengantrekan pesan Permintaan Data Server untuk dikirimkan.
Lihat juga:
otBorderRouterAddOnMeshPrefix
otBorderRouterRemoveOnMeshPrefix
otBorderRouterAddRoute
otBorderRouterRemoveRoute

otBorderRouterRemoveOnMeshPrefix

otError otBorderRouterRemoveOnMeshPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Hapus konfigurasi router pembatas dari data jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan IPv6.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menghapus konfigurasi dari data jaringan lokal.
OT_ERROR_NOT_FOUND
Tidak dapat menemukan entri Border Router.
Lihat juga:
otBorderRouterAddOnMeshPrefix
otBorderRouterRegister

otBorderRouterRemoveRoute

otError otBorderRouterRemoveRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Hapus konfigurasi rute eksternal dari data jaringan lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan IPv6.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menghapus konfigurasi dari data jaringan lokal.
OT_ERROR_NOT_FOUND
Tidak dapat menemukan entri Border Router.
Lihat juga:
otBorderRouterAddRoute
otBorderRouterRegister

otBorderRouterSetNetDataFullCallback

void otBorderRouterSetNetDataFullCallback(
  otInstance *aInstance,
  otBorderRouterNetDataFullCallback aCallback,
  void *aContext
)

Menetapkan callback untuk menunjukkan kapan Data Jaringan penuh.

Memerlukan OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL.

Callback dipanggil setiap kali:

  • Perangkat bertindak sebagai pemimpin dan menerima pendaftaran Data Jaringan dari Router Pembatas (BR) yang tidak dapat ditambahkan ke Data Jaringan (kehabisan ruang penyimpanan).
  • Perangkat bertindak sebagai BR dan entri baru tidak dapat ditambahkan ke Data Jaringan lokalnya.
  • Perangkat bertindak sebagai BR dan mencoba mendaftarkan entri Data Jaringan lokalnya kepada pemimpin, tetapi memutuskan bahwa entri lokalnya tidak akan cocok.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Callback.
[in] aContext
Pointer ke informasi konteks arbitrer yang digunakan dengan aCallback.

Referensi

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