aboutsummaryrefslogtreecommitdiff
path: root/include/core/connection.h
blob: 37b1355d4bcd54a941f6f780fa5ffb1f8e462b83 (plain)
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
/*
 * Copyright © 2013 Canonical Ltd.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3,
 * as published by the Free Software Foundation.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authored by: Thomas Voß <thomas.voss@canonical.com>
 */
#ifndef COM_UBUNTU_CONNECTION_H_
#define COM_UBUNTU_CONNECTION_H_

#include <functional>
#include <memory>
#include <mutex>

namespace core
{
/**
 * @brief The Connection class models a signal-slot connection.
 */
class Connection
{
public:    
    typedef std::function<void(const std::function<void()>&)> Dispatcher;

    /**
     * @brief Checks if this instance corresponds to an active signal-slot connection.
     * @return true iff the instance corresponds to an active signal-slot connection.
     */
    inline bool is_connected() const
    {
        return (d->disconnector ? true : false);
    }

    /**
     * @brief End a signal-slot connection.
     */
    inline void disconnect()
    {
        d->disconnect();
    }

    /**
     * @brief Installs a dispatcher for this signal-slot connection.
     * @param dispatcher The dispatcher to be used for signal emissions.
     */
    inline void dispatch_via(const Dispatcher& dispatcher)
    {
        if (d->dispatcher_installer)
            d->dispatcher_installer(dispatcher);
    }

private:
    typedef std::function<void()> Disconnector;
    typedef std::function<void(const Dispatcher&)> DispatcherInstaller;

    template<typename ... Arguments> friend class Signal;

    inline Connection(const Disconnector& disconnector,
                      const DispatcherInstaller& installer)
        : d(std::make_shared<Private>(disconnector, installer))
    {
    }

    inline void reset()
    {
        d->reset();
    }

    struct Private
    {
        Private(const Connection::Disconnector& disconnector_,
                const Connection::DispatcherInstaller& dispatcher_installer_)
            : disconnector(disconnector_),
              dispatcher_installer(dispatcher_installer_)
        {
        }

        inline void reset()
        {
            std::lock_guard<std::mutex> lg(guard);
            reset_locked();
        }

        inline void reset_locked()
        {
            static const Connection::Disconnector empty_disconnector{};
            static const Connection::DispatcherInstaller empty_dispatcher_installer{};

            disconnector = empty_disconnector;
            dispatcher_installer = empty_dispatcher_installer;
        }

        inline void disconnect()
        {
            static const Connection::Disconnector empty_disconnector{};

            std::lock_guard<std::mutex> lg(guard);

            if (disconnector)
                disconnector();

            reset_locked();
        }

        std::mutex guard;
        Connection::Disconnector disconnector;
        Connection::DispatcherInstaller dispatcher_installer;
    };

    // The whole class is implicitly shared and we thus forward our complete
    // shared state to a private structure that is lifetime-managed by a shared_ptr.
    std::shared_ptr<Private> d;
};

/**
 * @brief Scoped helper class to map signal-slot connection mgmt. to RAII.
 */
class ScopedConnection
{
public:
    /**
     * @brief Constructs an instance for an existing signal-slot connection.
     * @param c The existing signal-slot connection.
     */
    inline ScopedConnection(const Connection& c) : connection(c)
    {
    }

    ScopedConnection(const ScopedConnection&) = delete;

    /**
     * @brief Disconnects the signal-slot connection.
     */
    inline ~ScopedConnection() noexcept(true)
    {
        try
        {
            connection.disconnect();
        } catch(...)
        {
        }
    }

    ScopedConnection& operator=(const ScopedConnection&) = delete;
    bool operator==(const ScopedConnection&) = delete;

private:
    Connection connection;
};
}

#endif // COM_UBUNTU_CONNECTION_H_