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

网络时间同步

此模块包含控制网络时间同步服务的函数。

摘要

枚举

otNetworkTimeStatus{
  OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
  OT_NETWORK_TIME_RESYNC_NEEDED = 0,
  OT_NETWORK_TIME_SYNCHRONIZED = 1
}
枚举
此枚举表示 OpenThread 时间同步状态。

类型定义符

otNetworkTimeStatus typedef
此枚举表示 OpenThread 时间同步状态。
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) typedef
void(*
当发生网络时间同步或状态更改时,系统会调用此函数指针。

函数

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
获取线程网络时间。
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
获取时间同步期限。
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
获取路由器的时间同步 XTAL 准确率阈值。
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
设置时间同步期限。
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
为支持路由器的设备设置时间同步 XTAL 准确率阈值。
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
设置在网络时间同步或状态更改时调用的回调。

枚举

otNetworkTimeStatus

 otNetworkTimeStatus

此枚举表示 OpenThread 时间同步状态。

属性
OT_NETWORK_TIME_RESYNC_NEEDED

设备已超过两个时间段的时间同步数据。

OT_NETWORK_TIME_SYNCHRONIZED

设备网络时间已同步。

OT_NETWORK_TIME_UNSYNCHRONIZED

设备尚未连接到网络

类型定义符

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

此枚举表示 OpenThread 时间同步状态。

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

当发生网络时间同步或状态更改时,系统会调用此函数指针。

函数

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

获取线程网络时间。

详情
参数
[in] aInstance
OpenThread 实例结构。
[in,out] aNetworkTime
线程网络时间(以微秒为单位)。
返回值
时间同步状态。

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

获取时间同步期限。

详情
参数
[in] aInstance
OpenThread 实例结构。
返回值
时间同步时间段。

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

获取路由器的时间同步 XTAL 准确率阈值。

详情
参数
[in] aInstance
OpenThread 实例结构。
返回值
路由器的 XTAL 准确率阈值(以 PPM 为单位)。

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

设置时间同步期限。

只能在线程协议停用时调用此函数。

详情
参数
[in] aInstance
OpenThread 实例结构。
[in] aTimeSyncPeriod
时间同步时间段(以秒为单位)。
返回值
OT_ERROR_NONE
已成功设置时间同步时间段。
OT_ERROR_INVALID_STATE
已启用线程协议。

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

为支持路由器的设备设置时间同步 XTAL 准确率阈值。

只能在线程协议停用时调用此函数。

详情
参数
[in] aInstance
OpenThread 实例结构。
[in] aXTALThreshold
路由器的 XTAL 准确率阈值(以 PPM 为单位)。
返回值
OT_ERROR_NONE
已成功设置时间同步时间段。
OT_ERROR_INVALID_STATE
已启用线程协议。

otNetworkTimeSyncSetSetCallback

void otNetworkTimeSyncSetCallback(
  otInstance *aInstance,
  otNetworkTimeSyncCallbackFn aCallbackFn,
  void *aCallbackContext
)

设置在网络时间同步或状态更改时调用的回调。

该回调应仅在网络时间偏移达到 OPENThread_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US 或状态发生变化时调用。

详情
参数
[in] aInstance
OpenThread 实例结构。
[in] aCallbackFn
要调用的回调函数
[in] aCallbackContext
要在调用时传递给回调函数的上下文

OT_TIME_SYNC_INVALID_SEQ)

 OT_TIME_SYNC_INVALID_SEQ 0

零被视为无效的时间同步序列。

资源

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