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
ClockSyncSubscription Class Reference

#include <subscription.h>

Public Member Functions

void enablePtpSubscription ()
 
void disablePtpSubscription ()
 
bool isPTPSubscriptionEnable () const
 
void setPtpSubscription (const PTPClockSubscription &newPtpSub)
 
const PTPClockSubscriptiongetPtpSubscription () const
 
void enableSysSubscription ()
 
void disableSysSubscription ()
 
bool isSysSubscriptionEnable () const
 
void setSysSubscription (const SysClockSubscription &newSysSub)
 
const SysClockSubscriptiongetSysSubscription () const
 

Detailed Description

Provide overview of clock event subscriptions to Clock Manager.

Member Function Documentation

◆ disablePtpSubscription()

void ClockSyncSubscription::disablePtpSubscription ( )

Disable the subscription of the PTP clock.

◆ disableSysSubscription()

void ClockSyncSubscription::disableSysSubscription ( )

Disable the subscription of the system clock.

◆ enablePtpSubscription()

void ClockSyncSubscription::enablePtpSubscription ( )

Enable the subscription of the PTP clock.

◆ enableSysSubscription()

void ClockSyncSubscription::enableSysSubscription ( )

Enable the subscription of the system clock.

◆ getPtpSubscription()

const PTPClockSubscription & ClockSyncSubscription::getPtpSubscription ( ) const

Retrieve the PTP clock manager subscription.

Returns
A constant reference to the PTP clock manager subscription.

◆ getSysSubscription()

const SysClockSubscription & ClockSyncSubscription::getSysSubscription ( ) const

Retrieve the system clock manager subscription.

Returns
A constant reference to the system clock manager subscription.

◆ isPTPSubscriptionEnable()

bool ClockSyncSubscription::isPTPSubscriptionEnable ( ) const

Check if the PTP clock subscription is enabled

Returns
True if the PTP clock subscription is enabled, false otherwise

◆ isSysSubscriptionEnable()

bool ClockSyncSubscription::isSysSubscriptionEnable ( ) const

Check if the system clock subscription is enabled

Returns
True if the system clock subscription is enabled, false otherwise

◆ setPtpSubscription()

void ClockSyncSubscription::setPtpSubscription ( const PTPClockSubscription newPtpSub)

Set the PTP clock subscription with a new PTPClockSubscription object and enable it

Parameters
[in]newPtpSubThe new PTPClockSubscription object to update

◆ setSysSubscription()

void ClockSyncSubscription::setSysSubscription ( const SysClockSubscription newSysSub)

Set the system clock subscription with a new SysClockSubscription object and enable it

Parameters
[in]newSysSubThe new SysClockSubscription object to update

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