#include <event.h>
Inheritance diagram for ClockEventBase:
Public Member Functions | |
| int64_t | getClockOffset () const |
| bool | isOffsetInRange () const |
| uint32_t | getOffsetInRangeEventCount () const |
| uint64_t | getSyncInterval () const |
| uint64_t | getGmIdentity () const |
| std::string | getGmIdentityStr () const |
| bool | isGmChanged () const |
| uint32_t | getGmChangedEventCount () const |
| uint64_t | getNotificationTimestamp () const |
Detailed Description
Provide a set of common attributes and methods for clock synchronization events, as listed below:
- clock offset
- clock offset in-range event and its event count
- synchronization interval
- grandmaster clock identity
- grandmaster changed event and its event count
- notification timestamp
Member Function Documentation
◆ getClockOffset()
| int64_t ClockEventBase::getClockOffset | ( | ) | const |
Get the clock offset in nanosecond
- Returns
- Clock offset in nanosecond
◆ getGmChangedEventCount()
| uint32_t ClockEventBase::getGmChangedEventCount | ( | ) | const |
Get the count of grandmaster changed event
- Returns
- The count of grandmaster changed event
- Note
- This count indicates how many times the grandmaster has changed since the last call to statusWait() or statusWaitByName()
◆ getGmIdentity()
| uint64_t ClockEventBase::getGmIdentity | ( | ) | const |
Get the grandmaster clock identity
- Returns
- Grandmaster clock identity
- Note
- The grandmaster is the source clock for the PTP domain (network), whom all the clocks will synchronize to.
◆ getGmIdentityStr()
| std::string ClockEventBase::getGmIdentityStr | ( | ) | const |
Get the grandmaster clock identity in string format
- Returns
- Grandmaster clock identity
- Note
- The grandmaster is the source clock for the PTP domain (network), whom all the clocks will synchronize to.
◆ getNotificationTimestamp()
| uint64_t ClockEventBase::getNotificationTimestamp | ( | ) | const |
Get the notification timestamp in nanosecond
- Returns
- Notification timestamp in nanosecond
- Note
- This timestamp indicates to the most recent time in CLOCK_REALTIME when the Client received a clock sync data notification from the Proxy
◆ getOffsetInRangeEventCount()
| uint32_t ClockEventBase::getOffsetInRangeEventCount | ( | ) | const |
Get the count of clock offset in-range event
- Returns
- The count of clock offset in-range event
- Note
- This count indicates the number of times the clock offset has transitioned from in-range to out-of-range or vice versa since the last call to statusWait() or statusWaitByName()
◆ getSyncInterval()
| uint64_t ClockEventBase::getSyncInterval | ( | ) | const |
Get the synchronization interval in microsecond
- Returns
- Synchronization interval in microsecond
- Note
- This interval indicates the time between clock update messages send to the local service that synchronizing clock. This interval specify the time the synchronization protocol may need to react for a change in the grandmaster.
◆ isGmChanged()
| bool ClockEventBase::isGmChanged | ( | ) | const |
Check if the grandmaster has changed
- Returns
- True if the grandmaster has changed, false otherwise
- Note
- This boolean variable indicates if the grandmaster has changed since the last call of statusWait() or statusWaitByName()
◆ isOffsetInRange()
| bool ClockEventBase::isOffsetInRange | ( | ) | const |
Check if the clock offset is in-range
- Returns
- True if the clock offset is in-range, false otherwise
- Note
- The range of clock offset is defined by user during subscription
The documentation for this class was generated from the following file:
- clkmgr/pub/clkmgr/event.h
