clkmgr 2.0
Clock Manager API library to receive events from the PTP service
Loading...
Searching...
No Matches
clockmanager.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: BSD-3-Clause
2 SPDX-FileCopyrightText: Copyright © 2024 Intel Corporation. */
3
13#ifndef CLOCKMANAGER_H
14#define CLOCKMANAGER_H
15
16#ifdef __cplusplus
17
18#include "pub/clkmgr/event.h"
21#include <memory>
22
24
30{
31 private:
32 ClockManager() = default;
33
34 public:
35
41
46 static bool connect();
47
52 static bool disconnect();
53
59
70 static bool subscribeByName(const ClockSyncSubscription &newSub,
71 const std::string &timeBaseName, ClockSyncData &clockSyncData);
72
83 static bool subscribe(const ClockSyncSubscription &newSub,
84 size_t timeBaseIndex, ClockSyncData &clockSyncData);
85
102 static enum StatusWaitResult statusWaitByName(int timeout,
103 const std::string &timeBaseName, ClockSyncData &clockSyncData);
104
121 static enum StatusWaitResult statusWait(int timeout, size_t timeBaseIndex,
122 ClockSyncData &clockSyncData);
123
129 static bool getTime(timespec &ts);
130};
131
133#else /* __cplusplus */
135#endif /* __cplusplus */
136
137#endif /* CLOCKMANAGER_H */
Definition clockmanager.h:30
static enum StatusWaitResult statusWait(int timeout, size_t timeBaseIndex, ClockSyncData &clockSyncData)
static const TimeBaseConfigurations & getTimebaseCfgs()
static bool subscribe(const ClockSyncSubscription &newSub, size_t timeBaseIndex, ClockSyncData &clockSyncData)
static enum StatusWaitResult statusWaitByName(int timeout, const std::string &timeBaseName, ClockSyncData &clockSyncData)
static bool getTime(timespec &ts)
static bool connect()
static bool subscribeByName(const ClockSyncSubscription &newSub, const std::string &timeBaseName, ClockSyncData &clockSyncData)
static bool disconnect()
static ClockManager & fetchSingleInstance()
Definition event.h:234
Definition subscription.h:141
Definition timebase_configs.h:157
C wrapper to the Clock Manager APIs to set up Client and monitor clock synchronization events.
Get clock synchronization events data.
Set clock event subscription.
Get the configuration of time base.
StatusWaitResult
Definition types.h:63
#define __CLKMGR_NAMESPACE_BEGIN
Definition utility.h:19
#define __CLKMGR_NAMESPACE_END
Definition utility.h:21