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

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

Краткое содержание

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

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

Определения типов

otNetworkTimeStatus определение типа
Представляет состояние синхронизации времени OpenThread.
otNetworkTimeSyncCallbackFn )(void *aCallbackContext) определение типа
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

Представляет состояние синхронизации времени OpenThread.

Характеристики
OT_NETWORK_TIME_RESYNC_NEEDED

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

OT_NETWORK_TIME_SYNCHRONIZED

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

OT_NETWORK_TIME_UNSYNCHRONIZED

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

Определения типов

отнетворктиместатус

enum otNetworkTimeStatus otNetworkTimeStatus

Представляет состояние синхронизации времени OpenThread.

отнетворктимимсинккалбакфн

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Указатель вызывается, когда происходит синхронизация времени в сети или изменение статуса.

Функции

отнетворктимемжет

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Получите сетевое время потока.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in,out] aNetworkTime
Сетевое время потока в микросекундах.
Возврат
Статус синхронизации времени.

отнетворктимемесинкпериод

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Получите период синхронизации времени.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
Возврат
Период синхронизации времени.

отнетворктимемжетксталсрехолд

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Получите порог точности синхронизации времени XTAL для маршрутизатора.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
Возврат
Порог точности XTAL для маршрутизатора в PPM.

отнетворктимеметсинкпериод

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Установите период синхронизации времени.

Может быть вызван только тогда, когда протоколы потоков отключены.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in] aTimeSyncPeriod
Период синхронизации времени, в секундах.
Возвращаемые значения
OT_ERROR_NONE
Успешно установили период синхронизации времени.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.

отнетворктимеметксталсрехолд

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Установите порог точности синхронизации времени XTAL для устройства с поддержкой маршрутизатора.

Может быть вызван только тогда, когда протоколы потоков отключены.

Подробности
Параметры
[in] aInstance
Структура экземпляра OpenThread.
[in] aXTALThreshold
Порог точности XTAL для маршрутизатора в PPM.
Возвращаемые значения
OT_ERROR_NONE
Успешно установили период синхронизации времени.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.

отнетворктимесинксетколлбэк

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 . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .