路由器/領導者

該模塊包括線程路由器和領導者的功能。

概要

枚舉
`otCacheEntryState`	枚舉此枚舉定義EID緩存條目狀態。
`otNeighborTableEvent { OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED , OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED , OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED , OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED }`	枚舉此枚舉定義了`otNeighborTableCallback`使用的常量，以指示是否要添加或刪除子鄰居或路由器鄰居。

類型定義
`otCacheEntryInfo`	類型定義 `struct otCacheEntryInfo` 此結構表示EID緩存條目。
`otCacheEntryIterator`	類型定義 `struct otCacheEntryIterator` 此類型表示用於迭代EID緩存表條目的迭代器。
`otCacheEntryState`	類型定義 `enum otCacheEntryState` 此枚舉定義EID緩存條目狀態。
`otChildIp6AddressIterator`	類型定義 `uint16_t` 用於遍歷線程子項的IPv6地址。
`otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)`	類型定義 `void(*` 調用此函數指針以通知子鄰居或路由器鄰居正在添加到鄰居表中或從鄰居表中刪除。

職能
`otThreadBecomeLeader ( otInstance *aInstance)`	`otError` 成為領導者並啟動新分區。
`otThreadBecomeRouter ( otInstance *aInstance)`	`otError` 嘗試成為路由器。
`otThreadGetChildInfoById ( otInstance aInstance, uint16_t aChildId, otChildInfo aChildInfo)`	`otError` 該功能通過子代ID或RLOC16保留有關子代的診斷信息。
`otThreadGetChildInfoByIndex ( otInstance aInstance, uint16_t aChildIndex, otChildInfo aChildInfo)`	`otError` 該函數通過內部表索引保留附加的Child的診斷信息。
`otThreadGetChildNextIp6Address ( otInstance aInstance, uint16_t aChildIndex, otChildIp6AddressIterator aIterator, otIp6Address *aAddress)`	`otError` 此函數獲取給定子項的下一個IPv6地址（使用迭代器）。
`otThreadGetContextIdReuseDelay ( otInstance *aInstance)`	`uint32_t` 獲取領導者角色中使用的CONTEXT_ID_REUSE_DELAY參數。
`otThreadGetJoinerUdpPort ( otInstance *aInstance)`	`uint16_t` 獲取Joiner UDP端口。
`otThreadGetLocalLeaderWeight ( otInstance *aInstance)`	`uint8_t` 獲取以“領導者”角色操作時使用的“線程領導權重”。
`otThreadGetMaxAllowedChildren ( otInstance *aInstance)`	`uint16_t` 獲取當前允許的最大兒童數量。
`otThreadGetMaxChildIpAddresses ( otInstance *aInstance)`	`uint8_t` 此功能獲取每個MTD子級可以將此設備註冊為父級的IP地址的最大數量。
`otThreadGetMaxRouterId ( otInstance *aInstance)`	`uint8_t` 該函數返回允許的最大路由器ID。
`otThreadGetNetworkIdTimeout ( otInstance *aInstance)`	`uint8_t` 獲取路由器角色中使用的NETWORK_ID_TIMEOUT參數。
`otThreadGetNextCacheEntry ( otInstance aInstance, otCacheEntryInfo aEntryInfo, otCacheEntryIterator *aIterator)`	`otError` 此函數獲取下一個EID緩存條目（使用迭代器）。
`otThreadGetParentPriority ( otInstance *aInstance)`	`int8_t` 獲取分配的父級優先級。
`otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)`	`uint32_t` 獲取以“領導者”角色進行操作時使用的首選“線程領導者分區ID”。
`otThreadGetPskc ( otInstance *aInstance)`	`const otPskc *` 獲取線程PSKc。
`otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)`	`uint8_t` 獲取路由器角色中使用的ROUTER_DOWNGRADE_THRESHOLD參數。
`otThreadGetRouterIdSequence ( otInstance *aInstance)`	`uint8_t` 獲取當前的路由器ID序列。
`otThreadGetRouterInfo ( otInstance aInstance, uint16_t aRouterId, otRouterInfo aRouterInfo)`	`otError` 該功能保留給定線程路由器的診斷信息。
`otThreadGetRouterSelectionJitter ( otInstance *aInstance)`	`uint8_t` 獲取在REED /路由器角色中使用的ROUTER_SELECTION_JITTER參數。
`otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)`	`uint8_t` 獲取在REED角色中使用的ROUTER_UPGRADE_THRESHOLD參數。
`otThreadIsRouterEligible ( otInstance *aInstance)`	`bool` 此方法指示設備是否符合路由器資格。
`otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)`	`void` 該函數註冊鄰居表回調函數。
`otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)`	`otError` 釋放由設備以領導者角色分配的路由器ID。
`otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)`	`void` 設置在“領導者”角色中使用的CONTEXT_ID_REUSE_DELAY參數。
`otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)`	`otError` 設置Joiner UDP端口。
`otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)`	`void` 設置在“領導者”角色中操作時使用的“線程領導權重”。
`otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)`	`otError` 設置當前允許的最大孩子數。
`otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)`	`otError` 此功能設置/恢復每個MTD子級可以向該設備註冊為父級的IP地址的最大數量。
`otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)`	`void` 設置在“領導者”角色中使用的NETWORK_ID_TIMEOUT參數。
`otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)`	`otError` 設置父級優先級。
`otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)`	`void` 設置以“領導者”角色進行操作時首選的線程領導者分區ID。
`otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)`	`otError` 設置首選路由器ID。
`otThreadSetPskc ( otInstance aInstance, const otPskc aPskc)`	`otError` 設置線程PSKc。
`otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)`	`void` 設置在“領導者”角色中使用的ROUTER_DOWNGRADE_THRESHOLD參數。
`otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)`	`otError` 此功能設置設備是否符合路由器要求。
`otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)`	`void` 設置REED /路由器角色中使用的ROUTER_SELECTION_JITTER參數。
`otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)`	`void` 設置在“領導者”角色中使用的ROUTER_UPGRADE_THRESHOLD參數。
`otThreadSetSteeringData ( otInstance aInstance, const otExtAddress aExtAddress)`	`void` 將轉向數據設置為帶外。

