Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。

ネットワーク時刻の同期

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

概要

列挙

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

Typedef

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

デバイスは、2期間を超えて時刻同期を受信して​​いません。

OT_NETWORK_TIME_SYNCHRONIZED

デバイスのネットワーク時刻が同期されます。

OT_NETWORK_TIME_UNSYNCHRONIZED

デバイスがネットワークに接続されていません。

Typedef

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インスタンス構造。
戻り値
PPMでのルーターのXTAL精度しきい値。

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
PPMでのルーターのXTAL精度しきい値。
戻り値
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

ゼロは無効な時刻同期シーケンスと見なされます。