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

Router/Pemimpin

Modul ini mencakup fungsi untuk Thread Routers dan Leaders.

Ringkasan

Enumerasi

otCacheEntryState enum
Pencacahan ini mendefinisikan status entri cache EID.
otNeighborTableEvent {
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}		 enum
Pencacahan ini mendefinisikan konstanta yang digunakan dalam otNeighborTableCallback untuk menunjukkan perubahan dalam tabel tetangga.

Typedefs

otCacheEntryInfo typedef
Struktur ini mewakili entri cache EID.
otCacheEntryIterator typedef
Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.
otCacheEntryState typedef
Pencacahan ini mendefinisikan status entri cache EID.
otChildIp6AddressIterator typedef
uint16_t
Digunakan untuk beralih melalui alamat IPv6 dari entri Thread Child.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Penunjuk fungsi ini dipanggil untuk memberi tahu bahwa ada perubahan pada tabel tetangga.

Fungsi

otThreadBecomeLeader ( otInstance *aInstance)
Menjadi pemimpin dan memulai partisi baru.
otThreadBecomeRouter ( otInstance *aInstance)
Mencoba untuk menjadi router.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Fungsi ini menyimpan informasi diagnostik untuk Anak yang dilampirkan dengan ID Anak atau RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Fungsi ini menyimpan informasi diagnostik untuk Anak yang dilampirkan dengan indeks tabel internal.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Fungsi ini mendapatkan alamat IPv6 berikutnya (menggunakan iterator) untuk anak tertentu.
otThreadGetContextIdReuseDelay ( otInstance *aInstance)
uint32_t
Dapatkan parameter CONTEXT_ID_REUSE_DELAY yang digunakan dalam peran Pemimpin.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
Dapatkan Port UDP Joiner.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
Dapatkan Bobot Pemimpin Benang yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
Dapatkan jumlah maksimum anak yang diizinkan saat ini.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
Fungsi ini mendapatkan jumlah alamat IP maksimum yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
Fungsi mengembalikan ID router maksimum yang diizinkan.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
Dapatkan parameter NETWORK_ID_TIMEOUT yang digunakan dalam peran Router.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Fungsi ini mendapatkan entri cache EID berikutnya (menggunakan iterator).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
Dapatkan prioritas orang tua yang ditetapkan.
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)
uint32_t
Dapatkan ID Partisi Pemimpin Utas yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadGetPskc ( otInstance *aInstance, otPskc *aPskc)
void
Dapatkan Thread PSKc.
otThreadGetPskcRef ( otInstance *aInstance)
Dapatkan Referensi Kunci ke Thread PSKc yang disimpan.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Router.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Dapatkan Urutan ID Router saat ini.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
Fungsi ini menyimpan informasi diagnostik untuk Thread Router yang diberikan.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
Dapatkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran REED.
otThreadIsRouterEligible ( otInstance *aInstance)
bool
Metode ini menunjukkan apakah perangkat memenuhi syarat untuk router atau tidak.
otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)
void
Fungsi ini mendaftarkan fungsi panggilan balik tabel tetangga.
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)
Lepaskan ID Router yang telah dialokasikan oleh perangkat dalam peran Pemimpin.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Setel parameter CONTEXT_ID_REUSE_DELAY yang digunakan dalam peran Pemimpin.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Setel Port UDP Penggabung.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Atur Bobot Pemimpin Benang yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Tetapkan jumlah maksimum anak yang diizinkan saat ini.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Fungsi ini menetapkan/mengembalikan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Setel parameter NETWORK_ID_TIMEOUT yang digunakan dalam peran Pemimpin.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
Tetapkan prioritas orang tua.
otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
Tetapkan ID Partisi Pemimpin Utas yang digunakan saat beroperasi dalam peran Pemimpin.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Tetapkan Id Router yang disukai.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Atur Thread PSKc.
otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)
Atur Thread PSKc.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Setel parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
Fungsi ini menetapkan apakah perangkat memenuhi syarat untuk router atau tidak.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Setel parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Setel parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Atur data Kemudi keluar dari pita.

Struktur

otCacheEntryInfo

Struktur ini mewakili entri cache EID.

otCacheEntryIterator

Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

otChildInfo

Struktur ini menyimpan informasi diagnostik untuk Thread Child.

otNeighborTableEntryInfo

