summaryrefslogtreecommitdiff
path: root/src/CommonAPI/DBus/DBusDaemonProxy.h
blob: 5db293232d8e5bfe99f9dfa9c6d248594ee091a9 (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
/* Copyright (C) 2013 BMW Group
 * Author: Manfred Bathelt (manfred.bathelt@bmw.de)
 * Author: Juergen Gehring (juergen.gehring@bmw.de)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#error "Only <CommonAPI/CommonAPI.h> can be included directly, this file may disappear or change contents."
#endif

#ifndef COMMONAPI_DBUS_DBUS_DAEMON_PROXY_H_
#define COMMONAPI_DBUS_DBUS_DAEMON_PROXY_H_

#include "DBusProxyBase.h"
#include "DBusEvent.h"

#include <functional>
#include <string>
#include <vector>


namespace CommonAPI {
namespace DBus {

class StaticInterfaceVersionAttribute: public InterfaceVersionAttribute {
 public:
    StaticInterfaceVersionAttribute(const uint32_t& majorValue, const uint32_t& minorValue);

    void getValue(CallStatus& callStatus, Version& version) const;
    std::future<CallStatus> getValueAsync(AttributeAsyncCallback attributeAsyncCallback);

 private:
    Version version_;
};


class DBusDaemonProxy: public DBusProxyBase {
 public:
    typedef Event<std::string, std::string, std::string> NameOwnerChangedEvent;

    typedef std::unordered_map<std::string, int> PropertyDictStub;
    typedef std::unordered_map<std::string, PropertyDictStub> InterfaceToPropertyDict;
    typedef std::unordered_map<std::string, InterfaceToPropertyDict> DBusObjectToInterfaceDict;

    typedef std::function<void(const CommonAPI::CallStatus&, std::vector<std::string>)> ListNamesAsyncCallback;
    typedef std::function<void(const CommonAPI::CallStatus&, bool)> NameHasOwnerAsyncCallback;
    typedef std::function<void(const CommonAPI::CallStatus&, DBusObjectToInterfaceDict)> GetManagedObjectsAsyncCallback;
    typedef std::function<void(const CommonAPI::CallStatus&, std::string)> GetNameOwnerAsyncCallback;

    DBusDaemonProxy(const std::shared_ptr<DBusProxyConnection>& dbusConnection);

    virtual bool isAvailable() const;
    virtual bool isAvailableBlocking() const;
    virtual ProxyStatusEvent& getProxyStatusEvent();
    virtual InterfaceVersionAttribute& getInterfaceVersionAttribute();

    void init();

    static const char* getInterfaceId();

    NameOwnerChangedEvent& getNameOwnerChangedEvent();

    void listNames(CommonAPI::CallStatus& callStatus, std::vector<std::string>& busNames) const;
    std::future<CallStatus> listNamesAsync(ListNamesAsyncCallback listNamesAsyncCallback) const;

    void nameHasOwner(const std::string& busName, CommonAPI::CallStatus& callStatus, bool& hasOwner) const;
    std::future<CallStatus> nameHasOwnerAsync(const std::string& busName,
                                              NameHasOwnerAsyncCallback nameHasOwnerAsyncCallback) const;

    std::future<CallStatus> getManagedObjectsAsync(const std::string& forDBusServiceName,
                                                   GetManagedObjectsAsyncCallback) const;

    /**
     * Get the unique connection/bus name of the primary owner of the name given
     *
     * @param busName Name to get the owner of
     * @param getNameOwnerAsyncCallback callback functor
     *
     * @return CallStatus::REMOTE_ERROR if the name is unknown, otherwise CallStatus::SUCCESS and the uniq name of the owner
     */
    std::future<CallStatus> getNameOwnerAsync(const std::string& busName, GetNameOwnerAsyncCallback getNameOwnerAsyncCallback) const;

    virtual std::string getAddress() const;
    virtual const std::string& getDomain() const;
    virtual const std::string& getServiceId() const;
    virtual const std::string& getInstanceId() const;

    virtual const std::string& getDBusBusName() const;
    virtual const std::string& getDBusObjectPath() const;
    virtual const std::string& getInterfaceName() const;

 private:
    DBusEvent<NameOwnerChangedEvent> nameOwnerChangedEvent_;
    StaticInterfaceVersionAttribute interfaceVersionAttribute_;
};

} // namespace DBus
} // namespace CommonAPI

#endif // COMMONAPI_DBUS_DBUS_DAEMON_PROXY_H_