1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
|
/************************************************************************
*
* Copyright (C) 2009-2024 IRCAD France
* Copyright (C) 2012-2019 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/core/config.hpp>
#include <core/base.hpp>
#include <core/com/signal_base.hpp>
#include <core/com/slot_base.hpp>
#include <core/mt/types.hpp>
#include <map>
#include <vector>
namespace sight::core::com
{
/**
* @brief This class defines a proxy for signal/slot connections.
*
* @note All the signals registered in a Proxy's channel are connected to all slots registered in the same channel.
*/
class SIGHT_CORE_CLASS_API proxy
{
public:
using sptr = std::shared_ptr<proxy>;
using channel_key_type = std::string;
/// Constructor, does nothing
SIGHT_CORE_API proxy() = default;
/// Destructor, does nothing
SIGHT_CORE_API ~proxy();
/// Returns an instance of Proxy.
SIGHT_CORE_API static proxy::sptr get();
/// Registers a signal in the channel. It will be connected to all slots in the channel.
SIGHT_CORE_API void connect(channel_key_type _channel, core::com::signal_base::sptr _signal);
/// Registers a slot in the channel. It will be connected to all signals in the channel.
SIGHT_CORE_API void connect(channel_key_type _channel, core::com::slot_base::sptr _slot);
/// Unregisters the signal. Disconnects it from the slots in channel
SIGHT_CORE_API void disconnect(channel_key_type _channel, core::com::signal_base::sptr _signal);
/// Unregisters the slot. Disconnects it from the signals in channel
SIGHT_CORE_API void disconnect(channel_key_type _channel, core::com::slot_base::sptr _slot);
private:
/**
* @brief Structure to regsiter signal and slot informations
* Contains a signal container, a slot container and a mutex to protect access
*/
struct sig_slots_t
{
using signal_container_t = std::set<core::com::signal_base::sptr>;
using slot_container_t = std::set<core::com::slot_base::sptr>;
signal_container_t m_signals;
slot_container_t m_slots;
slot_container_t::iterator m_last_connected_slot;
core::mt::read_write_mutex m_mutex;
};
/**
* @brief Return the sigslot structure for a given channel
* @param _channel identifier of the channel
* @return the sigslot structure for a given channel
*/
[[nodiscard]] SPTR(sig_slots_t) find_or_create_channel(channel_key_type _channel);
using channel_map_type = std::map<channel_key_type, SPTR(sig_slots_t)>;
/// Association channels, SigSlot
channel_map_type m_channels;
/// Used to protect the m_channels access.
mutable core::mt::read_write_mutex m_channel_mutex;
};
} // namespace sight::core::com
|
