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

Umum

Modul ini mencakup fungsi untuk semua peran Thread.

Ringkasan

Penerbit Data Jaringan menyediakan mekanisme untuk membatasi jumlah entri Layanan dan/atau Awalan yang serupa (awalan on-mesh atau rute eksternal) di Data Jaringan Utas dengan memantau Data Jaringan dan mengelola jika atau kapan harus menambah atau menghapus entri.

Semua fungsi dalam modul ini memerlukan OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE harus diaktifkan.

Enumerasi

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}		 enum
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}		 enum
Mewakili peran perangkat Thread.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}		 enum
Pencacahan ini mewakili peristiwa yang dilaporkan dari callback Publisher.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}		 enum
Mendefinisikan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig .

Typedefs

otBorderRouterConfig typedef
Struktur ini mewakili konfigurasi Border Router.
otExternalRouteConfig typedef
Struktur ini mewakili konfigurasi Rute Eksternal.
otIpCounters typedef
struct otIpCounters
Struktur ini mewakili penghitung level IP.
otLeaderData typedef
struct otLeaderData
Struktur ini mewakili Data Pemimpin Utas.
otLinkModeConfig typedef
Struktur ini mewakili konfigurasi Mode Tautan MLE.
otMleCounters typedef
Struktur ini mewakili penghitung Thread MLE.
otNeighborInfoIterator typedef
int16_t
Digunakan untuk beralih melalui tabel tetangga.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Jenis penunjuk fungsi ini menentukan panggilan balik yang digunakan untuk memberi tahu ketika entri "Layanan DNS/SRP" ditambahkan ke atau dihapus dari Data Jaringan Utas.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Jenis penunjuk fungsi ini mendefinisikan panggilan balik yang digunakan untuk memberi tahu saat entri awalan (on-mesh atau rute eksternal) ditambahkan ke atau dihapus dari Data Jaringan Utas.
otNetDataPublisherEvent typedef
Pencacahan ini mewakili peristiwa yang dilaporkan dari callback Publisher.
otNetworkDataIterator typedef
uint32_t
Digunakan untuk beralih melalui informasi Data Jaringan.
otNetworkDiagChildEntry typedef
Struktur ini mewakili Entri Tabel Anak Diagnostik Jaringan.
otNetworkDiagConnectivity typedef
Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.
otNetworkDiagIterator typedef
uint16_t
Digunakan untuk beralih melalui Network Diagnostic TLV.
otNetworkDiagMacCounters typedef
Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.
otNetworkDiagRoute typedef
Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.
otNetworkDiagRouteData typedef
Struktur ini merepresentasikan data Network Diagnostic Route.
otNetworkDiagTlv typedef
Struktur ini mewakili TLV Diagnostik Jaringan.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil saat respons Network Diagnostic Get diterima.
otRoutePreference typedef
Mendefinisikan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig .
otServerConfig typedef
Struktur ini mewakili konfigurasi Server.
otServiceConfig typedef
Struktur ini mewakili konfigurasi Layanan.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Tipe fungsi pointer ini mendefinisikan callback untuk memberitahu hasil dari otThreadLocateAnycastDestination() permintaan.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Penunjuk fungsi ini dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.
otThreadDiscoveryRequestInfo typedef
Struktur ini mewakili data Permintaan Penemuan Utas.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Pointer fungsi ini dipanggil setiap kali pesan MLE Parent Response diterima.
otThreadParentResponseInfo typedef
Struktur ini mewakili data Respon Orang Tua MLE.