Tipe ini merupakan info entri tabel tetangga (anak atau router) dan digunakan sebagai parameter dalam tabel tetangga callback otNeighborTableCallback .

Enumerasi

otCacheEntryState

 otCacheEntryState

Pencacahan ini mendefinisikan status entri cache EID.

otNeighborTableAcara

 otNeighborTableEvent

Pencacahan ini mendefinisikan konstanta yang digunakan dalam otNeighborTableCallback untuk menunjukkan perubahan dalam tabel tetangga.

Properti
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED

Seorang anak sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Mode anak yang ada diubah.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Seorang anak sedang disingkirkan.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Sebuah router sedang ditambahkan.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Sebuah router sedang dihapus.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Struktur ini mewakili entri cache EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Jenis ini mewakili iterator yang digunakan untuk iterasi melalui entri tabel cache EID.

Untuk menginisialisasi iterator dan mulai dari entri pertama dalam tabel cache, mengatur semua bidang dalam struktur ke nol (misalnya, memset iterator ke nol).

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Pencacahan ini mendefinisikan status entri cache EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

Digunakan untuk beralih melalui alamat IPv6 dari entri Thread Child.

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Penunjuk fungsi ini dipanggil untuk memberi tahu bahwa ada perubahan pada tabel tetangga.

rincian
Parameter
[in] aEvent
Bendera acara.
[in] aEntryInfo
Pointer ke info entri tabel.

Fungsi

otThreadMenjadi Pemimpin

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Menjadi pemimpin dan memulai partisi baru.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menjadi pemimpin dan memulai partisi baru.
OT_ERROR_INVALID_STATE
Utas dinonaktifkan.

otThreadMenjadiRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Mencoba menjadi router.

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

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

Fungsi ini menyimpan informasi diagnostik untuk Anak yang dilampirkan dengan ID Anak atau RLOC16.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildId
ID Anak atau RLOC16 untuk anak yang dilampirkan.
[out] aChildInfo
Sebuah pointer ke tempat informasi anak ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
aChildInfo berhasil diperbarui dengan info untuk ID yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada anak yang valid dengan ID Anak ini.
OT_ERROR_INVALID_ARGS
Jika aChildInfo adalah NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

Fungsi ini menyimpan informasi diagnostik untuk Anak yang dilampirkan dengan indeks tabel internal.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildIndex
indeks meja.
[out] aChildInfo
Sebuah pointer ke tempat informasi anak ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
aChildInfo berhasil diperbarui dengan info untuk indeks yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada anak yang valid di indeks ini.
OT_ERROR_INVALID_ARGS
Entah aChildInfo adalah NULL, atau aChildIndex luar jangkauan (lebih tinggi dari indeks tabel max).
Lihat juga:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Fungsi ini mendapatkan alamat IPv6 berikutnya (menggunakan iterator) untuk anak tertentu.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aChildIndex
indeks anak.
[in,out] aIterator
Sebuah pointer ke iterator. Jika berhasil, iterator akan diperbarui untuk menunjuk ke entri berikutnya dalam daftar. Untuk mendapatkan alamat IPv6 pertama, iterator harus disetel ke OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Sebuah pointer ke alamat IPv6 di mana alamat anak berikutnya ditempatkan (berhasil).
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menemukan alamat IPv6 berikutnya ( aAddress telah berhasil diperbarui).
OT_ERROR_NOT_FOUND
Anak tidak memiliki entri alamat IPv6 berikutnya.
OT_ERROR_INVALID_ARGS
aIterator atau aAddress adalah NULL, atau anak di aChildIndex tidak valid.
Lihat juga:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

Dapatkan parameter CONTEXT_ID_REUSE_DELAY yang digunakan dalam peran Pemimpin.

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

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Dapatkan Port UDP Joiner.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nomor Port UDP Joiner.
Lihat juga:
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

Dapatkan Bobot Pemimpin Benang yang digunakan saat beroperasi dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nilai Bobot Pemimpin Thread.
Lihat juga:
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

Dapatkan jumlah maksimum anak yang diizinkan saat ini.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Jumlah maksimum anak yang diizinkan saat ini.
Lihat juga:
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

Fungsi ini mendapatkan jumlah alamat IP maksimum yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk.
Lihat juga:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

Fungsi mengembalikan ID router maksimum yang diizinkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
ID router maksimum yang diizinkan.

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

