網絡時間同步

該模塊包括控製網絡時間同步服務的功能。

摘要

枚舉
`otNetworkTimeStatus { OT_NETWORK_TIME_UNSYNCHRONIZED = -1, OT_NETWORK_TIME_RESYNC_NEEDED = 0, OT_NETWORK_TIME_SYNCHRONIZED = 1 }`	枚舉此枚舉表示OpenThread時間同步狀態。

類型定義
`otNetworkTimeStatus`	類型定義 `enum otNetworkTimeStatus` 此枚舉表示OpenThread時間同步狀態。
`otNetworkTimeSyncCallbackFn )(void *aCallbackContext)`	類型定義 `void(*` 當網絡時間同步或狀態更改發生時，將調用此函數指針。

功能
`otNetworkTimeGet ( otInstance aInstance, uint64_t aNetworkTime)`	`otNetworkTimeStatus` 獲取線程網絡時間。
`otNetworkTimeGetSyncPeriod ( otInstance *aInstance)`	`uint16_t` 獲取時間同步週期。
`otNetworkTimeGetXtalThreshold ( otInstance *aInstance)`	`uint16_t` 獲取路由器的時間同步XTAL精度閾值。
`otNetworkTimeSetSyncPeriod ( otInstance *aInstance, uint16_t aTimeSyncPeriod)`	`otError` 設置時間同步週期。
`otNetworkTimeSetXtalThreshold ( otInstance *aInstance, uint16_t aXTALThreshold)`	`otError` 設置支持路由器的設備的時間同步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

零被視為無效的時間同步序列。