#include <event.h>
Inheritance diagram for PTPClockEvent:
Collaboration diagram for PTPClockEvent:
Public Member Functions | |
| bool | isSyncedWithGm () const |
| uint32_t | getSyncedWithGmEventCount () const |
| bool | isAsCapable () const |
| uint32_t | getAsCapableEventCount () const |
| bool | isCompositeEventMet () const |
| uint32_t | getCompositeEventCount () const |
 Public Member Functions inherited from ClockEventBase | |
| 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 |
Friends | |
| class | ClockEventHandler |
| class | ClockSyncData |
| class | TimeBaseState |
Detailed Description
Extends the ClockEventBase class to include attributes specific to Precision Time Protocol (PTP) synchronization, such as:
- clock synced with grandmaster event
- IEEE 802.1AS capable event
- composite event
Member Function Documentation
◆ getAsCapableEventCount()
| uint32_t PTPClockEvent::getAsCapableEventCount | ( | ) | const |
Get the count of IEEE 802.1AS capable event
- Returns
- The count of IEEE 802.1AS capable event
- Note
- This count indicates the number of times the clock has transitioned from non capable to capable or vice versa since the last call to statusWait() or statusWaitByName()
◆ getCompositeEventCount()
| uint32_t PTPClockEvent::getCompositeEventCount | ( | ) | const |
Get the count of composite event
- Returns
- The count of composite event
- Note
- This count indicates the number of times the condition of composite event has transitioned from not met to met or vice versa since the last call to statusWait() or statusWaitByName()
◆ getSyncedWithGmEventCount()
| uint32_t PTPClockEvent::getSyncedWithGmEventCount | ( | ) | const |
Get the count of clock synced with grandmaster event
- Returns
- The count of clock synced with grandmaster event
- Note
- This count indicates the number of times the clock has transitioned from synced with grandmaster to out-of-sync or vice versa since the last call to statusWait() or statusWaitByName()
◆ isAsCapable()
| bool PTPClockEvent::isAsCapable | ( | ) | const |
Check if the clock is an IEEE 802.1AS capable
- Returns
- True if the clock is an IEEE 802.1AS capable, false otherwise
◆ isCompositeEventMet()
| bool PTPClockEvent::isCompositeEventMet | ( | ) | const |
Check if all the conditions in the subscribed composite event are met
- Returns
- True if all the conditions are met, false otherwise
- Note
- Condition of composite event is defined by the user during subsciption
◆ isSyncedWithGm()
| bool PTPClockEvent::isSyncedWithGm | ( | ) | const |
Check if the PTP clock is synchronized with a grandmaster
- Returns
- True if the clock is synchronized with a grandmaster, false if otherwise
The documentation for this class was generated from the following file:
- clkmgr/pub/clkmgr/event.h
