NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
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-2021 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 {
28 namespace util {
29 namespace signal {
30 
34 {
35 public:
36  constexpr
37  ScopedConnection() noexcept = default;
38 
39  ScopedConnection(const ScopedConnection&) = delete;
40 
42  operator=(const ScopedConnection&) = delete;
43 
47 
51  operator=(ScopedConnection&&) noexcept;
52 
56  ScopedConnection(Connection connection) noexcept;
57 
64  operator=(Connection connection);
65 
69 
72  void
73  disconnect();
74 
79  bool
80  isConnected() const noexcept;
81 
85  void
86  release() noexcept;
87 
88 private:
89  Connection m_connection;
90 };
91 
92 inline
94 
95 inline ScopedConnection&
96 ScopedConnection::operator=(ScopedConnection&&) noexcept = default;
97 
98 } // namespace signal
99 } // namespace util
100 } // namespace ndn
101 
102 #endif // NDN_CXX_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
Copyright (c) 2011-2015 Regents of the University of California.
represents a connection to a signal
Definition: connection.hpp:36
Disconnects a Connection automatically upon destruction.
void release() noexcept
Release the connection so that it won&#39;t be disconnected when this ScopedConnection is destructed...
bool isConnected() const noexcept
Check if the connection is connected to the signal.
void disconnect()
Manually disconnect the connection.
ScopedConnection & operator=(const ScopedConnection &)=delete
constexpr ScopedConnection() noexcept=default
~ScopedConnection()
Destructor, automatically disconnects the connection.