Synchronizacja czasu sieciowego

Ten moduł zawiera funkcje sterujące usługą synchronizacji czasu w sieci.

Podsumowanie

Wyliczenia

otNetworkTimeStatus{
  OT_NETWORK_TIME_UNSYNCHRONIZED = -1,
  OT_NETWORK_TIME_RESYNC_NEEDED = 0,
  OT_NETWORK_TIME_SYNCHRONIZED = 1
}
enum | typ wyliczeniowy
Reprezentuje stan synchronizacji czasu OpenThread.

Definicje typów

otNetworkTimeStatus typedef
Reprezentuje stan synchronizacji czasu OpenThread.
otNetworkTimeSyncCallbackFn)(void *aCallbackContext) typedef
void(*
Wskaźnik jest wywoływany po wystąpieniu synchronizacji czasu w sieci lub zmianie stanu.

Funkcje

otNetworkTimeGet(otInstance *aInstance, uint64_t *aNetworkTime)
Pobieranie czasu sieci Thread.
otNetworkTimeGetSyncPeriod(otInstance *aInstance)
uint16_t
Uzyskaj okres synchronizacji czasu.
otNetworkTimeGetXtalThreshold(otInstance *aInstance)
uint16_t
Uzyskaj próg dokładności XTAL synchronizacji czasu dla routera.
otNetworkTimeSetSyncPeriod(otInstance *aInstance, uint16_t aTimeSyncPeriod)
Ustaw okres synchronizacji.
otNetworkTimeSetXtalThreshold(otInstance *aInstance, uint16_t aXTALThreshold)
Ustaw próg dokładności XTAL synchronizacji czasu dla urządzenia obsługującego router.
otNetworkTimeSyncSetCallback(otInstance *aInstance, otNetworkTimeSyncCallbackFn aCallbackFn, void *aCallbackContext)
void
Ustaw wywołanie zwrotne, które ma być wykonywane po synchronizacji czasu sieci lub zmiany stanu.

Wyliczenia

otNetworkTimeStatus

 otNetworkTimeStatus

Reprezentuje stan synchronizacji czasu OpenThread.

Właściwości
OT_NETWORK_TIME_RESYNC_NEEDED

Urządzenie nie zarejestrowało synchronizacji czasu od ponad 2 okresów.

OT_NETWORK_TIME_SYNCHRONIZED

Czas sieci urządzenia jest synchronizowany.

OT_NETWORK_TIME_UNSYNCHRONIZED

Urządzenie nie jest podłączone do sieci.

Definicje typów

otNetworkTimeStatus

enum otNetworkTimeStatus otNetworkTimeStatus

Reprezentuje stan synchronizacji czasu OpenThread.

otNetworkTimeSyncCallbackFn

void(* otNetworkTimeSyncCallbackFn)(void *aCallbackContext)

Wskaźnik jest wywoływany po wystąpieniu synchronizacji czasu w sieci lub zmianie stanu.

Funkcje

otNetworkTimeGet

otNetworkTimeStatus otNetworkTimeGet(
  otInstance *aInstance,
  uint64_t *aNetworkTime
)

Pobieranie czasu sieci Thread.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in,out] aNetworkTime
Czas sieci Thread w mikrosekundach.
Zwroty
Stan synchronizacji czasu.

otNetworkTimeGetSyncPeriod

uint16_t otNetworkTimeGetSyncPeriod(
  otInstance *aInstance
)

Uzyskaj okres synchronizacji czasu.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
Zwroty
Okres synchronizacji czasu.

otNetworkTimeGetXtalThreshold

uint16_t otNetworkTimeGetXtalThreshold(
  otInstance *aInstance
)

Uzyskaj próg dokładności XTAL synchronizacji czasu dla routera.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
Zwroty
Próg dokładności XTAL dla routera (PPM).

otNetworkTimeSetSyncPeriod

otError otNetworkTimeSetSyncPeriod(
  otInstance *aInstance,
  uint16_t aTimeSyncPeriod
)

Ustaw okres synchronizacji.

Można ją wywoływać tylko wtedy, gdy protokoły Thread są wyłączone.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aTimeSyncPeriod
Okres synchronizacji czasu w sekundach.
Zwracane wartości
OT_ERROR_NONE
Okres synchronizacji czasu został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.

otNetworkTimeSetXtalThreshold

otError otNetworkTimeSetXtalThreshold(
  otInstance *aInstance,
  uint16_t aXTALThreshold
)

Ustaw próg dokładności XTAL synchronizacji czasu dla urządzenia obsługującego router.

Można ją wywoływać tylko wtedy, gdy protokoły Thread są wyłączone.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aXTALThreshold
Próg dokładności XTAL dla routera (PPM).
Zwracane wartości
OT_ERROR_NONE
Okres synchronizacji czasu został ustawiony.
OT_ERROR_INVALID_STATE
Protokoły wątków są włączone.

otNetworkTimeSyncSetCallback

void otNetworkTimeSyncSetCallback(
  otInstance *aInstance,
  otNetworkTimeSyncCallbackFn aCallbackFn,
  void *aCallbackContext
)

Ustaw wywołanie zwrotne, które ma być wykonywane po synchronizacji czasu sieci lub zmiany stanu.

To wywołanie zwrotne zostanie wykonane tylko wtedy, gdy przesunięcie czasu sieci przeskoczy o OPENTHREAD_CONFIG_TIME_SYNC_JUMP_NOTIF_MIN_US lub zmieni się stan.

Szczegóły
Parametry
[in] aInstance
Struktura instancji OpenThread.
[in] aCallbackFn
Funkcja wywołania zwrotnego, która ma zostać wywołana
[in] aCallbackContext
Kontekst, który ma być przekazywany do funkcji wywołania zwrotnego po wywołaniu

Makra

OT_TIME_SYNC_INVALID_SEQ

 OT_TIME_SYNC_INVALID_SEQ 0

Wartość zero jest uznawana za nieprawidłową sekwencję synchronizacji czasu.

Zasoby

Tematy referencyjne interfejsu OpenThread API pochodzą z kodu źródłowego dostępnego w GitHub. Aby dowiedzieć się więcej lub dołączyć do naszej dokumentacji, skorzystaj z sekcji Zasoby.