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

Router Backbone

Modul ini mencakup fungsi-fungsi untuk Layanan OpenThread Backbone Router.

Ringkasan

Pencacahan

otBackboneRouterDomainPrefixEvent {
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED = 0,
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED = 1,
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED = 2
}		 enum
Mewakili acara Awalan Domain.
otBackboneRouterMulticastListenerEvent {
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED = 0,
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED = 1
}		 enum
Mewakili acara Multicast Listener.
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
Merepresentasikan kejadian ND Proxy.
otBackboneRouterState {
OT_BACKBONE_ROUTER_STATE_DISABLED = 0,
OT_BACKBONE_ROUTER_STATE_SECONDARY = 1,
OT_BACKBONE_ROUTER_STATE_PRIMARY = 2
}		 enum
Merupakan Status Router Backbone.

Typedefs

otBackboneRouterConfig typedef
Struktur ini merepresentasikan konfigurasi Backbone Router.
otBackboneRouterDomainPrefixCallback )(void *aContext, otBackboneRouterDomainPrefixEvent aEvent, const otIp6Prefix *aDomainPrefix) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali Awalan Domain berubah.
otBackboneRouterMulticastListenerCallback )(void *aContext, otBackboneRouterMulticastListenerEvent aEvent, const otIp6Address *aAddress) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali Multicast Listeners berubah.
otBackboneRouterMulticastListenerInfo typedef
Struktur ini mewakili info Pendengar Multicast Router Backbone.
otBackboneRouterMulticastListenerIterator typedef
uint16_t
Digunakan untuk melakukan iterasi melalui Multicast Listeners.
otBackboneRouterNdProxyCallback )(void *aContext, otBackboneRouterNdProxyEvent aEvent, const otIp6Address *aDua) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali Nd Proxy berubah.

Fungsi

otBackboneRouterConfigNextDuaRegistrationResponse ( otInstance *aInstance, const otIp6InterfaceIdentifier *aMlIid, uint8_t aStatus)
void
Metode ini mengkonfigurasi status respons untuk pendaftaran DUA berikutnya.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse ( otInstance *aInstance, uint8_t aStatus)
void
Metode ini mengonfigurasi status respons untuk Pendaftaran Pemroses Multicast berikutnya.
otBackboneRouterGetConfig ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
void
Fungsi ini mendapatkan konfigurasi Router Backbone lokal.
otBackboneRouterGetDomainPrefix ( otInstance *aInstance, otBorderRouterConfig *aConfig)
Metode ini mendapatkan konfigurasi Awalan Domain lokal.
otBackboneRouterGetNdProxyInfo ( otInstance *aInstance, const otIp6Address *aDua,otBackboneRouterNdProxyInfo *aNdProxyInfo)
Metode ini mendapatkan info Proxy ND Router Backbone.
otBackboneRouterGetPrimary ( otInstance *aInstance, otBackboneRouterConfig *aConfig)
Fungsi ini mendapatkan informasi Primary Backbone Router di Thread Network.
otBackboneRouterGetRegistrationJitter ( otInstance *aInstance)
uint8_t
Metode ini mengembalikan nilai jitter pendaftaran Router Backbone.
otBackboneRouterGetState ( otInstance *aInstance)
Fungsi ini mendapatkan status Backbone Router.
otBackboneRouterMulticastListenerAdd ( otInstance *aInstance, const otIp6Address *aAddress, uint32_t aTimeout)
Metode ini menambahkan Multicast Listener.
otBackboneRouterMulticastListenerClear ( otInstance *aInstance)
void
Metode ini menghapus Multicast Listeners.
otBackboneRouterMulticastListenerGetNext ( otInstance *aInstance, otBackboneRouterMulticastListenerIterator *aIterator, otBackboneRouterMulticastListenerInfo *aListenerInfo)
Fungsi ini mendapatkan info Pemroses Multicast berikutnya (menggunakan iterator).
otBackboneRouterRegister ( otInstance *aInstance)
Fungsi ini secara eksplisit mendaftarkan konfigurasi Router Backbone lokal.
otBackboneRouterSetConfig ( otInstance *aInstance, const otBackboneRouterConfig *aConfig)
Fungsi ini menetapkan konfigurasi Router Backbone lokal.
otBackboneRouterSetDomainPrefixCallback ( otInstance *aInstance, otBackboneRouterDomainPrefixCallback aCallback, void *aContext)
void
Metode ini menyetel panggilan balik Awalan Domain Router Tulang Belakang.
otBackboneRouterSetEnabled ( otInstance *aInstance, bool aEnable)
void
Fungsi ini mengaktifkan atau menonaktifkan fungsionalitas Backbone.
otBackboneRouterSetMulticastListenerCallback ( otInstance *aInstance, otBackboneRouterMulticastListenerCallback aCallback, void *aContext)
void
Metode ini menyetel callback Multicast Router Backbone.
otBackboneRouterSetNdProxyCallback ( otInstance *aInstance, otBackboneRouterNdProxyCallback aCallback, void *aContext)
void
Metode ini menyetel callback ND Proxy Router Backbone.
otBackboneRouterSetRegistrationJitter ( otInstance *aInstance, uint8_t aJitter)
void
Metode ini menetapkan nilai jitter pendaftaran Router Backbone.