Dapatkan parameter NETWORK_ID_TIMEOUT yang digunakan dalam peran Router.

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

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Fungsi ini mendapatkan entri cache EID berikutnya (menggunakan iterator).

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aEntryInfo
Pointer ke tempat informasi entri cache EID ditempatkan.
[in,out] aIterator
Sebuah pointer ke iterator. Ini akan diperbarui untuk menunjuk ke entri berikutnya tentang keberhasilan. Untuk mendapatkan entri pertama, inisialisasi iterator dengan menetapkan semua bidang ke nol (misalnya, memset struktur iterator ke nol).
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil dihuni aEntryInfo untuk selanjutnya masuk tembolok EID.
OT_ERROR_NOT_FOUND
Tidak ada lagi entri dalam tabel cache alamat.

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

Dapatkan prioritas orang tua yang ditetapkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Nilai prioritas induk yang ditetapkan, -2 berarti tidak ditetapkan.
Lihat juga:
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

Dapatkan ID Partisi Pemimpin Utas yang digunakan saat beroperasi dalam peran Pemimpin.

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

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Dapatkan Thread PSKc.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[out] aPskc
Sebuah pointer ke otPskc untuk mengembalikan Thread diambil PSKc.
Lihat juga:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Dapatkan Referensi Kunci ke Thread PSKc yang disimpan.

Fungsi ini memerlukan fitur build-waktu OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE harus diaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Kembali
Referensi Kunci untuk PSKc
Lihat juga:
otThreadSetPskcRef

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Router.

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

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

Dapatkan Urutan ID Router saat ini.

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

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

Fungsi ini menyimpan informasi diagnostik untuk Thread Router yang diberikan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID router atau RLOC16 untuk router tertentu.
[out] aRouterInfo
Sebuah pointer ke tempat informasi router ditempatkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengambil info router untuk id yang diberikan.
OT_ERROR_NOT_FOUND
Tidak ada entri router dengan id yang diberikan.
OT_ERROR_INVALID_ARGS
aRouterInfo adalah NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Dapatkan parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran REED.

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

otThreadIsRouterMemenuhi Syarat

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

Metode ini menunjukkan apakah perangkat memenuhi syarat untuk router atau tidak.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
Mengembalikan Nilai
TRUE
Jika perangkat memenuhi syarat untuk router.
FALSE
Jika perangkat tidak memenuhi syarat untuk router.

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

Fungsi ini mendaftarkan fungsi panggilan balik tabel tetangga.

Callback yang disediakan (jika non-NULL) akan dipanggil ketika ada perubahan pada tabel tetangga (misalnya, entri tetangga anak atau router sedang ditambahkan/dihapus atau mode anak yang ada diubah).

Panggilan berikutnya ke metode ini akan menimpa panggilan balik sebelumnya. Perhatikan bahwa callback ini dipanggil sementara meja tetangga / anak sedang diperbarui dan selalu sebelum otStateChangedCallback .

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aCallback
Sebuah pointer ke fungsi callback handler.

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Lepaskan ID Router yang telah dialokasikan oleh perangkat dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
ID Router yang akan dirilis. Rentang yang valid adalah [0, 62].
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil merilis id router.
OT_ERROR_INVALID_ARGS
aRouterId tidak dalam rentang [0, 62].
OT_ERROR_INVALID_STATE
Perangkat saat ini tidak beroperasi sebagai pemimpin.
OT_ERROR_NOT_FOUND
Id router saat ini tidak dialokasikan.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Setel parameter CONTEXT_ID_REUSE_DELAY yang digunakan dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aDelay
Nilai CONTEXT_ID_REUSE_DELAY.
Lihat juga:
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Setel Port UDP Penggabung.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aJoinerUdpPort
Nomor Port UDP Joiner.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur Port UDP Joiner.
Lihat juga:
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Atur Bobot Pemimpin Benang yang digunakan saat beroperasi dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aWeight
Nilai Bobot Pemimpin Thread.
Lihat juga:
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

Tetapkan jumlah maksimum anak yang diizinkan saat ini.

