このページは Cloud Translation API によって翻訳されました。

ネットワーク時刻の同期

このモジュールには、ネットワーク時刻同期サービスを制御する関数が含まれています。

まとめ

列挙型
`otNetworkTimeStatus{ OT_NETWORK_TIME_UNSYNCHRONIZED = -1, OT_NETWORK_TIME_RESYNC_NEEDED = 0, OT_NETWORK_TIME_SYNCHRONIZED = 1 }`	列挙型この列挙型は、OpenThread の時間同期ステータスを表します。

Typedef
`otNetworkTimeStatus`	typedef `enum otNetworkTimeStatus` この列挙型は、OpenThread の時間同期ステータスを表します。
`otNetworkTimeSyncCallbackFn)(void *aCallbackContext)`	typedef `void(*` この関数ポインタは、ネットワーク時刻の同期やステータス変更が発生したときに呼び出されます。

Functions
`otNetworkTimeGet(otInstance aInstance, uint64_t aNetworkTime)`	`otNetworkTimeStatus` Thread ネットワーク時間を取得します。
`otNetworkTimeGetSyncPeriod(otInstance *aInstance)`	`uint16_t` 時刻の同期期間を取得します。
`otNetworkTimeGetXtalThreshold(otInstance *aInstance)`	`uint16_t` Router の時刻同期の 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 の時間同期ステータスを表します。

Properties
`OT_NETWORK_TIME_RESYNC_NEEDED`	デバイスで時刻の同期が 2 回以上行われていません。
`OT_NETWORK_TIME_SYNCHRONIZED`	デバイスのネットワーク時間が同期されます。
`OT_NETWORK_TIME_UNSYNCHRONIZED`	デバイスがネットワークに接続されていない。

Typedef

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

この列挙型は、OpenThread の時間同期ステータスを表します。

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

この関数ポインタは、ネットワーク時刻の同期やステータス変更が発生したときに呼び出されます。

Functions

otNetworkTimeGet を使用する

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Thread ネットワーク時間を取得します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンス構造
`[in,out] aNetworkTime`	スレッドネットワーク時間（マイクロ秒単位）。

戻り値

時刻同期ステータス。

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

時刻の同期期間を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンス構造

戻り値

時刻の同期期間。

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Router の時刻同期の XTAL 精度しきい値を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンス構造

戻り値

Router の XTAL 精度しきい値（PPM 単位）。

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

時刻の同期期間を設定します。

この関数は、Thread プロトコルが無効になっている場合にのみ呼び出すことができます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンス構造
`[in] aTimeSyncPeriod`	時刻の同期期間（秒）。

戻り値

`OT_ERROR_NONE`	時刻の同期期間を設定しました。
`OT_ERROR_INVALID_STATE`	スレッドプロトコルが有効になっている。

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

ルーター対応デバイスの時刻同期の XTAL 精度しきい値を設定します。

この関数は、Thread プロトコルが無効になっている場合にのみ呼び出すことができます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンス構造
`[in] aXTALThreshold`	Router の 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

0 は無効な時間同期シーケンスと見なされます。

リソース

OpenThread API リファレンスのトピックは、GitHub で入手可能なソースコードから作成されています。詳細やドキュメントについては、リソースをご覧ください。