RTC Toolkit 6.0.0
Loading...
Searching...
No Matches
repositorySubscriberIf.ipp
Go to the documentation of this file.
1
11
12// Note this is a template implementation file and should not be included directly.
13// The typical header protection macro is not added to avoid it showing up in Doxygen API
14// documentation.
15#pragma once
16
17#include <exception>
18#include <functional>
19#include <memory>
20#include <type_traits>
21
23
24namespace detail {
25
32
39
43
44} // namespace detail
45
46template <typename T, typename F>
49 const F& cb_value,
50 const ErrorCallbackType& cb_error) const {
51 NotifyCallbackType cb_val;
52 if constexpr (std::is_convertible_v<F, NotifyCallbackType>) {
53 cb_val = cb_value;
54 } else {
55 static_assert(std::is_convertible_v<F, ValueCallbackType<T>>,
56 "The cb_value callback must have a signature compatible with"
57 " void(const DataPointPath&, T&, const MetaData&).");
58 cb_val = [buf = std::make_shared<T>(), cb_value, cb_error, this](const DataPointPath& path2,
59 const MetaData& md) {
60 MetaData mdr;
61 BatchRequest req;
62 req.ReadDataPoint(path2, *buf, mdr);
63 SendRequest(req).Wait();
64 if (md.Contains("sequence_id")) {
65 // If backend supports sequence_id, then check for sequence id missmatch.
66 RtcUInt64 sequence_id_expected = md["sequence_id"].Cast<RtcUInt64>();
67 RtcUInt64 sequence_id_actual = mdr["sequence_id"].Cast<RtcUInt64>();
68 if (sequence_id_expected == sequence_id_actual) {
69 cb_value(path2, *buf, md);
70 } else {
71 auto eptr = std::make_exception_ptr(CII_MAKE_EXCEPTION(
72 SequenceIdMissmatch, path2, sequence_id_expected, sequence_id_actual));
73 cb_error(eptr);
74 }
75 } else {
76 // If backend does not support sequence_id, then just invoke cb_value without check.
77 cb_value(path2, *buf, md);
78 }
79 };
80 }
81 BatchRequest req;
82 auto id = req.Subscribe(path, cb_val, cb_error);
83 SendRequest(req).Wait();
84 Subscription subscription([this, id]() {
85 BatchRequest req;
86 req.Unsubscribe(id);
87 SendRequest(req).Wait();
88 });
89 return subscription;
90}
91
92} // namespace rtctk::componentFramework
This class provides a wrapper for a data point path.
Definition dataPointPath.hpp:76
void ReadDataPoint(const DataPointPath &path, T &buffer, std::optional< std::reference_wrapper< MetaData > > metadata=std::nullopt, const CallbackType &callback=nullptr) const
Definition repositoryIf.ipp:1459
void Wait()
Definition repositoryIf.cpp:650
Class for passing/receiving metadata to/from the repository.
Definition repositoryIf.hpp:145
BatchResponse SendRequest(const BatchRequest &request)
Definition repositoryIf.cpp:674
std::function< void(const DataPointPath &)> CallbackType
Signature of the callback functions that can be registered with the repository requests.
Definition repositoryIf.hpp:60
void Unsubscribe(SubscriptionId) const
Definition repositorySubscriberIf.cpp:52
SubscriptionId Subscribe(const DataPointPath &, NotifyCallbackType, ErrorCallbackType) const
Definition repositorySubscriberIf.cpp:29
RAII wrapper class used to manage the life-time of individual subscriptions.
Definition repositorySubscriberIf.hpp:63
std::function< void(std::exception_ptr)> ErrorCallbackType
Definition repositorySubscriberIf.hpp:48
Subscription Subscribe(const DataPointPath &path, const F &cb_value, const ErrorCallbackType &cb_error) const
Subscribes to datapoint values change events by registering callbacks.
Definition repositorySubscriberIf.ipp:48
std::function< void(const DataPointPath &, const MetaData &)> NotifyCallbackType
Definition repositorySubscriberIf.hpp:47
size_t SubscriptionId
Definition repositorySubscriberIf.hpp:50
Definition measurable.hpp:25
Definition commandReplier.cpp:21
std::uint64_t RtcUInt64
Definition basicTypes.hpp:44
RepositorySubscriberIf::CallbackType cb_created
Definition repositorySubscriberIf.ipp:35
RepositorySubscriberIf::SubscriptionId id
Definition repositorySubscriberIf.ipp:34
RepositorySubscriberIf::ErrorCallbackType cb_error
Definition repositorySubscriberIf.ipp:37
RepositorySubscriberIf::CallbackType cb_deleted
Definition repositorySubscriberIf.ipp:36
Definition repositorySubscriberIf.ipp:40
RepositorySubscriberIf::SubscriptionId id
Definition repositorySubscriberIf.ipp:41
Definition repositorySubscriberIf.ipp:26
RepositorySubscriberIf::ErrorCallbackType cb_error
Definition repositorySubscriberIf.ipp:30
RepositorySubscriberIf::SubscriptionId id
Definition repositorySubscriberIf.ipp:27
RepositorySubscriberIf::NotifyCallbackType cb_value
Definition repositorySubscriberIf.ipp:29
DataPointPath path
Definition repositorySubscriberIf.ipp:28