File: skeleton.h

package info (click to toggle)
dbus-cpp 5.0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,208 kB
  • sloc: cpp: 9,427; ansic: 2,012; xml: 1,156; makefile: 14; sh: 2
file content (73 lines) | stat: -rw-r--r-- 2,101 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright © 2012 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 CORE_DBUS_SKELETON_H_
#define CORE_DBUS_SKELETON_H_

#include <core/dbus/bus.h>
#include <core/dbus/service.h>
#include <core/dbus/visibility.h>

namespace core
{
namespace dbus
{
/**
 * @brief Skeleton is a template class that helps with exposing interface implementations on the bus.
 * @tparam T The type of the interface for which we want to expose an implementation for.
 */
template<typename T>
class ORG_FREEDESKTOP_DBUS_DLL_PUBLIC Skeleton : public T
{
public:
    virtual ~Skeleton() noexcept = default;

protected:
    /**
     * @brief Skeleton announces the service on the given bus instance.
     * @param bus The bus that the actual service lives upon
     */
    inline explicit Skeleton(const Bus::Ptr& bus) : bus(bus),
        service(Service::add_service<T>(bus))
    {
    }

    /**
     * @brief access_bus provides access to the underlying bus instance.
     * @return A mutable reference to the underlying bus.
     */
    inline const Bus::Ptr& access_bus() const
    {
        return bus;
    }

    /**
     * @brief Provides access to the underlying service object that this object is a proxy for.
     * @return A mutable reference to the underlying service object.
     */
    inline const Service::Ptr& access_service() const
    {
        return service;
    }

private:
    Bus::Ptr bus;
    Service::Ptr service;
};
}
}
#endif // CORE_DBUS_SKELETON_H_