Inheritance diagram for PTPClockSubscription:

Collaboration diagram for PTPClockSubscription:

Public Member Functions
bool	setCompositeEventMask (uint32_t composite_event_mask)

uint32_t	getCompositeEventMask () const

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 PTP clock synchronization event subscriptions.

Member Function Documentation

uint32_t PTPClockSubscription::getCompositeEventMask ( ) const

Get the value of the composite event mask.

bool PTPClockSubscription::setCompositeEventMask ( uint32_t composite_event_mask )

Set the composite event mask.

Parameters

[in] composite_event_mask The new composite event mask to set.

Returns: True if the composite event mask is set successfully, false otherwise.

Note: The compositie event mask is a bitmask where each bit represents an event, as defined by enum EventIndex and COMPOSITE_EVENT_ALL.

bool PTPClockSubscription::setEventMask ( uint32_t newEventMask )

finaloverridevirtual

Set the event mask

Parameters

[in] newEventMask The new event mask to set

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 PTP_EVENT_ALL, ensuring it does not exceed the permissible range.

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