scoped-connection.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2023 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
23 #define NDN_CXX_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
24 
26 
27 namespace ndn::signal {
28 
33 {
34 public:
35  constexpr
36  ScopedConnection() noexcept = default;
37 
39 
41  operator=(const ScopedConnection&) = delete;
42 
46 
50  operator=(ScopedConnection&&) noexcept;
51 
55  ScopedConnection(Connection connection) noexcept;
56 
63  operator=(Connection connection);
64 
68 
71  void
72  disconnect();
73 
78  bool
79  isConnected() const noexcept;
80 
84  void
85  release() noexcept;
86 
87 private:
88  Connection m_connection;
89 };
90 
91 inline
93 
94 inline ScopedConnection&
95 ScopedConnection::operator=(ScopedConnection&&) noexcept = default;
96 
97 } // namespace ndn::signal
98 
99 #endif // NDN_CXX_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
Represents a connection to a signal.
Definition: connection.hpp:38
Disconnects a Connection automatically upon destruction.
void release() noexcept
Release the connection so that it won't be disconnected when this ScopedConnection is destructed.
void disconnect()
Manually disconnect the connection.
constexpr ScopedConnection() noexcept=default
bool isConnected() const noexcept
Check if the connection is connected to the signal.