ClockSubscriptionBase Class Reference

#include <subscription.h>

Inheritance diagram for ClockSubscriptionBase:

Public Member Functions
virtual bool	setEventMask (uint32_t newEventMask)
uint32_t	getEventMask () const
void	setClockOffsetThreshold (uint32_t threshold)
uint32_t	getClockOffsetThreshold () const

Protected Member Functions
void	modifyEventMask (uint32_t newEventMask)

Detailed Description

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

Member Function Documentation

getClockOffsetThreshold()

uint32_t ClockSubscriptionBase::getClockOffsetThreshold

(

)

const

Get the threshold of clock offset

Returns

Threshold of clock offset

getEventMask()

uint32_t ClockSubscriptionBase::getEventMask

(

)

const

Get the value of the event mask

Returns

The value of the event mask

modifyEventMask()

void ClockSubscriptionBase::modifyEventMask ( uint32_t  newEventMask )

protected

Modify the event mask.

Parameters

[in]

newEventMask

The new event mask to set.

setClockOffsetThreshold()

void ClockSubscriptionBase::setClockOffsetThreshold

(

uint32_t

threshold

)

Set the threshold of clock offset

Parameters

[in]

threshold

Threshold of clock offset

Note

The threshold sets a symmetric range of clock offset

setEventMask()

virtual bool ClockSubscriptionBase::setEventMask ( uint32_t  newEventMask )

virtual

Set the event mask

Parameters

[in]

newEventMask

The 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

Reimplemented in PTPClockSubscription, and SysClockSubscription.

---

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

• clkmgr/pub/clkmgr/subscription.h