NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: 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-2017 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_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
23 #define NDN_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
24 
25 #include "connection.hpp"
26 
27 namespace ndn {
28 namespace util {
29 namespace signal {
30 
33 class ScopedConnection : noncopyable
34 {
35 public:
37 
41  ScopedConnection(const Connection& connection);
42 
45  ScopedConnection(ScopedConnection&& other) noexcept;
46 
53  operator=(const Connection& connection);
54 
57  ~ScopedConnection() noexcept;
58 
61  void
62  disconnect();
63 
68  bool
69  isConnected() const;
70 
74  void
75  release();
76 
77 private:
78  Connection m_connection;
79 };
80 
81 } // namespace signal
82 } // namespace util
83 } // namespace ndn
84 
85 #endif // NDN_UTIL_SIGNAL_SCOPED_CONNECTION_HPP
Copyright (c) 2011-2015 Regents of the University of California.
~ScopedConnection() noexcept
disconnects the connection
bool isConnected() const
check if the connection is connected to the signal
represents a connection to a signal
Definition: connection.hpp:34
ScopedConnection & operator=(const Connection &connection)
assigns a connection
void release()
releases the connection so that it won&#39;t be disconnected when this ScopedConnection is destructed ...
disconnects a Connection automatically upon destruction
void disconnect()
disconnects the connection manually