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

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

Резюме

Перечисления

otNetworkTimeStatus {
OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
OT_NETWORK_TIME_RESYNC_NEEDED = 0,
OT_NETWORK_TIME_SYNCHRONIZED = 1
}
перечислить
Это перечисление представляет статус синхронизации времени OpenThread.

Typedefs

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

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

OT_NETWORK_TIME_SYNCHRONIZED

Сетевое время устройства синхронизировано.

OT_NETWORK_TIME_UNSYNCHRONIZED

Устройство не подключено к сети.

Typedefs

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

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