本頁面由 Cloud Translation API 翻譯而成。

網路時間同步處理

這個模組包含用來控制網路時間同步處理服務的函式。

總結

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

Typedefs
`otNetworkTimeStatus`	typedef `enum otNetworkTimeStatus` 此列舉代表 OpenThread 時間同步狀態。
`otNetworkTimeSyncCallbackFn)(void *aCallbackContext)`	typedef `void(*` 當網路時間同步或狀態變更時，系統會呼叫此函式指標。

函式
`otNetworkTimeGet(otInstance aInstance, uint64_t aNetworkTime)`	`otNetworkTimeStatus` 取得 Thread 網路時間。
`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

此列舉代表 OpenThread 時間同步狀態。

屬性
`OT_NETWORK_TIME_RESYNC_NEEDED`	裝置超過 2 個時段未收到時間同步。
`OT_NETWORK_TIME_SYNCHRONIZED`	裝置網路時間已同步處理。
`OT_NETWORK_TIME_UNSYNCHRONIZED`	裝置未連接至網路。

Typedefs

網路網路狀態

enum otNetworkTimeStatus otNetworkTimeStatus

此列舉代表 OpenThread 時間同步狀態。

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

當網路時間同步或狀態變更時，系統會呼叫此函式指標。

函式

網路網路

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

取得 Thread 網路時間。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in,out] aNetworkTime`	Thread 網路時間 (以毫秒為單位)。

傳回

時間同步處理狀態。

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

取得時間同步期間。

詳細資料

參數

[in] aInstance

OpenThread 執行個體結構。

傳回

時間同步處理期間。

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

取得路由器的時間同步處理功能 XTAL 精確度門檻。

詳細資料

參數

[in] aInstance

OpenThread 執行個體結構。

傳回

路由器的 XTAL 精確度門檻 (以 PM 為單位)。

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

設定時間同步期間。

只有在 Thread 通訊協定已停用時才能呼叫此函式。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aTimeSyncPeriod`	時間同步處理期間，以秒為單位。

傳回值

`OT_ERROR_NONE`	已成功設定時間同步期間。
`OT_ERROR_INVALID_STATE`	已啟用 Thread 通訊協定。

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

設定路由器專用裝置的時間同步 XTAL 精確度門檻。

只有在 Thread 通訊協定已停用時才能呼叫此函式。

詳細資料

參數

`[in] aInstance`	OpenThread 執行個體結構。
`[in] aXTALThreshold`	路由器的 XTAL 精確度門檻 (以 PM 為單位)。

傳回值

`OT_ERROR_NONE`	已成功設定時間同步期間。
`OT_ERROR_INVALID_STATE`	已啟用 Thread 通訊協定。

otNetworkTimeSyncSetCallback

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

設定回呼，以在網路時間同步或狀態變更時呼叫。

只有在網路時間偏移 OPENINVITER_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

系統會將 0 視為無效的時間序列。

資源

OpenThread API 參考主題源自原始碼，可從 GitHub 取得。如要瞭解詳情或參閱說明文件，請參閱資源。