Antkeeper  0.0.1
subscription.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_EVENT_SUBSCRIPTION_HPP
21 #define ANTKEEPER_EVENT_SUBSCRIPTION_HPP
22 
23 #include <functional>
24 #include <memory>
25 
26 namespace event {
27 
32 {
33 public:
35  typedef std::function<void()> unsubscribe_type;
36 
43  subscription(std::weak_ptr<void>&& subscriber, unsubscribe_type&& unsubscriber);
44 
48  ~subscription();
49 
53  [[nodiscard]] bool expired() const noexcept;
54 
58  void unsubscribe();
59 
60 private:
61  std::weak_ptr<void> subscriber;
62  unsubscribe_type unsubscriber;
63 };
64 
68 typedef std::shared_ptr<subscription> shared_subscription;
69 
70 } // namespace event
71 
72 #endif // ANTKEEPER_EVENT_SUBSCRIPTION_HPP
Unsubscribes a subscriber on destruction.
bool expired() const noexcept
Returns true if the subscription is no longer active, false otherwise.
std::function< void()> unsubscribe_type
Unsubscribe function object type.
~subscription()
Unsubscribes the subscriber and destructs the subscription.
void unsubscribe()
Unsubscribes the subscriber.
subscription(std::weak_ptr< void > &&subscriber, unsubscribe_type &&unsubscriber)
Constructs a subscription.
Publish-subscribe messaging.
Definition: channel.hpp:32
std::function< void(const T &)> subscriber
Subscriber function object type.
Definition: subscriber.hpp:33
std::shared_ptr< subscription > shared_subscription
Shared pointer to a subscription.