結構
otCacheEntryInfo	此結構表示EID緩存條目。
otCacheEntryIterator	此類型表示用於迭代EID緩存表條目的迭代器。
otChildInfo	此結構保存線程子代的診斷信息。
otNeighborTableEntryInfo	此類型表示鄰居表條目信息（子級或路由器），並用作鄰居表回調`otNeighborTableCallback`的參數。

枚舉

otCacheEntryState

 otCacheEntryState

此枚舉定義EID緩存條目狀態。

otNeighborTableEvent

 otNeighborTableEvent

此枚舉定義了otNeighborTableCallback使用的常量，以指示是否要添加或刪除子鄰居或路由器鄰居。

物產
`OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED`	正在添加一個孩子。
`OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED`	一個孩子正在被移走。
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED`	正在添加路由器。
`OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED`	路由器被拆除。

類型定義

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

此結構表示EID緩存條目。

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

此類型表示用於迭代EID緩存表條目的迭代器。

要初始化迭代器並從緩存表中的第一個條目開始，請將結構中其所有字段設置為零（例如，將迭代器memset設置為零）。

otCacheEntryState

enum otCacheEntryState otCacheEntryState

此枚舉定義EID緩存條目狀態。

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

用於遍歷線程子項的IPv6地址。

otNeighborTableCallback

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

調用此函數指針以通知子鄰居或路由器鄰居正在添加到鄰居表中或從鄰居表中刪除。

細節

參量

`[in] aEvent`	事件標誌。
`[in] aEntryInfo`	指向表條目信息的指針。

職能

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

成為領導者並啟動新分區。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

返回值

`OT_ERROR_NONE`	成功成為領導者並開始了新的分區。
`OT_ERROR_INVALID_STATE`	線程被禁用。

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

嘗試成為路由器。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

返回值

`OT_ERROR_NONE`	成功開始嘗試成為路由器。
`OT_ERROR_INVALID_STATE`	線程被禁用。

otThreadGetChildInfoById

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

該功能通過子代ID或RLOC16保留有關子代的診斷信息。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aChildId`	附加孩子的孩子ID或RLOC16。
`[out] aChildInfo`	指向子信息放置位置的指針。