Parameter ini hanya dapat diatur ketika operasi protokol Thread telah dihentikan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMaxChildren
Anak-anak maksimum yang diizinkan.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur maks.
OT_ERROR_INVALID_ARGS
Jika aMaxChildren tidak dalam rentang [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Jika Thread tidak dihentikan.
Lihat juga:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

Fungsi ini menetapkan/mengembalikan jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aMaxIpAddresses
Jumlah maksimum alamat IP yang dapat didaftarkan oleh setiap anak MTD dengan perangkat ini sebagai induk. 0 untuk menghapus pengaturan dan mengembalikan default.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur/menghapus nomor.
OT_ERROR_INVALID_ARGS
Jika melebihi jumlah maksimum yang diperbolehkan.
Lihat juga:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Setel parameter NETWORK_ID_TIMEOUT yang digunakan dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aTimeout
Nilai NETWORK_ID_TIMEOUT.
Lihat juga:
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

Tetapkan prioritas orang tua.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aParentPriority
Nilai prioritas induk.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil menetapkan prioritas induk.
OT_ERROR_INVALID_ARGS
Jika nilai prioritas induk tidak berada di antara 1, 0, -1 dan -2.
Lihat juga:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

Tetapkan ID Partisi Pemimpin Utas yang digunakan saat beroperasi dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPartitionId
Nilai ID Partisi Pemimpin Utas.

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Tetapkan Id Router yang disukai.

Setelah menjadi router/leader, node mencoba menggunakan Id Router ini. Jika Id Router yang disukai tidak disetel atau jika tidak dapat digunakan, id router yang dibuat secara acak akan dipilih. Properti ini hanya dapat disetel saat peran perangkat terlepas atau dinonaktifkan.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterId
Id Router yang disukai.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur Id Router pilihan.
OT_ERROR_INVALID_STATE
Tidak dapat disetel (peran tidak terlepas atau dinonaktifkan)

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Atur Thread PSKc.

Fungsi ini hanya akan berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini juga akan membatalkan Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPskc
Sebuah pointer ke Thread PSKc baru.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur Thread PSKc.
OT_ERROR_INVALID_STATE
Protokol utas diaktifkan.
Lihat juga:
otThreadGetPskc

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Atur Thread PSKc.

Fungsi ini memerlukan fitur build-waktu OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE harus diaktifkan.

Fungsi ini hanya akan berhasil jika protokol Thread dinonaktifkan. Panggilan yang berhasil ke fungsi ini juga akan membatalkan Set Data Operasional Aktif dan Tertunda dalam memori non-volatil.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aPskcRef
Referensi Kunci ke Thread PSKc baru.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur Thread PSKc.
OT_ERROR_INVALID_STATE
Protokol utas diaktifkan.
Lihat juga:
otThreadGetPskcRef

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Setel parameter ROUTER_DOWNGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aThreshold
Nilai ROUTER_DOWNGRADE_THRESHOLD.
Lihat juga:
otThreadGetRouterDowngradeThreshold

otThreadSetRouterMemenuhi Syarat

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

Fungsi ini menetapkan apakah perangkat memenuhi syarat untuk router atau tidak.

Jika aEligible adalah palsu dan perangkat saat ini beroperasi sebagai router, panggilan ini akan menyebabkan perangkat detach dan berusaha untuk melekatkan kembali sebagai seorang anak.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aEligible
TRUE untuk mengonfigurasi perangkat sebagai router yang memenuhi syarat, FALSE jika tidak.
Mengembalikan Nilai
OT_ERROR_NONE
Berhasil mengatur konfigurasi yang memenuhi syarat router.
OT_ERROR_NOT_CAPABLE
Perangkat tidak mampu menjadi router.

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Setel parameter ROUTER_SELECTION_JITTER yang digunakan dalam peran REED/Router.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aRouterJitter
Nilai ROUTER_SELECTION_JITTER.
Lihat juga:
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Setel parameter ROUTER_UPGRADE_THRESHOLD yang digunakan dalam peran Pemimpin.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aThreshold
Nilai ROUTER_UPGRADE_THRESHOLD.
Lihat juga:
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Mengatur data Kemudi keluar dari band.

Konfigurasi pilihan OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE harus diatur untuk mengaktifkan pengaturan data kemudi keluar dari band.

rincian
Parameter
[in] aInstance
Pointer ke instance OpenThread.
[in] aExtAddress
Alamat yang digunakan untuk memperbarui data kemudi. Semua nol untuk menghapus data kemudi (tidak ada data kemudi). Semua 0xFF untuk mengatur data kemudi/filter mekar untuk menerima/mengizinkan semua. EUI64 spesifik yang kemudian ditambahkan ke data kemudi/filter mekar.

makro

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

Inisialisasi untuk otChildIP6AddressIterator.