Structs

otBackboneRouterConfig

Struktur ini merepresentasikan konfigurasi Backbone Router.

otBackboneRouterMulticastListenerInfo

Struktur ini mewakili info Pendengar Multicast Router Backbone.

otBackboneRouterNdProxyInfo

Merepresentasikan info Proxy ND Router Backbone.

Pencacahan

otBackboneRouterDomainPrefixEvent

 otBackboneRouterDomainPrefixEvent

Mewakili acara 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 acara Multicast Listener.

Properti
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED

Multicast Listener telah ditambahkan.

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED

Multicast Listener telah dihapus atau kedaluwarsa.

otBackboneRouterNdProxyEvent

 otBackboneRouterNdProxyEvent

Merepresentasikan kejadian ND Proxy.

Properti
OT_BACKBONE_ROUTER_NDPROXY_ADDED

ND Proxy telah ditambahkan.

OT_BACKBONE_ROUTER_NDPROXY_CLEARED

Semua Proxy ND dihapus.

OT_BACKBONE_ROUTER_NDPROXY_REMOVED

ND Proxy telah dihapus.

OT_BACKBONE_ROUTER_NDPROXY_RENEWED

Proxy ND diperbarui.

otBackboneRouterState

 otBackboneRouterState

Merupakan Status Router Backbone.

Properti
OT_BACKBONE_ROUTER_STATE_DISABLED

Fungsi tulang punggung dinonaktifkan.

OT_BACKBONE_ROUTER_STATE_PRIMARY

Router Tulang Belakang Utama.

OT_BACKBONE_ROUTER_STATE_SECONDARY

Router Backbone Sekunder.

Typedefs

otBackboneRouterConfig

struct otBackboneRouterConfig otBackboneRouterConfig

Struktur ini merepresentasikan konfigurasi Backbone Router.

otBackboneRouterDomainPrefixCallback

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

Penunjuk fungsi ini dipanggil setiap kali Awalan Domain berubah.

Detail
Parameter
[in] aContext
Penunjuk konteks pengguna.
[in] aEvent
Acara Domain Prefix.
[in] aDomainPrefix
Awalan Domain baru jika ditambahkan atau diubah, nullptr sebaliknya.

otBackboneRouterMulticastListenerCallback

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

Penunjuk fungsi ini dipanggil setiap kali Multicast Listeners berubah.

Detail
Parameter
[in] aContext
Penunjuk konteks pengguna.
[in] aEvent
Acara Multicast Listener.
[in] aAddress
Alamat multicast IPv6 dari Multicast Listener.

otBackboneRouterMulticastListenerInfo

struct otBackboneRouterMulticastListenerInfo otBackboneRouterMulticastListenerInfo

Struktur ini mewakili info Pendengar Multicast Router Backbone.

otBackboneRouterMulticastListenerIterator

uint16_t otBackboneRouterMulticastListenerIterator

Digunakan untuk melakukan iterasi melalui Multicast Listeners.

otBackboneRouterNdProxyCallback

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

Penunjuk fungsi ini dipanggil setiap kali Nd Proxy berubah.

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

Fungsi

otBackboneRouterConfigNextDuaRegistrationResponse

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

Metode ini mengkonfigurasi status respons untuk pendaftaran DUA berikutnya.

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

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

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aMlIid
Penunjuk ke IID Lokal Mesh. Jika NULL, tanggapi dengan aStatus untuk aStatus akan datang, jika tidak, hanya tanggapi yang cocok dengan aMlIid .
[in] aStatus
Status untuk menanggapi.

otBackboneRouterConfigNextMulticastListenerRegistrationResponse

void otBackboneRouterConfigNextMulticastListenerRegistrationResponse(
  otInstance *aInstance,
  uint8_t aStatus
)

Metode ini mengonfigurasi status respons untuk Pendaftaran Pemroses Multicast berikutnya.

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

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aStatus
Status untuk menanggapi.

otBackboneRouterGetConfig

void otBackboneRouterGetConfig(
  otInstance *aInstance,
  otBackboneRouterConfig *aConfig
)

Fungsi ini mendapatkan konfigurasi Router Backbone lokal.

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