返回值

`OT_ERROR_NONE`	已成功使用給定ID的信息更新`aChildInfo` 。
`OT_ERROR_NOT_FOUND`	沒有具有此子代號的有效子代。
`OT_ERROR_INVALID_ARGS`	如果`aChildInfo`為NULL。

otThreadGetChildInfoByIndex

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

該函數通過內部表索引保留附加的Child的診斷信息。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aChildIndex`	表索引。
`[out] aChildInfo`	指向子信息放置位置的指針。

返回值

`OT_ERROR_NONE`	`aChildInfo`已成功使用給定索引的信息更新。
`OT_ERROR_NOT_FOUND`	此索引沒有有效的孩子。
`OT_ERROR_INVALID_ARGS`	`aChildInfo`為NULL，或`aChildIndex`超出範圍（高於最大表索引）。

也可以看看：
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

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

此函數獲取給定子項的下一個IPv6地址（使用迭代器）。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aChildIndex`	子索引。
`[in,out] aIterator`	指向迭代器的指針。成功後，迭代器將更新為指向列表中的下一個條目。要獲得第一個IPv6地址，應將迭代器設置為OT_CHILD_IP6_ADDRESS_ITERATOR_INIT。
`[out] aAddress`	指向放置孩子的下一個地址的IPv6地址的指針（成功時）。

返回值

`OT_ERROR_NONE`	成功找到下一個IPv6地址（ `aAddress`已成功更新）。
`OT_ERROR_NOT_FOUND`	該子級沒有後續的IPv6地址條目。
`OT_ERROR_INVALID_ARGS`	`aIterator`或`aAddress`為NULL，或`aChildIndex`處的`aChildIndex`無效。

也可以看看：
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

獲取領導者角色中使用的CONTEXT_ID_REUSE_DELAY參數。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

CONTEXT_ID_REUSE_DELAY值。

也可以看看：
otThreadSetContextIdReuseDelay

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

獲取Joiner UDP端口。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

Joiner UDP端口號。

也可以看看：
otThreadSetJoinerUdpPort

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

獲取在執行“領導者”角色時使用的“線程領導者權重”。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

線引導權重值。

也可以看看：
otThreadSetLeaderWeight

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

獲取當前允許的最大兒童數量。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

當前允許的最大兒童人數。

也可以看看：
otThreadSetMaxAllowedChildren

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

此功能獲取每個MTD子級可以將此設備註冊為父級的IP地址的最大數量。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

每個MTD子級可以在此設備上註冊為父級的IP地址的最大數量。

也可以看看：
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

該函數返回允許的最大路由器ID。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

允許的最大路由器ID。

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

獲取路由器角色中使用的NETWORK_ID_TIMEOUT參數。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

NETWORK_ID_TIMEOUT值。

也可以看看：
otThreadSetNetworkIdTimeout

otThreadGetNextCacheEntry

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

