Google is committed to advancing racial equity for Black communities. See how.
本頁面由 Cloud Translation API 翻譯而成。
Switch to English

實例

該模塊包括控制OpenThread實例的功能。

摘要

枚舉

anonymous enum {
OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0,
OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1,
OT_CHANGED_THREAD_ROLE = 1 << 2,
OT_CHANGED_THREAD_LL_ADDR = 1 << 3,
OT_CHANGED_THREAD_ML_ADDR = 1 << 4,
OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5,
OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6,
OT_CHANGED_THREAD_PARTITION_ID = 1 << 7,
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8,
OT_CHANGED_THREAD_NETDATA = 1 << 9,
OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10,
OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11,
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12,
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13,
OT_CHANGED_THREAD_CHANNEL = 1 << 14,
OT_CHANGED_THREAD_PANID = 1 << 15,
OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16,
OT_CHANGED_THREAD_EXT_PANID = 1 << 17,
OT_CHANGED_MASTER_KEY = 1 << 18,
OT_CHANGED_PSKC = 1 << 19,
OT_CHANGED_SECURITY_POLICY = 1 << 20,
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21,
OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22,
OT_CHANGED_COMMISSIONER_STATE = 1 << 23,
OT_CHANGED_THREAD_NETIF_STATE = 1 << 24,
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25,
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26,
OT_CHANGED_JOINER_STATE = 1 << 27
}
枚舉
此枚舉定義了作為otStateChangedCallback一部分傳遞的otStateChangedCallback

類型定義

