Google 致力于为黑人社区推动种族平等。查看具体行动

细木工人

此模块包含线程连接器角色的函数。

摘要

枚举

otJoinerState 枚举
此枚举定义了连接器状态。

类型定义符

otJoinerCallback)(otError aError, void *aContext) typedef
void(*
系统会调用此函数指针,以通知联接操作完成。
otJoinerDiscerner typedef
此结构表示接合器识别器。
otJoinerState typedef
此枚举定义了连接器状态。

函数

otJoinerGetDiscerner(otInstance *aInstance)
此函数用于获取“连接器识别器”。
otJoinerGetId(otInstance *aInstance)
const otExtAddress *
此函数获取连接符 ID。
otJoinerGetState(otInstance *aInstance)
此函数返回连接器状态。
otJoinerSetDiscerner(otInstance *aInstance, otJoinerDiscerner *aDiscerner)
此函数用于设置连接函数。
otJoinerStart(otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
此函数启用 Thread Joiner 角色。
otJoinerStateToString(otJoinerState aState)
const char *
此函数将给定的连接器状态枚举值转换为人类可读的字符串。
otJoinerStop(otInstance *aInstance)
void
此函数将停用线程连接器角色。

结构体

otJoinerDiscerner

此结构表示接合器识别器。

枚举

otJoinerState

 otJoinerState

此枚举定义了连接器状态。

类型定义符

otJoinerCallback

void(* otJoinerCallback)(otError aError, void *aContext)

系统会调用此函数指针,以通知联接操作完成。

详情
参数
[in] aError
OT_ERROR_NONE(如果连接过程成功)。OT_ERROR_SECURITY(如果联接过程因安全凭据而失败)。OT_ERROR_NOT_FOUND(如果未找到可加入的网络)。OT_ERROR_RESPONSE_TIMEOUT(如果响应超时)。
[in] aContext
指向应用特定上下文的指针。

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

此结构表示接合器识别器。

otJoinerState

enum otJoinerState otJoinerState

此枚举定义了连接器状态。

函数

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

此函数用于获取“连接器识别器”。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
指向连接器感知器的指针,如果未设置,则返回 NULL。

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

此函数获取连接符 ID。

如果未设置接合器识别器,则接合器 ID 会基于出厂分配的 IEEE EUI-64 计算 SHA-256 结果的前 64 位。否则,“连接符 ID”是根据“连接器 ID”的值计算的。

调试程序 ID 也会在调试过程中用作设备的 IEEE 802.15.4 扩展地址。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
指向连接者 ID 的指针。

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

此函数返回连接器状态。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

此函数用于设置连接函数。

连接器识别器用于计算在调试/连接过程中使用的连接器 ID。

默认情况下(如果未提供识别器或将其设为 NULL),通过出厂分配的 IEEE EUI-64 计算 SHA-256 结果的前 64 位将得出链接器 ID。请注意,这是线程规范期望的主要行为。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aDiscerner
指向连接处理器的指针。如果为 NULL,会清除之前设置的任何判别器。
返回值
OT_ERROR_NONE
已成功更新会员身份识别器。
OT_ERROR_INVALID_ARGS
aDiscerner 无效(指定的长度不在有效范围内)。
OT_ERROR_INVALID_STATE
加入会议的过程正在进行中,因此无法更改会员。

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

此函数启用 Thread Joiner 角色。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aPskd
指向 PSKd 的指针。
[in] aProvisioningUrl
指向配置网址的指针(可能是 NULL)。
[in] aVendorName
指向供应商名称的指针(可以为 NULL)。
[in] aVendorModel
指向供应商型号的指针(可能为 NULL)。
[in] aVendorSwVersion
指向供应商 SW 版本的指针(可能是 NULL)。
[in] aVendorData
指向供应商数据的指针(可以为 NULL)。
[in] aCallback
指向在联接操作完成时调用的函数的指针。
[in] aContext
指向应用特定上下文的指针。
返回值
OT_ERROR_NONE
已成功启动 Joiner 角色。
OT_ERROR_BUSY
之前的尝试仍在进行中。
OT_ERROR_INVALID_ARGS
aPskdaProvisioningUrl 无效。
OT_ERROR_INVALID_STATE
IPv6 堆栈未启用或线程栈已完全启用。

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

此函数将给定的连接器状态枚举值转换为人类可读的字符串。

详情
参数
[in] aState
连接符状态。
返回值
aState 的人类可读字符串表示形式。

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

此函数将停用线程连接器角色。

详情
参数
[in] aInstance
指向 OpenThread 实例的指针。

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

连接器标识符的长度上限(以位为单位)。

资源

OpenThread API 参考主题源自源代码,可在 GitHub 上找到。 如需了解详情或为我们的文档做贡献,请参阅资源