此函數獲取下一個EID緩存條目（使用迭代器）。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[out] aEntryInfo`	指向EID緩存條目信息放置位置的指針。
`[in,out] aIterator`	指向迭代器的指針。它將更新為指向成功的下一個條目。為了得到第一個條目，所有的字段設置為零初始化迭代器（例如， `memset`的迭代器結構為零）。

返回值

`OT_ERROR_NONE`	成功為下一個EID緩存條目填充`aEntryInfo` 。
`OT_ERROR_NOT_FOUND`	地址緩存表中沒有更多條目。

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

獲取分配的父級優先級。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

已分配的父級優先級值，-2表示未分配。

也可以看看：
otThreadSetParentPriority

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

獲取以“領導者”角色進行操作時使用的首選“線程領導者分區ID”。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

線程領導者分區ID值。

otThreadGetPskc

const otPskc * otThreadGetPskc(
  otInstance *aInstance
)

獲取線程PSKc。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

指向線程PSKc的指針

也可以看看：
otThreadSetPskc

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

獲取路由器角色中使用的ROUTER_DOWNGRADE_THRESHOLD參數。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

ROUTER_DOWNGRADE_THRESHOLD值。

也可以看看：
otThreadSetRouterDowngradeThreshold

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

獲取當前的路由器ID序列。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

路由器ID序列。

otThreadGetRouterInfo

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

該功能保留給定線程路由器的診斷信息。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aRouterId`	給定路由器的路由器ID或RLOC16。
`[out] aRouterInfo`	指向路由器信息放置位置的指針。

返回值

`OT_ERROR_NONE`	成功獲取給定ID的路由器信息。
`OT_ERROR_NOT_FOUND`	沒有具有給定ID的路由器條目。
`OT_ERROR_INVALID_ARGS`	`aRouterInfo`為NULL。

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

獲取在REED /路由器角色中使用的ROUTER_SELECTION_JITTER參數。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

ROUTER_SELECTION_JITTER值。

也可以看看：
otThreadSetRouterSelectionJitter

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

獲取在REED角色中使用的ROUTER_UPGRADE_THRESHOLD參數。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

退貨

ROUTER_UPGRADE_THRESHOLD值。

也可以看看：
otThreadSetRouterUpgradeThreshold

otThreadIsRouterEligible

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

此方法指示設備是否符合路由器資格。

細節

參量

[in] aInstance

指向OpenThread實例的指針。

返回值

`TRUE`	如果設備符合路由器資格。
`FALSE`	如果設備不符合路由器資格。

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

該函數註冊鄰居表回調函數。

當將子項或路由器鄰居條目添加到鄰居表中/從鄰居表中刪除時，將調用提供的回調（如果非NULL）。隨後對該方法的調用將覆蓋先前的回調。請注意，在更新鄰居/子表時且始終在otStateChangedCallback之前調用此回調。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aCallback`	指向回調處理函數的指針。

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

釋放由設備以領導者角色分配的路由器ID。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aRouterId`	要釋放的路由器ID。有效範圍是[0，62]。

返回值

`OT_ERROR_NONE`	成功發布路由器ID。
`OT_ERROR_INVALID_ARGS`	`aRouterId`不在[ `aRouterId` ]範圍內。
`OT_ERROR_INVALID_STATE`	該設備當前未充當領導者。
`OT_ERROR_NOT_FOUND`	當前未分配路由器ID。

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

設置在“領導者”角色中使用的CONTEXT_ID_REUSE_DELAY參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aDelay`	CONTEXT_ID_REUSE_DELAY值。

也可以看看：
otThreadGetContextIdReuseDelay

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

設置Joiner UDP端口。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aJoinerUdpPort`	Joiner UDP端口號。

返回值

OT_ERROR_NONE

成功設置Joiner UDP端口。

也可以看看：
otThreadGetJoinerUdpPort

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

設置以“領導者”角色操作時使用的“線程領導權重”。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aWeight`	線引導權重值。

也可以看看：
otThreadGetLeaderWeight

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

設置當前允許的最大孩子數。

僅當線程協議操作已停止時才能設置此參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aMaxChildren`	允許的最大孩子數。

返回值

`OT_ERROR_NONE`	成功設置最大值
`OT_ERROR_INVALID_ARGS`	如果`aMaxChildren`不在[1，OPENTHREAD_CONFIG_MLE_MAX_CHILDREN]範圍內。
`OT_ERROR_INVALID_STATE`	如果Thread沒有停止。