Fungsi

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Metode ini menyediakan salinan penuh atau stabil dari Data Jaringan Utas Partisi.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Fungsi ini mendapatkan Awalan On Mesh berikutnya di Data Jaringan partisi.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Fungsi ini mendapatkan rute eksternal berikutnya di Data Jaringan partisi.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Fungsi ini mendapatkan layanan berikutnya di Data Jaringan partisi.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
Dapatkan Versi Data Jaringan Stabil.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
Dapatkan Versi Data Jaringan.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah entri "Layanan DNS/SRP" saat ini ditambahkan ke Data Jaringan Utas atau tidak.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Fungsi ini menunjukkan apakah entri awalan yang diterbitkan saat ini (on-mesh atau rute eksternal) ditambahkan ke Data Jaringan Utas atau tidak.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
Fungsi ini meminta "Alamat Anycast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Fungsi ini meminta "Alamat Unicast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
Fungsi ini meminta "Alamat Unicast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
Fungsi ini meminta awalan rute eksternal untuk dipublikasikan di Data Jaringan Utas.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
Fungsi ini meminta awalan on-mesh untuk dipublikasikan di Data Jaringan Utas.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Fungsi ini menetapkan panggilan balik untuk memberi tahu saat "Layanan DNS/SRP" yang diterbitkan sebenarnya ditambahkan atau dihapus dari Data Jaringan Utas.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Fungsi ini menetapkan panggilan balik untuk memberi tahu saat entri awalan yang diterbitkan sebenarnya ditambahkan atau dihapus dari Data Jaringan Utas.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Periksa apakah data kemudi termasuk Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Periksa apakah data kemudi menyertakan Joiner dengan nilai pembeda tertentu.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
Fungsi ini membatalkan publikasi entri "Layanan DNS/SRP (Anycast atau Unicast)" yang ditambahkan sebelumnya dari Data Jaringan Utas.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
Fungsi ini membatalkan penerbitan awalan yang diterbitkan sebelumnya (on-mesh atau rute eksternal).
otThreadBecomeChild ( otInstance *aInstance)
Mencoba untuk memasang kembali sebagai seorang anak.
otThreadBecomeDetached ( otInstance *aInstance)
Lepaskan dari jaringan Thread.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
Ubah peran perangkat menjadi string yang dapat dibaca manusia.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Fungsi ini memulai pemindaian Thread Discovery.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
Gunakan Thread Child Timeout saat beroperasi dalam peran Child.
otThreadGetDeviceRole ( otInstance *aInstance)
Dapatkan peran perangkat.
otThreadGetDomainName ( otInstance *aInstance)
const char *
Dapatkan Nama Domain Utas.
otThreadGetExtendedPanId ( otInstance *aInstance)
Dapatkan IEEE 802.15.4 Extended PAN ID.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
Dapatkan Pengidentifikasi Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
Dapatkan penghitung IPv6.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
Dapatkan thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
Dapatkan thrKeySwitchGuardTime.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
Fungsi ini mendapatkan Data Pemimpin Thread.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
Fungsi ini mengembalikan pointer ke RLOC Leader.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
Dapatkan ID Router Pemimpin.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
Dapatkan Berat Pemimpin.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Fungsi ini mengembalikan alamat multicast Thread Link-Local All Thread Nodes.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
Fungsi ini mengembalikan alamat IPv6 tautan-lokal Thread.
otThreadGetLinkMode ( otInstance *aInstance)
Dapatkan konfigurasi Mode Tautan MLE.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
Fungsi ini mengembalikan pointer ke alamat EID Lokal Mesh.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
Fungsi ini mengembalikan pointer ke Mesh Local Prefix.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
Dapatkan penghitung Thread MLE.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Dapatkan Kunci Jaringan Utas.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
Dapatkan otNetworkKeyRef untuk Thread Jaringan Key.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
Dapatkan Nama Jaringan Utas.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Fungsi ini mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Fungsi ini mendapatkan informasi tetangga berikutnya.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
Fungsi mengambil RSSI rata-rata untuk Induk Thread.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
Fungsi ini mengambil informasi diagnostik untuk Thread Router sebagai induk.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
Fungsi ini mengambil RSSI dari paket terakhir dari Induk Thread.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
Dapatkan ID Partisi.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Fungsi ini mengembalikan alamat multicast Thread Realm-Local All Thread Nodes.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
Fungsi ini mengembalikan pointer ke alamat Thread Routing Locator (RLOC).
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
Dapatkan RLOC16.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Fungsi ini mengambil ALOC Layanan untuk ID Layanan yang diberikan.
otThreadGetVersion (void)
uint16_t
Fungsi ini mendapatkan versi protokol Thread.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah permintaan lokasi anycast sedang berlangsung.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
Fungsi ini menentukan apakah MLE Thread Discovery sedang berlangsung.
otThreadIsSingleton ( otInstance *aInstance)
bool
Fungsi ini menunjukkan apakah sebuah node adalah satu-satunya router di jaringan.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Fungsi ini meminta tujuan terdekat dari alamat anycast yang diberikan untuk ditempatkan.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Fungsi ini mendaftarkan panggilan balik untuk menerima data Respon Orang Tua MLE.
otThreadResetIp6Counters ( otInstance *aInstance)
void
Setel ulang penghitung IPv6.
otThreadResetMleCounters ( otInstance *aInstance)
void
Atur ulang penghitung Thread MLE.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Fungsi ini mengirimkan pesan Pemberitahuan Alamat Proaktif (ADDR_NTF.ntf).
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Kirim permintaan Dapatkan Diagnostik Jaringan.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Kirim permintaan Reset Diagnostik Jaringan.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Fungsi ini mengirimkan pesan Proactive Backbone Notification (PRO_BB.ntf) pada link Backbone.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
Atur Batas Waktu Anak Utas yang digunakan saat beroperasi dalam peran Anak.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Fungsi ini menetapkan panggilan balik untuk menerima data Permintaan Penemuan MLE.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
Tetapkan Nama Domain Utas.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
Fungsi ini memulai operasi protokol Thread.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Tetapkan IEEE 802.15.4 Extended PAN ID.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Atur/Hapus Pengidentifikasi Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Metode ini menetapkan Iklan Penggabung Utas saat menemukan jaringan Utas.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Setel thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Setel thrKeySwitchGuardTime.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
Atur konfigurasi Mode Tautan MLE.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Fungsi ini menetapkan Awalan Lokal Mesh.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
Setel Kunci Jaringan Utas.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
Mengatur Thread Jaringan Key sebagai otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
Tetapkan Nama Jaringan Utas.

