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
25
#include "
ndn-cxx/util/signal/connection.hpp
"
26
27
namespace
ndn
{
28
namespace
util {
29
namespace
signal
{
30
33
class
ScopedConnection
34
{
35
public
:
36
constexpr
37
ScopedConnection
() noexcept =
default
;
38
39
ScopedConnection
(
const
ScopedConnection
&) =
delete
;
40
41
ScopedConnection
&
42
operator=
(
const
ScopedConnection
&) =
delete
;
43
46
ScopedConnection
(
ScopedConnection
&&) noexcept;
47
50
ScopedConnection
&
51
operator=
(
ScopedConnection
&&) noexcept;
52
56
ScopedConnection
(
Connection
connection) noexcept;
57
63
ScopedConnection
&
64
operator=
(
Connection
connection);
65
68
~ScopedConnection
();
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
93
ScopedConnection::ScopedConnection
(
ScopedConnection
&&) noexcept =
default
;
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
ndn
Copyright (c) 2011-2015 Regents of the University of California.
Definition:
ndn-strategy-choice-helper.hpp:34
connection.hpp
ndn::util::signal::Connection
represents a connection to a signal
Definition:
connection.hpp:36
ndn::util::signal::ScopedConnection
Disconnects a Connection automatically upon destruction.
Definition:
scoped-connection.hpp:33
ndn::util::signal::ScopedConnection::release
void release() noexcept
Release the connection so that it won't be disconnected when this ScopedConnection is destructed...
Definition:
scoped-connection.cpp:61
ndn::util::signal::ScopedConnection::isConnected
bool isConnected() const noexcept
Check if the connection is connected to the signal.
Definition:
scoped-connection.cpp:55
ndn::util::signal::ScopedConnection::disconnect
void disconnect()
Manually disconnect the connection.
Definition:
scoped-connection.cpp:49
ndn::util::signal::ScopedConnection::operator=
ScopedConnection & operator=(const ScopedConnection &)=delete
ndn::util::signal
Definition:
connection.cpp:26
ndn::util::signal::ScopedConnection::ScopedConnection
constexpr ScopedConnection() noexcept=default
ndn::util::signal::ScopedConnection::~ScopedConnection
~ScopedConnection()
Destructor, automatically disconnects the connection.
Definition:
scoped-connection.cpp:43
ndnSIM
ndn-cxx
ndn-cxx
util
signal
scoped-connection.hpp
Generated on Fri May 6 2022 12:34:13 for ndnSIM by
1.8.13