Router Backbone

Modul ini menyertakan fungsi untuk Layanan Openbone Router BackThread.

Ringkasan

Enumerasi
otBackboneRouterDomainPrefixEvent{
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
  OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
} 		enum
Merepresentasikan peristiwa Domain Prefix.
otBackboneRouterMulticastListenerEvent{
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
  OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
} 		enum
Mewakili peristiwa Pemroses Multicast.
otBackboneRouterNdProxyEvent{
  OT_BACKBONE_ROUTER_NDPROXY_ADDED = 0,
  OT_BACKBONE_ROUTER_NDPROXY_REMOVED = 1,
  OT_BACKBONE_ROUTER_NDPROXY_RENEWED = 2,
  OT_BACKBONE_ROUTER_NDPROXY_CLEARED = 3
} 		enum
Mewakili peristiwa Proxy ND.
otBackboneRouterState{
  OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
  OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
  OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
} 		enum
Mewakili Status Backbone Router.

Typedef
otBackboneRouterConfig typedef
Mewakili konfigurasi Backbone Router.
otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Pointer dipanggil setiap kali Awalan Domain berubah.
otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Pointer dipanggil setiap kali Pemroses Multicast berubah.
otBackboneRouterMulticastListenerInfo typedef
Merepresentasikan info Pemroses Multicast Router Backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui Pemroses Multicast.
otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Pointer dipanggil setiap kali Proxy Nd berubah.
otBackboneRouterNdProxyInfo typedef
Merepresentasikan info Backbone Router ND Proxy.

