event.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
   SPDX-FileCopyrightText: Copyright © 2025 Intel Corporation. */
 
#ifndef EVENT_H
#define EVENT_H
 
#include "pub/clkmgr/utility.h"
#include "pub/clkmgr/types.h"
 
#include <string>
 
__CLKMGR_NAMESPACE_BEGIN
 
class ClockEventHandler;
 
class ClockEventBase
{
  public:
    int64_t getClockOffset() const;
 
    bool isOffsetInRange() const;
 
    uint32_t getOffsetInRangeEventCount() const;
 
    uint64_t getSyncInterval() const;
 
    uint64_t getGmIdentity() const;
 
    std::string getGmIdentityStr() const;
 
    bool isGmChanged() const;
 
    uint32_t getGmChangedEventCount() const;
 
    uint64_t getNotificationTimestamp() const;
 
  protected:
    ClockEventBase() = default; 
    friend class ClockEventHandler; 
    int64_t clockOffset = 0; 
    uint64_t syncInterval = 0; 
    uint64_t gmClockUUID = 0; 
    uint64_t notificationTimestamp = 0;
    uint32_t offsetInRangeCount = 0; 
    uint32_t gmChangedCount = 0; 
    bool offsetInRange = true; 
    bool gmChanged = false; 
};
 
class PTPClockEvent : public ClockEventBase
{
  public:
    bool isSyncedWithGm() const;
 
    uint32_t getSyncedWithGmEventCount() const;
 
    bool isAsCapable() const;
 
    uint32_t getAsCapableEventCount() const;
 
    bool isCompositeEventMet() const;
 
    uint32_t getCompositeEventCount() const;
 
  protected:
    PTPClockEvent() = default;
 
  private:
    friend class ClockEventHandler;
    friend class ClockSyncData;
    friend class TimeBaseState;
    uint32_t syncedWithGmCount = 0;
    uint32_t asCapableCount = 0;
    uint32_t compositeEventCount = 0;
    bool syncedWithGm = false;
    bool asCapable = false;
    bool compositeEvent = false;
};
 
class SysClockEvent : public ClockEventBase
{
  protected:
    SysClockEvent() = default;
 
  private:
    friend class ClockEventHandler;
    friend class ClockSyncData;
    friend class TimeBaseState;
};
 
class ClockSyncData
{
  public:
    ClockSyncData() = default;
 
    bool havePTP() const;
 
    PTPClockEvent &getPtp();
 
    bool haveSys() const;
 
    SysClockEvent &getSysClock();
 
  private:
    friend class ClockSyncBaseHandler;
    PTPClockEvent ptpClockSync;
    SysClockEvent sysClockSync;
    bool ptpAvailable = false;
    bool sysAvailable = false;
};
 
__CLKMGR_NAMESPACE_END
 
#endif /* EVENT_H */