Эта страница переведена с помощью Cloud Translation API.

Синхронизация сетевого времени

Этот модуль включает в себя функции, управляющие службой синхронизации сетевого времени.

Резюме

Перечисления
`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 для Router в 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 для Router в 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

ноль считается недействительной последовательностью синхронизации времени.

Ресурсы

Разделы справочника по API OpenThread взяты из исходного кода, доступного на GitHub . Чтобы получить дополнительную информацию или внести свой вклад в нашу документацию, обратитесь к разделу Ресурсы .