Fungsi
otBackboneRouterConfigNextDuaRegistrationResponse(otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Mengonfigurasi status respons untuk pendaftaran DUA berikutnya.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse(otInstance *aInstance, uint8_t aStatus)
void
Mengonfigurasi status respons untuk Pendaftaran Pemroses Multicast berikutnya.
otBackboneRouterGetConfig(otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Mendapatkan konfigurasi Backbone Router lokal.
otBackboneRouterGetDomainPrefix(otInstance *aInstance, otBorderRouterConfig *aConfig)
Mendapatkan konfigurasi Awalan Domain lokal.
otBackboneRouterGetNdProxyInfo(otInstance *aInstance, const otIp6Address *aDua, otBackboneRouterNdProxyInfo *aNdProxyInfo)
Mendapatkan info Backbone Router ND Proxy.
otBackboneRouterGetPrimary(otInstance *aInstance, otBackboneRouterConfig *aConfig)
Mendapatkan informasi Router Backbone Utama di Jaringan Thread.
otBackboneRouterGetRegistrationJitter(otInstance *aInstance)
uint8_t
Menampilkan nilai jitter pendaftaran Router Backbone.
otBackboneRouterGetState(otInstance *aInstance)
Mendapatkan bBackboneRouterState Router Backbone.
otBackboneRouterMulticastListenerAdd(otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Menambahkan Pemroses Multicast dengan nilai waktu tunggu, dalam detik.
otBackboneRouterMulticastListenerClear(otInstance *aInstance)
void
Menghapus Pemroses Multicast.
otBackboneRouterMulticastListenerGetNext(otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Mendapatkan info Pemroses Multicast berikutnya (menggunakan iterator).
otBackboneRouterRegister(otInstance *aInstance)
Mendaftarkan konfigurasi Backbone Router lokal secara eksplisit.
otBackboneRouterSetConfig(otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Menetapkan konfigurasi Backbone Router lokal otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback(otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Menetapkan callback Backbone Router Prefix.
otBackboneRouterSetEnabled(otInstance *aInstance, bool aEnable)
void
Mengaktifkan atau menonaktifkan fungsionalitas Backbone.
otBackboneRouterSetMulticastListenerCallback(otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Menetapkan callback Pemroses Multicast Router Backbone.
otBackboneRouterSetNdProxyCallback(otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Menetapkan callback Backbone Router ND Proxy.
otBackboneRouterSetRegistrationJitter(otInstance *aInstance, uint8_t aJitter)
void
Menetapkan nilai jitter pendaftaran Router Backbone.

Struct
otBackboneRouterConfig

Mewakili konfigurasi Backbone Router.

otBackboneRouterMulticastListenerInfo

Merepresentasikan info Pemroses Multicast Router Backbone.

otBackboneRouterNdProxyInfo

Merepresentasikan info Backbone Router ND Proxy.

Enumerasi

OTBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Merepresentasikan peristiwa Domain Prefix.

Properti
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED

Awalan Domain telah ditambahkan.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED

Awalan Domain telah diubah.

OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED

Awalan Domain telah dihapus.

OTBackboneRouterMulticastListenerEvent

 otBackboneRouterMulticastListenerEvent

Mewakili peristiwa Pemroses Multicast.

Properti
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Pemroses Multicast telah ditambahkan.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Pemroses Multicast telah dihapus atau habis masa berlakunya.

OTBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Mewakili peristiwa Proxy ND.

Properti
OT_BACKBONE_ROUTER_NDPROXY_ADDED

Proxy ND telah ditambahkan.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Semua ND Proxies dihapus.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

Proxy ND telah dihapus.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

Proxy ND telah diperpanjang.

OTBackboneRouterState

 otBackboneRouterState

Mewakili Status Backbone Router.

Properti
OT_BACKBONE_ROUTER_STATE_DISABLED

Fungsi backbone dinonaktifkan.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Router Backbone Utama.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router Backbone Sekunder.

Typedef

OTBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Mewakili konfigurasi Backbone Router.

OTBackboneRouterDomainPrefixCallback

void(* otBackboneRouterDomainPrefixCallback)(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix)

Pointer dipanggil setiap kali Awalan Domain berubah.

Detail
Parameter
[in] aContext
Pointer konteks pengguna.
[in] aEvent
Peristiwa Awalan Domain.
[in] aDomainPrefix
Awalan Domain baru jika ditambahkan atau diubah, nullptr.

OTBackboneRouterMulticastListenerCallback

void(* otBackboneRouterMulticastListenerCallback)(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress)

Pointer dipanggil setiap kali Pemroses Multicast berubah.

Detail
Parameter
[in] aContext
Pointer konteks pengguna.
[in] aEvent
Peristiwa Pemroses Multicast.
[in] aAddress
Alamat multicast IPv6 dari Pemroses Multicast.

OTBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Merepresentasikan info Pemroses Multicast Router Backbone.

OTBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Digunakan untuk melakukan iterasi melalui Pemroses Multicast.

OTBackboneRouterNdProxyCallback

void(* otBackboneRouterNdProxyCallback)(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua)

Pointer dipanggil setiap kali Proxy Nd berubah.

Detail
Parameter
[in] aContext
Pointer konteks pengguna.
[in] aEvent
Peristiwa Proxy ND.
[in] aDua
Alamat Unicast Domain dari Proxy ND, atau nullptr jika aEvent adalah OT_BACKBONE_ROUTER_NDPROXY_CLEARED.

OTBackboneRouterNdProxyInfo

struct otBackboneRouterNdProxyInfo otBackboneRouterNdProxyInfo

Merepresentasikan info Backbone Router ND Proxy.

Fungsi

OTBackboneRouterConfigNextDuaRegistrationResponse

void otBackboneRouterConfigNextDuaRegistrationResponse(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aMlIid,
  uint8_t aStatus
)

Mengonfigurasi status respons untuk pendaftaran DUA berikutnya.

Catatan: hanya tersedia jika OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan. Hanya digunakan untuk pengujian dan sertifikasi.

TODO: (DUA) mendukung kode error coap dan proses yang sesuai untuk tujuan sertifikasi.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMlIid
Pointer ke IID Lokal Mesh. Jika NULL, respons dengan aStatus untuk DUA.req yang akan datang. Jika tidak, balas hanya dengan aMlIid yang cocok.
[in] aStatus
Status untuk merespons.

OTBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Mengonfigurasi status respons untuk Pendaftaran Pemroses Multicast berikutnya.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, dan OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aStatus
Status untuk merespons.

OTBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Mendapatkan konfigurasi Backbone Router lokal.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aConfig
Pointer tempat meletakkan konfigurasi Backbone Router lokal.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterSetConfig
otBackboneRouterRegister

OTBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Mendapatkan konfigurasi Awalan Domain lokal.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aConfig
Pointer ke konfigurasi Domain Prefix.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mendapatkan konfigurasi Awalan Domain.
OT_ERROR_NOT_FOUND
Tidak ada Awalan Domain yang dikonfigurasi.

OTBackboneRouterGetNdProxyInfo

otError otBackboneRouterGetNdProxyInfo(
  otInstance *aInstance,
  const otIp6Address *aDua,
  otBackboneRouterNdProxyInfo *aNdProxyInfo
)

Mendapatkan info Backbone Router ND Proxy.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDua
Alamat Unicast Domain.
[out] aNdProxyInfo
Pointer ke info Proxy ND.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mendapatkan info Proxy ND.
OT_ERROR_NOT_FOUND
Gagal menemukan Alamat Unicast Domain di tabel ND Proxy.

OTBackboneRouterGetPrimary

otError otBackboneRouterGetPrimary(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Mendapatkan informasi Router Backbone Utama di Jaringan Thread.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aConfig
Pointer tempat meletakkan informasi Router Backbone Utama.
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil mendapatkan informasi Router Backbone Utama.
OT_ERROR_NOT_FOUND
Tidak ada Router Backbone Utama.

OTBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Menampilkan nilai jitter pendaftaran Router Backbone.

Detail
Pengembalian
Nilai jitter pendaftaran Router Backbone.
Lihat juga:
otBackboneRouterSetRegistrationJitter

OTBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Mendapatkan bBackboneRouterState Router Backbone.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_BACKBONE_ROUTER_STATE_DISABLED
Fungsi backbone dinonaktifkan.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Router Backbone Sekunder.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Router Backbone Utama.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

OTBackboneRouterMulticastListenerTambahkan

otError otBackboneRouterMulticastListenerAdd(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint32_t aTimeout
)

Menambahkan Pemroses Multicast dengan nilai waktu tunggu, dalam detik.

Teruskan 0 untuk menggunakan waktu tunggu MLR default.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, dan OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aAddress
Alamat Pemroses Multicast.
[in] aTimeout
Waktu tunggu (dalam detik) dari Multicast Listener, atau 0 untuk menggunakan waktu tunggu MLR default.
Nilai yang Ditampilkan
OT_ERROR_NONE
Jika Pemroses Multicast berhasil ditambahkan.
OT_ERROR_INVALID_ARGS
Jika alamat Pemroses Multicast tidak valid.
OT_ERROR_NO_BUFS
Tidak ada ruang yang tersedia untuk menyimpan Pemroses Multicast.
Lihat juga:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerGetNext

OTBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Menghapus Pemroses Multicast.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE, OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE, dan OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Lihat juga:
otBackboneRouterMulticastListenerAdd
otBackboneRouterMulticastListenerGetNext

OTBackboneRouterMulticastListenerGetNext

otError otBackboneRouterMulticastListenerGetNext(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerIterator *aIterator,
  otBackboneRouterMulticastListenerInfo *aListenerInfo
)

Mendapatkan info Pemroses Multicast berikutnya (menggunakan iterator).

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke iterator. Jika berhasil, iterator akan diupdate untuk mengarah ke Pemroses Multicast berikutnya. Untuk mendapatkan entri pertama, iterator harus disetel ke OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
Pointer ke otBackboneRouterMulticastListenerInfo tempat informasi Pemroses Multicast berikutnya berada (jika berhasil).
Nilai yang Ditampilkan
OT_ERROR_NONE
Berhasil menemukan info Pemroses Multicast berikutnya (aListenerInfo berhasil diperbarui).
OT_ERROR_NOT_FOUND
Tidak ada info Pemroses Multicast berikutnya yang ditemukan.
Lihat juga:
otBackboneRouterMulticastListenerClear
otBackboneRouterMulticastListenerAdd

OTBackboneRouterDaftar

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Mendaftarkan konfigurasi Backbone Router lokal secara eksplisit.

Pesan Permintaan Data Server SRV_DATA.ntf dipicu untuk perangkat yang terpasang.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Nilai yang Ditampilkan
OT_ERROR_NO_BUFS
Ruang penyimpanan tidak cukup untuk menambahkan layanan Backbone Router.
OT_ERROR_NONE
Berhasil mengantrekan pesan Permintaan Data Server untuk dikirimkan.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

OTBackboneRouterSetConfig

otError otBackboneRouterSetConfig(
  otInstance *aInstance,
  const otBackboneRouterConfig *aConfig
)

Menetapkan konfigurasi Backbone Router lokal otBackboneRouterConfig.

Pesan Permintaan Data Server SRV_DATA.ntf dimulai secara otomatis jika Set Data BBR berubah untuk Router Backbone Utama.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Pointer ke konfigurasi Backbone Router untuk diterapkan.
Nilai yang Ditampilkan
OT_ERROR_NONE
Konfigurasi berhasil diperbarui.
OT_ERROR_INVALID_ARGS
Konfigurasi di aConfig tidak valid.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterRegister

OTBackboneRouterSetDomainPrefixCallback

void otBackboneRouterSetDomainPrefixCallback(
  otInstance *aInstance,
  otBackboneRouterDomainPrefixCallback aCallback,
  void *aContext
)

Menetapkan callback Backbone Router Prefix.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke callback Awalan Domain.
[in] aContext
Pointer konteks pengguna.

OTBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Mengaktifkan atau menonaktifkan fungsionalitas Backbone.

Jika diaktifkan, pesan Permintaan Data Server SRV_DATA.ntf dipicu untuk perangkat yang terpasang jika tidak ada Backbone Router Service di Data Jaringan Thread.

Jika dinonaktifkan, SRV_DATA.ntf akan dipicu jika Router Backbone berada dalam status Utama.

Tersedia saat OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE diaktifkan.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEnable
TRUE untuk mengaktifkan fungsionalitas Backbone, FALSE jika sebaliknya.
Lihat juga:
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

OTBackboneRouterSetMulticastListenerCallback

void otBackboneRouterSetMulticastListenerCallback(
  otInstance *aInstance,
  otBackboneRouterMulticastListenerCallback aCallback,
  void *aContext
)

Menetapkan callback Pemroses Multicast Router Backbone.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke callback Pemroses Multicast.
[in] aContext
Pointer konteks pengguna.

OTBackboneRouterSetNdProxyCallback

void otBackboneRouterSetNdProxyCallback(
  otInstance *aInstance,
  otBackboneRouterNdProxyCallback aCallback,
  void *aContext
)

Menetapkan callback Backbone Router ND Proxy.

Detail
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Pointer ke callback Proxy ND.
[in] aContext
Pointer konteks pengguna.

OTBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Menetapkan nilai jitter pendaftaran Router Backbone.

Detail
Parameter
[in] aJitter
nilai jitter pendaftaran Router Backbone.
Lihat juga:
otBackboneRouterGetRegistrationJitter

Makro

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Penginisialisasi otBackboneRouterMulticastListenerIterator.

Resource

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