subscription.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
   SPDX-FileCopyrightText: Copyright © 2024 Intel Corporation. */
 
#ifndef CLKMGR_SUBSCRIPTION_H
#define CLKMGR_SUBSCRIPTION_H
 
#include "pub/clkmgr/utility.h"
#include "pub/clkmgr/types.h"
#include <array>
 
__CLKMGR_NAMESPACE_BEGIN
 
class ClockSubscriptionBase
{
  public:
    ClockSubscriptionBase() = default;
 
    virtual ~ClockSubscriptionBase();
 
    virtual bool setEventMask(uint32_t newEventMask);
 
    uint32_t getEventMask() const;
 
    void setClockOffsetThreshold(uint32_t threshold);
 
    uint32_t getClockOffsetThreshold() const;
 
  protected:
    void modifyEventMask(uint32_t newEventMask);
 
  private:
    uint32_t clockOffsetThreshold = 0;
    uint32_t eventMask = 0;
};
 
class PTPClockSubscription : public ClockSubscriptionBase
{
  public:
    PTPClockSubscription() noexcept;
 
    ~PTPClockSubscription() override;
 
    bool setCompositeEventMask(uint32_t composite_event_mask);
 
    uint32_t getCompositeEventMask() const;
 
    bool setEventMask(uint32_t newEventMask) override final;
 
  private:
    uint32_t m_composite_event_mask = 0;
};
 
class SysClockSubscription : public ClockSubscriptionBase
{
  public:
    SysClockSubscription() noexcept;
 
    ~SysClockSubscription() override;
 
    bool setEventMask(uint32_t newEventMask) override final;
};
 
class ClockSyncSubscription
{
  public:
    ClockSyncSubscription();
 
    void enablePtpSubscription();
 
    void disablePtpSubscription();
 
    bool isPTPSubscriptionEnable() const;
 
    void setPtpSubscription(const PTPClockSubscription &newPtpSub);
 
    const PTPClockSubscription &getPtpSubscription() const;
 
    void enableSysSubscription();
 
    void disableSysSubscription();
 
    bool isSysSubscriptionEnable() const;
 
    void setSysSubscription(const SysClockSubscription &newSysSub);
 
    const SysClockSubscription &getSysSubscription() const;
 
  private:
    PTPClockSubscription ptpSubscription;
    SysClockSubscription sysSubscription;
    bool ptpSubscribed;
    bool sysSubscribed;
};
 
__CLKMGR_NAMESPACE_END
 
#endif /* CLKMGR_SUBSCRIPTION_H */