otChangedFlags 類型定義
uint32_t
此類型表示指示已更改的特定狀態/配置的位字段。
otInstance 類型定義
struct otInstance
此結構表示OpenThread實例結構。
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) 類型定義
void(*
調用此函數指針以通知OpenThread中的某些配置或狀態更改。

功能

otGetRadioVersionString ( otInstance *aInstance)
const char *
此函數獲取OpenThread無線電版本字符串。
otGetVersionString (void)
const char *
此函數獲取OpenThread版本字符串。
otInstanceErasePersistentInfo ( otInstance *aInstance)
此功能將擦除存儲在非易失性存儲器中的所有OpenThread持久性信息(網絡設置)。
otInstanceFactoryReset ( otInstance *aInstance)
void
此方法刪除存儲在非易失性存儲器中的所有設置,然後觸發平台重置。
otInstanceFinalize ( otInstance *aInstance)
void
此功能禁用OpenThread庫。
otInstanceInit (void *aInstanceBuffer, size_t *aInstanceBufferSize)
此函數初始化OpenThread庫。
otInstanceInitSingle (void)
此函數初始化OpenThread庫的靜態單個實例。
otInstanceIsInitialized ( otInstance *aInstance)
bool
此函數指示實例是否有效/初始化。
otInstanceReset ( otInstance *aInstance)
void
此方法觸發平台重置。
otRemoveStateChangeCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
void
此函數刪除一個回調,以指示OpenThread中某些配置或狀態何時更改。
otSetStateChangedCallback ( otInstance *aInstance, otStateChangedCallback aCallback, void *aContext)
此函數註冊一個回調,以指示OpenThread中某些配置或狀態何時發生變化。

枚舉

匿名枚舉

 anonymous enum

此枚舉定義了作為otStateChangedCallback一部分傳遞的otStateChangedCallback

物產
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL

通道管理器新的暫掛線程通道已更改。

OT_CHANGED_COMMISSIONER_STATE

專員狀態改變了。

OT_CHANGED_IP6_ADDRESS_ADDED

IPv6地址已添加。

OT_CHANGED_IP6_ADDRESS_REMOVED

IPv6地址已刪除。

OT_CHANGED_IP6_MULTICAST_SUBSCRIBED

訂閱了IPv6組播地址。

OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED

取消訂閱IPv6組播地址。

OT_CHANGED_JOINER_STATE

細木工狀態已更改。

OT_CHANGED_MASTER_KEY

主密鑰已更改。

OT_CHANGED_PSKC

PSKc已更改。

OT_CHANGED_SECURITY_POLICY

安全策略已更改。

OT_CHANGED_SUPPORTED_CHANNEL_MASK

支持的通道掩碼已更改。

OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL

本地骨幹路由器配置已更改。

OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE

骨幹路由器狀態已更改。

OT_CHANGED_THREAD_CHANNEL

線程網絡通道已更改。

OT_CHANGED_THREAD_CHILD_ADDED

添加了孩子。

OT_CHANGED_THREAD_CHILD_REMOVED

孩子被刪除了。

OT_CHANGED_THREAD_EXT_PANID

線程網絡擴展的PAN ID已更改。

OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER

線程鍵順序已更改。

OT_CHANGED_THREAD_LL_ADDR

鏈接本地地址已更改。

OT_CHANGED_THREAD_ML_ADDR

網格本地地址已更改。

OT_CHANGED_THREAD_NETDATA

線程網絡數據已更改。

OT_CHANGED_THREAD_NETIF_STATE

線程網絡接口狀態已更改。

OT_CHANGED_THREAD_NETWORK_NAME

線程網絡名稱已更改。

OT_CHANGED_THREAD_PANID

線程網絡PAN ID已更改。

OT_CHANGED_THREAD_PARTITION_ID

分區ID已更改。

OT_CHANGED_THREAD_RLOC_ADDED

RLOC已添加。

OT_CHANGED_THREAD_RLOC_REMOVED

RLOC已刪除。

OT_CHANGED_THREAD_ROLE

角色(已禁用,已分離,子級,路由器,組長)已更改。

類型定義

otChangedFlags

uint32_t otChangedFlags

此類型表示指示已更改的特定狀態/配置的位字段。

請參閱OT_CHANGED_*定義。

otInstance

struct otInstance otInstance

此結構表示OpenThread實例結構。

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

調用此函數指針以通知OpenThread中的某些配置或狀態更改。

細節
參量
[in] aFlags
指示已更改的特定狀態的位字段。請參閱OT_CHANGED_*定義。
[in] aContext
指向特定於應用程序的上下文的指針。

功能

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

此函數獲取OpenThread無線電版本字符串。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
退貨
指向OpenThread無線電版本的指針。

otGetVersionString

const char * otGetVersionString(
  void
)

此函數獲取OpenThread版本字符串。

細節
退貨
指向OpenThread版本的指針。

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

此功能將擦除存儲在非易失性存儲器中的所有OpenThread持久性信息(網絡設置)。

僅當設備處於disabled狀態/角色時,擦除成功。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
返回值
OT_ERROR_NONE
所有永久性信息/狀態均已成功刪除。
OT_ERROR_INVALID_STATE
設備未處於disabled狀態/角色。

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

此方法刪除存儲在非易失性存儲器中的所有設置,然後觸發平台重置。

細節
參量
[in] aInstance
指向OpenThread實例的指針。

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

此功能禁用OpenThread庫。

當不再使用OpenThread時,請調用此函數。

細節
參量
[in] aInstance
指向OpenThread實例的指針。

otInstanceInit

 otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

此函數初始化OpenThread庫。

此函數將初始化OpenThread並為後續的OpenThread API調用做好準備。必須在對OpenThread的任何其他調用之前調用此函數。

該功能可用,並且僅在啟用對多個OpenThread實例的支持時才可以使用。

細節
參量
[in] aInstanceBuffer
OpenThread的緩衝區,用於分配otInstance結構。
[in,out] aInstanceBufferSize
輸入時,aInstanceBuffer的大小。在輸出時,如果沒有足夠的空間用於otInstance,則為otInstance所需的字節數。
退貨
指向新的OpenThread實例的指針。
也可以看看:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

此函數初始化OpenThread庫的靜態單個實例。

此函數將初始化OpenThread並為後續的OpenThread API調用做好準備。必須在對OpenThread的任何其他調用之前調用此函數。

該功能可用,並且僅在禁用對多個OpenThread實例的支持時才可以使用。

細節
退貨
指向單個OpenThread實例的指針。

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

此函數指示實例是否有效/初始化。

如果使用otInstanceInitSingle() (在單實例情況下)或otInstanceInit() (在多實例情況下)獲取並初始化了實例,則該實例被視為有效。後續對otInstanceFinalize()調用導致該實例被視為未初始化。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
退貨
如果給定實例有效/已初始化,則為TRUE,否則為FALSE。

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

此方法觸發平台重置。

重置過程可確保擦除所有OpenThread狀態/信息(存儲在易失性內存中)。注意, otPlatformReset不會擦除保存在非易失性存儲器中的任何持久狀態/信息。

細節
參量
[in] aInstance
指向OpenThread實例的指針。

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

此函數刪除一個回調,以指示OpenThread中某些配置或狀態何時更改。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aCallback
指向具有某些配置或狀態更改的函數的指針。
[in] aContext
指向特定於應用程序的上下文的指針。

otSetStateChangedCallback

 otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

此函數註冊一個回調,以指示OpenThread中某些配置或狀態何時發生變化。

細節
參量
[in] aInstance
指向OpenThread實例的指針。
[in] aCallback
指向具有某些配置或狀態更改的函數的指針。
[in] aContext
指向特定於應用程序的上下文的指針。
返回值
OT_ERROR_NONE
將回調添加到回調列表中。
OT_ERROR_ALREADY
回調已被註冊。
OT_ERROR_NO_BUFS
由於資源限制,無法添加回調。