Google 致力于为黑人社区推动种族平等。查看具体行动
此页面由 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,
OT_CHANGED_ACTIVE_DATASET = 1 << 28,
OT_CHANGED_PENDING_DATASET = 1 << 29
}
枚举
此枚举定义了作为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_ACTIVE_DATASET

活动操作数据集已更改。

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_PENDING_DATASET

待处理操作数据集已更改。

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
由于资源限制,无法添加回调。