Struktur

otBorderRouterConfig

Struktur ini mewakili konfigurasi Border Router.

otExternalRouteConfig

Struktur ini mewakili konfigurasi Rute Eksternal.

otIpCounters

Struktur ini mewakili penghitung level IP.

otLeaderData

Struktur ini mewakili Data Pemimpin Utas.

otLinkModeConfig

Struktur ini mewakili konfigurasi Mode Tautan MLE.

otMleCounters

Struktur ini mewakili penghitung Thread MLE.

otNeighborInfo

Struktur ini menyimpan informasi diagnostik untuk node Thread tetangga.

otNetworkDiagChildEntry

Struktur ini mewakili Entri Tabel Anak Diagnostik Jaringan.

otNetworkDiagConnectivity

Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagMacCounters

Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.

otNetworkDiagRoute

Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

Struktur ini merepresentasikan data Network Diagnostic Route.

otNetworkDiagTlv

Struktur ini mewakili TLV Diagnostik Jaringan.

otRouterInfo

Struktur ini menyimpan informasi diagnostik untuk Thread Router.

otServerConfig

Struktur ini mewakili konfigurasi Server.

otServiceConfig

Struktur ini mewakili konfigurasi Layanan.

otThreadDiscoveryRequestInfo

Struktur ini mewakili data Permintaan Penemuan Utas.

otThreadParentResponseInfo

Struktur ini mewakili data Respon Orang Tua MLE.

Enumerasi

enum anonim

 anonymous enum
Properti
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

TLV Tingkat Baterai.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

Halaman Saluran TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Tabel Anak TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Konektivitas TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

MAC Extended Address TLV.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

Daftar Alamat IPv6 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

Data Pemimpin TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

Penghitung MAC TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

