谷歌致力于推进种族平等的黑人社区。 怎么看。
此页面由 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

类型定义

otChangedFlags 的typedef
uint32_t
这种类型代表一个位字段,指示特定状态/配置已经改变。
otInstance 的typedef
struct otInstance
这种结构代表了实例的OpenThread结构。
otStateChangedCallback )(otChangedFlags aFlags, void *aContext) 的typedef
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

属性
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。
返回
如果给定的实例有效/初始化,否则为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
无法回调增加,由于资源的限制。