otBackboneRouterGetDomainPrefix

otError otBackboneRouterGetDomainPrefix(
  otInstance *aInstance,
  otBorderRouterConfig *aConfig
)

Metode ini mendapatkan konfigurasi Awalan Domain lokal.

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

otBackboneRouterGetNdProxyInfo

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

Metode ini mendapatkan info Proxy ND Router Backbone.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aDua
Alamat Domain Unicast.
[out] aNdProxyInfo
Pointer ke info Proxy ND.
Kembalikan Nilai
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
)

Fungsi ini mendapatkan informasi Primary Backbone Router di Thread Network.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[out] aConfig
Sebuah penunjuk ke tempat untuk meletakkan informasi Primary Backbone Router.
Kembalikan Nilai
OT_ERROR_NONE
Berhasil mendapatkan informasi Router Backbone Utama.
OT_ERROR_NOT_FOUND
Tidak ada Router Tulang Belakang Utama.

otBackboneRouterGetRegistrationJitter

uint8_t otBackboneRouterGetRegistrationJitter(
  otInstance *aInstance
)

Metode ini mengembalikan nilai jitter pendaftaran Router Backbone.

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

otBackboneRouterGetState

otBackboneRouterState otBackboneRouterGetState(
  otInstance *aInstance
)

Fungsi ini mendapatkan status Backbone Router.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembalikan Nilai
OT_BACKBONE_ROUTER_STATE_DISABLED
Fungsionalitas tulang punggung dinonaktifkan.
OT_BACKBONE_ROUTER_STATE_SECONDARY
Router Backbone Sekunder.
OT_BACKBONE_ROUTER_STATE_PRIMARY
Router Tulang Belakang Utama.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetConfig
otBackboneRouterSetConfig
otBackboneRouterRegister

otBackboneRouterMulticastListenerAdd

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

Metode ini menambahkan Multicast Listener.

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

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

otBackboneRouterMulticastListenerClear

void otBackboneRouterMulticastListenerClear(
  otInstance *aInstance
)

Metode ini menghapus Multicast Listeners.

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

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

otBackboneRouterMulticastListenerGetNext

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

Fungsi ini mendapatkan info Pemroses Multicast berikutnya (menggunakan iterator).

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in,out] aIterator
Penunjuk ke iterator. Jika berhasil, iterator akan diperbarui untuk mengarah ke Pemroses Multicast berikutnya. Untuk mendapatkan entri pertama, iterator harus disetel ke OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT.
[out] aListenerInfo
otBackboneRouterMulticastListenerInfo ke otBackboneRouterMulticastListenerInfo tempat informasi Pemroses Multicast berikutnya ditempatkan (jika berhasil).
Kembalikan Nilai
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

otBackboneRouterRegister

otError otBackboneRouterRegister(
  otInstance *aInstance
)

Fungsi ini secara eksplisit mendaftarkan konfigurasi Router Backbone lokal.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
Kembalikan Nilai
OT_ERROR_NO_BUFS
Ruang tidak cukup untuk menambahkan layanan Backbone Router.
OT_ERROR_NONE
Berhasil mengantri pesan Permintaan Data Server untuk pengiriman.
Lihat juga:
otBackboneRouterSetEnabled
otBackboneRouterGetState
otBackboneRouterGetConfig
otBackboneRouterSetConfig

otBackboneRouterSetConfig

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

Fungsi ini menetapkan konfigurasi Router Backbone lokal.

Detail
Parameter
[in] aInstance
Penunjuk ke instance OpenThread.
[in] aConfig
Sebuah penunjuk ke konfigurasi Router Backbone akan diterapkan.
Kembalikan Nilai
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
)

Metode ini menyetel panggilan balik Awalan Domain Router Tulang Belakang.

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

otBackboneRouterSetEnabled

void otBackboneRouterSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

Fungsi ini mengaktifkan atau menonaktifkan fungsionalitas Backbone.

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

otBackboneRouterSetMulticastListenerCallback

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

Metode ini menyetel callback Multicast Router Backbone.

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

otBackboneRouterSetNdProxyCallback

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

Metode ini menyetel callback ND Proxy Router Backbone.

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

otBackboneRouterSetRegistrationJitter

void otBackboneRouterSetRegistrationJitter(
  otInstance *aInstance,
  uint8_t aJitter
)

Metode ini menetapkan nilai jitter pendaftaran Router Backbone.

Detail
Parameter
[in] aJitter
nilai jitter registrasi Backbone Router untuk disetel.
Lihat juga:
otBackboneRouterGetRegistrationJitter

Makro

OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT

 OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT 0

Penginisialisasi untuk otBackboneRouterMulticastListenerIterator.