TLV Batas Waktu Anak Maks.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Modus TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV Data Jaringan.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Rute64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Alamat16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Tegangan Pasokan TLV.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Timeout TLV (periode waktu pemungutan suara maksimum untuk SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Ketik Daftar TLV.

otPeranPerangkat

 otDeviceRole

Mewakili peran perangkat Thread.

Properti
OT_DEVICE_ROLE_CHILD

Peran Anak Benang.

OT_DEVICE_ROLE_DETACHED

Saat ini tidak berpartisipasi dalam jaringan/partisi Thread.

OT_DEVICE_ROLE_DISABLED

Tumpukan Utas dinonaktifkan.

OT_DEVICE_ROLE_LEADER

Peran Pemimpin Benang.

OT_DEVICE_ROLE_ROUTER

Peran Router Utas.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Pencacahan ini mewakili peristiwa yang dilaporkan dari callback Publisher.

Properti
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

Entri yang diterbitkan ditambahkan ke Data Jaringan Utas.

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Entri yang diterbitkan dihapus dari Data Jaringan Utas.

otRutePreference

 otRoutePreference

Mendefinisikan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig .

Properti
OT_ROUTE_PREFERENCE_HIGH

Preferensi rute tinggi.

OT_ROUTE_PREFERENCE_LOW

Preferensi rute rendah.

OT_ROUTE_PREFERENCE_MED

Preferensi rute sedang.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

Struktur ini mewakili konfigurasi Border Router.

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Struktur ini mewakili konfigurasi Rute Eksternal.

otIpCounters

struct otIpCounters otIpCounters

Struktur ini mewakili penghitung level IP.

otLeaderData

struct otLeaderData otLeaderData

Struktur ini mewakili Data Pemimpin Utas.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Struktur ini mewakili konfigurasi Mode Tautan MLE.

otMleCounters

struct otMleCounters otMleCounters

Struktur ini mewakili penghitung Thread MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Digunakan untuk beralih melalui tabel tetangga.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Jenis penunjuk fungsi ini menentukan panggilan balik yang digunakan untuk memberi tahu saat entri "Layanan DNS/SRP" ditambahkan ke atau dihapus dari Data Jaringan Utas.

Pada menghapus callback dipanggil terlepas apakah entri dihapus oleh Publisher (misalnya, ketika ada terlalu banyak entri yang sama sudah ada dalam data Jaringan) atau melalui panggilan eksplisit untuk membatalkan publikasi entri (yaitu, panggilan untuk otNetDataUnpublishDnsSrpService() ).

rincian
Parameter
[in] aEvent
Menunjukkan acara (apakah entri ditambahkan atau dihapus).
[in] aContext
Pointer ke konteks khusus aplikasi.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

Jenis penunjuk fungsi ini mendefinisikan panggilan balik yang digunakan untuk memberi tahu saat entri awalan (on-mesh atau rute eksternal) ditambahkan ke atau dihapus dari Data Jaringan Utas.

Pada menghapus callback dipanggil terlepas apakah entri dihapus oleh Publisher (misalnya, ketika ada terlalu banyak entri yang sama sudah ada dalam data Jaringan) atau melalui panggilan eksplisit untuk membatalkan publikasi entri.

rincian
Parameter
[in] aEvent
Menunjukkan acara (apakah entri ditambahkan atau dihapus).
[in] aPrefix
Sebuah pointer ke entri awalan.
[in] aContext
Pointer ke konteks khusus aplikasi.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Pencacahan ini mewakili peristiwa yang dilaporkan dari callback Publisher.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Digunakan untuk beralih melalui informasi Data Jaringan.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

Struktur ini mewakili Entri Tabel Anak Diagnostik Jaringan.

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

Struktur ini mewakili nilai Konektivitas Diagnostik Jaringan.

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Digunakan untuk beralih melalui Network Diagnostic TLV.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Struktur ini mewakili nilai Penghitung Mac Diagnostik Jaringan.

Lihat RFC 2863 untuk definisi dari bidang anggota.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Struktur ini mewakili nilai TLV Rute Diagnostik Jaringan.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Struktur ini merepresentasikan data Network Diagnostic Route.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Struktur ini mewakili TLV Diagnostik Jaringan.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

Penunjuk fungsi ini dipanggil saat respons Network Diagnostic Get diterima.

rincian
Parameter
[in] aError
Kesalahan saat gagal mendapatkan respons.
[in] aMessage
Pointer ke buffer pesan yang berisi Network Diagnostic Get response payload yang diterima. Tersedia hanya ketika aError adalah OT_ERROR_NONE .
[in] aMessageInfo
Sebuah pointer ke info pesan untuk aMessage . Tersedia hanya ketika aError adalah OT_ERROR_NONE .
[in] aContext
Pointer ke konteks khusus aplikasi.

otRutePreference

enum otRoutePreference otRoutePreference

Mendefinisikan nilai yang valid untuk mPreference di otExternalRouteConfig dan otBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

Struktur ini mewakili konfigurasi Server.

otServiceConfig

struct otServiceConfig otServiceConfig

Struktur ini mewakili konfigurasi Layanan.

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Tipe fungsi pointer ini mendefinisikan callback untuk memberitahu hasil dari otThreadLocateAnycastDestination() permintaan.

rincian
Parameter
[in] aContext
Pointer ke konteks arbitrer (disediakan saat panggilan balik didaftarkan).
[in] aError
Kesalahan saat menangani permintaan. OT_ERROR_NONE menunjukkan keberhasilan. OT_ERROR_RESPONSE_TIMEOUT menunjukkan tujuan tidak dapat ditemukan. OT_ERROR_ABORT menunjukkan permintaan dibatalkan.
[in] aMeshLocalAddress
Sebuah pointer ke EID mesh lokal tujuan terdekat dari alamat anycast ketika aError adalah OT_ERROR_NONE, NULL sebaliknya.
[in] aRloc16
RLOC16 tujuan jika ditemukan, jika tidak, RLOC16 tidak valid (0xffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Penunjuk fungsi ini dipanggil setiap kali pesan Permintaan Penemuan MLE diterima.

rincian
Parameter
[in] aInfo
Pointer ke data info Permintaan Penemuan.
[in] aContext
Pointer ke konteks khusus aplikasi callback.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Struktur ini mewakili data Permintaan Penemuan Utas.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Pointer fungsi ini dipanggil setiap kali pesan MLE Parent Response diterima.

rincian
Parameter
[in] aStats
penunjuk ke lokasi di tumpukan yang menyimpan data statistik.
[in] aContext
Pointer ke konteks khusus klien panggilan balik.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Struktur ini mewakili data Respon Orang Tua MLE.

Fungsi

otNetDataGet

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

Metode ini menyediakan salinan penuh atau stabil dari Data Jaringan Utas Partisi.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aStable
BENAR saat menyalin versi stabil, SALAH saat menyalin versi lengkap.
[out] aData
Sebuah pointer ke buffer data.
[in,out] aDataLength
Pada entri, ukuran buffer data yang ditunjuk oleh aData . Saat keluar, jumlah byte yang disalin.

otNetDataGetNextOnMeshPrefix

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

Fungsi ini mendapatkan Awalan On Mesh berikutnya di Data Jaringan partisi.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri on-mesh pertama, itu harus disetel ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi On Mesh Prefix akan ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan awalan On Mesh berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada awalan On Mesh berikutnya di Data Jaringan Utas.

otNetDataGetNextRoute

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

Fungsi ini mendapatkan rute eksternal berikutnya di Data Jaringan partisi.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri rute eksternal pertama, itu harus disetel ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Pointer ke tempat informasi Rute Eksternal akan ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan Rute Eksternal berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada entri rute eksternal berikutnya di Data Jaringan Utas.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

Fungsi ini mendapatkan layanan berikutnya di Data Jaringan partisi.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Pointer ke konteks iterator Data Jaringan. Untuk mendapatkan entri layanan pertama, itu harus disetel ke OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Sebuah pointer ke mana informasi layanan akan ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan layanan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada layanan berikutnya di Data Jaringan partisi.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Dapatkan Versi Data Jaringan Stabil.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Versi Data Jaringan Stabil.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Dapatkan Versi Data Jaringan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Versi Data Jaringan.

otNetDataIsDnsSrpServiceDitambahkan

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah entri "Layanan DNS/SRP" saat ini ditambahkan ke Data Jaringan Utas atau tidak.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
TRUE
Entri Layanan DNS/SRP yang diterbitkan ditambahkan ke Data Jaringan Utas.
FLASE
Entri tidak ditambahkan ke Data Jaringan Utas atau tidak ada entri untuk dipublikasikan.

otNetDataIsPrefixDitambahkan

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Fungsi ini menunjukkan apakah entri awalan yang diterbitkan saat ini (on-mesh atau rute eksternal) ditambahkan ke Data Jaringan Utas atau tidak.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Pointer ke awalan (HARUS TIDAK NULL).
Mengembalikan Nilai
TRUE
Entri awalan yang diterbitkan ditambahkan ke Data Jaringan Utas.
FLASE
Entri tidak ditambahkan ke Data Jaringan Utas atau tidak ada entri untuk dipublikasikan.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Fungsi ini meminta "Alamat Anycast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

Panggilan untuk fungsi ini akan menghapus dan mengganti sebelumnya "DNS / SRP Service" entri yang diterbitkan (dari panggilan sebelumnya ke salah otNetDataPublishDnsSrpService{Type}() fungsi).

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aSequenceNUmber
Nomor urut Layanan Anycast DNS/SRP.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Fungsi ini meminta "Alamat Unicast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

Panggilan untuk fungsi ini akan menghapus dan mengganti sebelumnya "DNS / SRP Service" entri yang diterbitkan (dari panggilan sebelumnya ke salah otNetDataPublishDnsSrpService{Type}() fungsi).

Fungsi ini menerbitkan "Alamat Unicast Layanan DNS/SRP" dengan memasukkan alamat dan info port dalam data TLV Layanan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aAddress
Alamat server DNS/SRP yang akan dipublikasikan (HARUS TIDAK NULL).
[in] aPort
Nomor port server SRP yang akan dipublikasikan.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Fungsi ini meminta "Alamat Unicast Layanan DNS/SRP" untuk dipublikasikan di Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

Panggilan untuk fungsi ini akan menghapus dan mengganti sebelumnya "DNS / SRP Service" entri yang diterbitkan (dari panggilan sebelumnya ke salah otNetDataPublishDnsSrpService{Type}() fungsi).

Tidak seperti otNetDataPublishDnsSrpServiceUnicast() yang memerlukan alamat diterbitkan untuk diberikan dan termasuk info di data Jasa TLV, fungsi ini menggunakan EID mesh lokal perangkat dan termasuk info di data Server TLV.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPort
Nomor port server SRP yang akan dipublikasikan.

otNetDataPublishExternalRoute

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

Fungsi ini meminta awalan rute eksternal untuk dipublikasikan di Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

Hanya entri yang stabil dapat dipublikasikan (yaitu, aConfig.mStable HARUS BENAR).

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Konfigurasi rute eksternal untuk dipublikasikan (HARUS TIDAK NULL).
Mengembalikan Nilai
OT_ERROR_NONE
Rute eksternal berhasil diterbitkan.
OT_ERROR_INVALID_ARGS
The aConfig tidak valid (awalan buruk, kombinasi bendera tidak valid, atau tidak stabil).
OT_ERROR_ALREADY
Entri dengan awalan yang sama sudah ada dalam daftar yang diterbitkan.
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penerbit mendukung sejumlah entri (dibagi antara on-jala awalan dan rute eksternal) ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMeshPrefix

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

Fungsi ini meminta awalan on-mesh untuk dipublikasikan di Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

Hanya entri yang stabil dapat dipublikasikan (yaitu, aConfig.mStable HARUS BENAR).

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aConfig
Konfigurasi awalan on-mesh untuk dipublikasikan (HARUS TIDAK NULL).
Mengembalikan Nilai
OT_ERROR_NONE
Awalan on-mesh berhasil diterbitkan.
OT_ERROR_INVALID_ARGS
The aConfig tidak valid (awalan buruk, kombinasi bendera tidak valid, atau tidak stabil).
OT_ERROR_ALREADY
Entri dengan awalan yang sama sudah ada dalam daftar yang diterbitkan.
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan entri untuk permintaan baru. Penerbit mendukung sejumlah entri (dibagi antara on-jala awalan dan rute eksternal) ditentukan oleh konfigurasi OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Fungsi ini menetapkan panggilan balik untuk memberi tahu ketika "Layanan DNS/SRP" yang diterbitkan sebenarnya ditambahkan atau dihapus dari Data Jaringan Utas.

Panggilan berikutnya ke fungsi ini menggantikan fungsi panggilan balik yang ditetapkan sebelumnya.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Penunjuk fungsi panggilan balik (bisa NULL jika tidak diperlukan).
[in] aContext
Sebuah pointer ke konteks aplikasi khusus (digunakan ketika aCallback dipanggil).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

Fungsi ini menetapkan panggilan balik untuk memberi tahu saat entri awalan yang diterbitkan sebenarnya ditambahkan atau dihapus dari Data Jaringan Utas.

Panggilan berikutnya ke fungsi ini menggantikan fungsi panggilan balik yang ditetapkan sebelumnya.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Penunjuk fungsi panggilan balik (bisa NULL jika tidak diperlukan).
[in] aContext
Sebuah pointer ke konteks aplikasi khusus (digunakan ketika aCallback dipanggil).

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Periksa apakah data kemudi termasuk Joiner.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEui64
Sebuah pointer ke Joiner's IEEE EUI-64.
Mengembalikan Nilai
OT_ERROR_NONE
aEui64 termasuk dalam data kemudi.
OT_ERROR_INVALID_STATE
Tidak ada data kemudi.
OT_ERROR_NOT_FOUND
aEui64 tidak termasuk dalam data kemudi.

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Periksa apakah data kemudi menyertakan Joiner dengan nilai pembeda tertentu.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDiscerner
Sebuah pointer ke Joiner Discerner.
Mengembalikan Nilai
OT_ERROR_NONE
aDiscerner termasuk dalam data kemudi.
OT_ERROR_INVALID_STATE
Tidak ada data kemudi.
OT_ERROR_NOT_FOUND
aDiscerner tidak termasuk dalam data kemudi.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Fungsi ini membatalkan publikasi entri "Layanan DNS/SRP (Anycast atau Unicast)" yang ditambahkan sebelumnya dari Data Jaringan Utas.

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.

otNetDataUnpublishPrefix

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

Fungsi ini membatalkan penerbitan awalan yang diterbitkan sebelumnya (on-mesh atau rute eksternal).

Fungsi ini memerlukan fitur OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPrefix
Awalan untuk membatalkan publikasi (HARUS TIDAK NULL).
Mengembalikan Nilai
OT_ERROR_NONE
Awalan berhasil dibatalkan publikasinya.
OT_ERROR_NOT_FOUND
Tidak dapat menemukan awalan dalam daftar yang dipublikasikan.

otBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Mencoba untuk memasang kembali sebagai seorang anak.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil memulai usaha untuk menjadi seorang anak.
OT_ERROR_INVALID_STATE
Utas dinonaktifkan.

otThreadMenjadiTerpisah

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Lepaskan dari jaringan Thread.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil terlepas dari jaringan Thread.
OT_ERROR_INVALID_STATE
Utas dinonaktifkan.

otThreadDevicePeranToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Ubah peran perangkat menjadi string yang dapat dibaca manusia.

rincian
Parameter
[in] aRole
Peran perangkat untuk dikonversi.
Kembali
Sebuah string yang mewakili aRole .

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Fungsi ini memulai pemindaian Thread Discovery.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aScanChannels
Vektor bit yang menunjukkan saluran mana yang akan dipindai (misalnya OT_CHANNEL_11_MASK).
[in] aPanId
Filter ID PAN (setel ke Broadcast PAN untuk menonaktifkan filter).
[in] aJoiner
Nilai Bendera Penggabung di TLV Permintaan Penemuan.
[in] aEnableEui64Filtering
TRUE untuk memfilter tanggapan pada EUI-64, FALSE sebaliknya.
[in] aCallback
Pointer ke fungsi yang dipanggil saat menerima MLE Discovery Response atau pemindaian selesai.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil memulai Pemindaian Penemuan Utas.
OT_ERROR_INVALID_STATE
Antarmuka IPv6 tidak diaktifkan (netif tidak aktif).
OT_ERROR_NO_BUFS
Tidak dapat mengalokasikan pesan untuk Permintaan Penemuan.
OT_ERROR_BUSY
Pemindaian Penemuan Utas sedang berlangsung.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

Gunakan Thread Child Timeout saat beroperasi dalam peran Child.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nilai Batas Waktu Anak Utas dalam detik.
Lihat juga:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

Dapatkan peran perangkat.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
OT_DEVICE_ROLE_DISABLED
Tumpukan Utas dinonaktifkan.
OT_DEVICE_ROLE_DETACHED
Perangkat saat ini tidak berpartisipasi dalam jaringan/partisi Thread.
OT_DEVICE_ROLE_CHILD
Perangkat saat ini beroperasi sebagai Thread Child.
OT_DEVICE_ROLE_ROUTER
Perangkat saat ini beroperasi sebagai Thread Router.
OT_DEVICE_ROLE_LEADER
Perangkat saat ini beroperasi sebagai Thread Leader.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Dapatkan Nama Domain Utas.

Fungsi ini hanya tersedia sejak Thread 1.2.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke Nama Domain Thread.
Lihat juga:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Dapatkan IEEE 802.15.4 Extended PAN ID.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke IEEE 802.15.4 Extended PAN ID.
Lihat juga:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

Dapatkan Pengidentifikasi Antarmuka yang ditentukan secara manual untuk Alamat Unicast Domain Thread.

Fungsi ini hanya tersedia sejak Thread 1,2 ketika OPENTHREAD_CONFIG_DUA_ENABLE diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Pointer ke Interface Identifier yang disetel secara manual, atau NULL jika tidak ada yang disetel.
Lihat juga:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

Dapatkan penghitung IPv6.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke counter IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Dapatkan thrKeySequenceCounter.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nilai thrKeySequenceCounter.
Lihat juga:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Dapatkan thrKeySwitchGuardTime.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nilai thrKeySwitchGuardTime (dalam jam).
Lihat juga:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Fungsi ini mendapatkan Data Pemimpin Thread.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderData
Sebuah pointer ke tempat data pemimpin ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengambil data pemimpin.
OT_ERROR_DETACHED
Saat ini tidak terpasang.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Fungsi ini mengembalikan pointer ke RLOC Leader.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLeaderRloc
Sebuah pointer ke RLOC Pemimpin.
Mengembalikan Nilai
OT_ERROR_NONE
Pemimpin ini RLOC berhasil ditulis untuk aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc adalah NULL.
OT_ERROR_DETACHED
Saat ini tidak dilampirkan ke Partisi Utas.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Dapatkan ID Router Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
ID Router Pemimpin.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

Dapatkan Berat Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Berat Pemimpin.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Fungsi ini mengembalikan alamat multicast Thread Link-Local All Thread Nodes.

Alamatnya adalah Alamat Multcast Berbasis Awalan Unicast link-lokal [RFC 3306], dengan:

  • flgs diatur ke 3 (P = 1 dan T = 1)
  • scop diatur ke 2
  • ple diatur ke 64
  • awalan jaringan diatur ke Awalan Lokal Mesh
  • ID grup disetel ke 1

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke alamat multicast Thread Link-Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Fungsi ini mengembalikan alamat IPv6 tautan-lokal Thread.

Alamat lokal tautan Thread diturunkan menggunakan IEEE802.15.4 Extended Address sebagai Interface Identifier.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke alamat IPv6 link-local Thread.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Dapatkan konfigurasi Mode Tautan MLE.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Konfigurasi Mode Tautan MLE.
Lihat juga:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Fungsi ini mengembalikan pointer ke alamat EID Lokal Mesh.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Pointer ke alamat EID Lokal Mesh.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Fungsi ini mengembalikan pointer ke Mesh Local Prefix.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Pointer ke Awalan Lokal Mesh.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Dapatkan penghitung Thread MLE.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke penghitung Thread MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Dapatkan Kunci Jaringan Utas.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aNetworkKey
Sebuah pointer ke otNetworkkey untuk mengembalikan Thread Jaringan Key.
Lihat juga:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Dapatkan otNetworkKeyRef untuk Thread Jaringan Key.

Fungsi ini memerlukan fitur build-waktu OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Referensi ke Kunci Jaringan Utas yang disimpan di memori.
Lihat juga:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Dapatkan Nama Jaringan Utas.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke Nama Jaringan Thread.
Lihat juga:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Fungsi ini mendapatkan TLV Diagnostik Jaringan berikutnya dalam pesan.

Panggilan berikutnya ke fungsi ini hanya diperbolehkan ketika nilai pengembalian saat ini adalah OT_ERROR_NONE.

rincian
Parameter
[in] aMessage
Sebuah pointer ke sebuah pesan.
[in,out] aIterator
Pointer ke konteks iterator Diagnostik Jaringan. Untuk mendapatkan TLV Diagnostik Jaringan pertama harus disetel ke OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Penunjuk ke tempat informasi TLV Diagnostik Jaringan akan ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan TLV Diagnostik Jaringan berikutnya.
OT_ERROR_NOT_FOUND
Tidak ada TLV Diagnostik Jaringan berikutnya dalam pesan.
OT_ERROR_PARSE
Penguraian Diagnostik Jaringan berikutnya gagal.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Fungsi ini mendapatkan informasi tetangga berikutnya.

Ini digunakan untuk menelusuri entri tabel tetangga.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in,out] aIterator
Sebuah pointer ke konteks iterator. Untuk mendapatkan entri tetangga pertama, itu harus disetel ke OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Sebuah pointer ke informasi tetangga.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan entri tetangga berikutnya di tabel.
OT_ERROR_NOT_FOUND
Tidak ada entri tetangga berikutnya dalam tabel.
OT_ERROR_INVALID_ARGS
aIterator atau aInfo adalah NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Fungsi mengambil RSSI rata-rata untuk Induk Thread.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aParentRssi
Sebuah pointer ke tempat RSSI induk harus ditempatkan.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

Fungsi ini mengambil informasi diagnostik untuk Thread Router sebagai induk.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aParentInfo
Sebuah pointer ke tempat informasi router induk ditempatkan.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

Fungsi ini mengambil RSSI dari paket terakhir dari Induk Thread.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aLastRssi
Sebuah pointer ke tempat RSSI terakhir harus ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengambil data RSSI.
OT_ERROR_FAILED
Tidak bisa mendapatkan data RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi adalah NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Dapatkan ID Partisi.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
ID Partisi.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Fungsi ini mengembalikan alamat multicast Thread Realm-Local All Thread Nodes.

Alamatnya adalah Alamat Multcast Berbasis Awalan Unicast real-local [RFC 3306], dengan:

  • flgs diatur ke 3 (P = 1 dan T = 1)
  • scop diatur ke 3
  • ple diatur ke 64
  • awalan jaringan diatur ke Awalan Lokal Mesh
  • ID grup disetel ke 1

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Sebuah pointer ke alamat multicast Thread Realm-Local All Thread Nodes.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Fungsi ini mengembalikan pointer ke alamat Thread Routing Locator (RLOC).

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Pointer ke alamat Thread Routing Locator (RLOC).

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Dapatkan RLOC16.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

Fungsi ini mengambil ALOC Layanan untuk ID Layanan yang diberikan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aServiceId
ID Layanan untuk mendapatkan ALOC.
[out] aServiceAloc
Pointer untuk menampilkan Service ALOC. TIDAK HARUS NULL.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengambil Layanan ALOC.
OT_ERROR_DETACHED
Antarmuka Utas saat ini tidak dilampirkan ke Partisi Utas.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

Fungsi ini mendapatkan versi protokol Thread.

rincian
Kembali
versi protokol Thread.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Fungsi ini menunjukkan apakah permintaan lokasi anycast sedang berlangsung.

Fungsi ini hanya tersedia bila OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
Mengembalikan Nilai
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
Konteks sewenang-wenang digunakan dengan aCallback .
Mengembalikan Nilai
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
Pointer ke konteks khusus aplikasi.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Mengembalikan Nilai
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Mengembalikan Nilai
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
Lihat juga:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
Lihat juga:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
Lihat juga:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
Lihat juga:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aOui
The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
Lihat juga:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
Lihat juga:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
Lihat juga:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
Lihat juga:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
Lihat juga:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

rincian
Parameter
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Mengembalikan Nilai
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
Lihat juga:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.