也可以看看：
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

此功能設置/恢復每個MTD子級可以向該設備註冊為父級的IP地址的最大數量。

注意：此API需要OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE ，並且僅由線程測試線束用於限制參考父對象的地址註冊，以便測試MTD DUT反應。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aMaxIpAddresses`	每個MTD子級可以在此設備上註冊為父級的IP地址的最大數量。 0清除設置並恢復默認值。

返回值

`OT_ERROR_NONE`	成功設置/清除該號碼。
`OT_ERROR_INVALID_ARGS`	如果超過允許的最大數量。

也可以看看：
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

設置在“領導者”角色中使用的NETWORK_ID_TIMEOUT參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aTimeout`	NETWORK_ID_TIMEOUT值。

也可以看看：
otThreadGetNetworkIdTimeout

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

設置父級優先級。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aParentPriority`	父級優先級值。

返回值

`OT_ERROR_NONE`	成功設置父級優先級。
`OT_ERROR_INVALID_ARGS`	如果父級優先級值不在1、0，-1和-2之間。

也可以看看：
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

設置以“領導者”角色進行操作時首選的“線程領導者分區ID”。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aPartitionId`	線程領導者分區ID值。

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

設置首選路由器ID。

成為路由器/領導者後，節點嘗試使用此路由器ID。如果未設置首選路由器ID或無法使用它，則將選擇隨機生成的路由器ID。僅當分離或禁用設備角色時才能設置此屬性。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aRouterId`	首選路由器ID。

返回值

`OT_ERROR_NONE`	成功設置首選路由器ID。
`OT_ERROR_INVALID_STATE`	無法設置（角色未分離或禁用）

otThreadSetPskc

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

設置線程PSKc。

僅當禁用線程協議時，此功能才會成功。成功調用此函數還將使非易失性存儲器中的活動和待處理操作數據集無效。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aPskc`	指向新線程PSKc的指針。

返回值

`OT_ERROR_NONE`	成功設置線程PSKc。
`OT_ERROR_INVALID_STATE`	啟用了線程協議。

也可以看看：
otThreadGetPskc

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

設置在“領導者”角色中使用的ROUTER_DOWNGRADE_THRESHOLD參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aThreshold`	ROUTER_DOWNGRADE_THRESHOLD值。

也可以看看：
otThreadGetRouterDowngradeThreshold

otThreadSetRouterEligible

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

此功能設置設備是否符合路由器要求。

如果aEligible為false並且設備當前正在作為路由器運行，則此調用將導致設備分離並嘗試以子設備的形式重新連接。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aEligible`	如果為TRUE，則將設備配置為符合路由器要求，否則為FALSE。

返回值

`OT_ERROR_NONE`	成功設置符合路由器要求的配置。
`OT_ERROR_NOT_CAPABLE`	該設備無法成為路由器。

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

設置REED /路由器角色中使用的ROUTER_SELECTION_JITTER參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aRouterJitter`	ROUTER_SELECTION_JITTER值。

也可以看看：
otThreadGetRouterSelectionJitter

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

設置在“領導者”角色中使用的ROUTER_UPGRADE_THRESHOLD參數。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aThreshold`	ROUTER_UPGRADE_THRESHOLD值。

也可以看看：
otThreadGetRouterUpgradeThreshold

otThreadSetSteeringData

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

將轉向數據設置為帶外。

應該設置配置選項OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE以啟用帶外引導數據的設置。

細節

參量

`[in] aInstance`	指向OpenThread實例的指針。
`[in] aExtAddress`	用於更新轉向數據的地址。全零以清除轉向數據（無轉向數據）。所有0xFF將轉向數據/ bloom過濾器設置為接受/允許所有。然後將特定的EUI64添加到當前的轉向數據/ bloom過濾器中。

巨集

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

otChildIP6AddressIterator的初始化程序。