clkmgr 2.0
Clock Manager API library to receive events from the PTP service
Loading...
Searching...
No Matches
Public Member Functions | List of all members
SysClockSubscription Class Reference

#include <subscription.h>

Inheritance diagram for SysClockSubscription:
Inheritance graph
[legend]
Collaboration diagram for SysClockSubscription:
Collaboration graph
[legend]

Public Member Functions

bool setEventMask (uint32_t newEventMask) override final
 
- Public Member Functions inherited from ClockSubscriptionBase
uint32_t getEventMask () const
 
void setClockOffsetThreshold (uint32_t threshold)
 
uint32_t getClockOffsetThreshold () const
 

Additional Inherited Members

- Protected Member Functions inherited from ClockSubscriptionBase
void modifyEventMask (uint32_t newEventMask)
 

Detailed Description

Manage event masks and clock offset thresholds for system clock synchronization event subscriptions.

Member Function Documentation

◆ setEventMask()

bool SysClockSubscription::setEventMask ( uint32_t  newEventMask)
finaloverridevirtual

Set the event mask

Parameters
[in]newEventMaskThe new event mask to set
Returns
True if the event mask is set successfully, false otherwise
Note
The event mask is a bitmask where each bit represents an event, as defined by enum EventIndex. The function validates the new event mask against SYS_EVENT_ALL, ensuring it does not exceed the permissible range.

Reimplemented from ClockSubscriptionBase.


The documentation for this class was generated from the following file: