summaryrefslogtreecommitdiff
path: root/include/CommonAPI/Proxy.hpp
blob: a96141c5ac035208ce32b3233e45d799e3956ea2 (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
// Copyright (C) 2013-2017 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
// 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_PROXY_HPP_
#define COMMONAPI_PROXY_HPP_

#include <cstdint>
#include <memory>
#include <type_traits>
#include <future>

#include <CommonAPI/Address.hpp>
#include <CommonAPI/Attribute.hpp>
#include <CommonAPI/Export.hpp>
#include <CommonAPI/Version.hpp>

namespace CommonAPI {

typedef Event<AvailabilityStatus> ProxyStatusEvent;
typedef ReadonlyAttribute<Version> InterfaceVersionAttribute;

class COMMONAPI_EXPORT Proxy {
public:
    virtual ~Proxy();

    const Address &getAddress() const;

    std::future<void> getCompletionFuture();

    virtual bool isAvailable() const = 0;

    virtual bool isAvailableBlocking() const = 0;

    virtual ProxyStatusEvent& getProxyStatusEvent() = 0;

    virtual InterfaceVersionAttribute& getInterfaceVersionAttribute() = 0;

protected:
    Address address_;
    std::promise<void> completed_;
};

} // namespace CommonAPI

#endif // COMMONAPI_PROXY_HPP_