blob: 0fe28d4434a8cb81fc11ae14fb79f2784205bd75 [file] [log] [blame]
Junxiao Shi8d71fdb2014-12-07 21:55:19 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Junxiao Shi6617e492016-01-19 07:33:00 -07003 * Copyright (c) 2013-2016 Regents of the University of California.
Junxiao Shi8d71fdb2014-12-07 21:55:19 -07004 *
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 "signal-connection.hpp"
26
27namespace ndn {
28namespace util {
29namespace signal {
30
31/** \brief disconnects a Connection automatically upon destruction
32 */
33class ScopedConnection : noncopyable
34{
35public:
36 ScopedConnection();
37
38 /** \brief implicit constructor from Connection
39 * \param connection the Connection to be disconnected upon destruction
40 */
41 ScopedConnection(const Connection& connection);
42
43 /** \brief move constructor
44 */
Junxiao Shi88681402015-06-30 09:58:53 -070045 ScopedConnection(ScopedConnection&& other) noexcept;
Junxiao Shi8d71fdb2014-12-07 21:55:19 -070046
47 /** \brief assigns a connection
48 *
49 * If a different connection has been assigned to this instance previously,
50 * that connection will be disconnected immediately.
51 */
52 ScopedConnection&
53 operator=(const Connection& connection);
54
55 /** \brief disconnects the connection
56 */
Alexander Afanasyevce7b0622016-01-04 10:47:46 -080057 ~ScopedConnection() noexcept;
Junxiao Shi8d71fdb2014-12-07 21:55:19 -070058
59 /** \brief disconnects the connection manually
60 */
61 void
62 disconnect();
63
Chengyu Fanf46482c2015-02-03 16:55:53 -070064 /** \brief check if the connection is connected to the signal
65 * \return false when a default-constructed connection is used, the connection is released,
66 * or the connection is disconnected
67 */
68 bool
69 isConnected() const;
70
Junxiao Shi8d71fdb2014-12-07 21:55:19 -070071 /** \brief releases the connection so that it won't be disconnected
72 * when this ScopedConnection is destructed
73 */
74 void
75 release();
76
77private:
78 Connection m_connection;
79};
80
81} // namespace signal
82} // namespace util
83} // namespace ndn
84
85#endif // NDN_UTIL_SIGNAL_SCOPED_CONNECTION_HPP