Google 致力于为黑人社区推动种族平等。查看具体行动
此页面由 Cloud Translation API 翻译。
Switch to English

网络时间同步

该模块包括控制网络时间同步服务的功能。

摘要

枚举

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

类型定义

otNetworkTimeStatus 类型定义
此枚举表示OpenThread时间同步状态。
otNetworkTimeSyncCallbackFn )(void *aCallbackContext) 类型定义
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
启用了线程协议。

otNetworkTimeSyncSetCallback

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

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