summaryrefslogtreecommitdiff
path: root/src/CommonAPI/Proxy.h
blob: b427824e4de1dc112d7e0ff20d6f0ad7835fda7b (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
/* 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_PROXY_H_
#define COMMONAPI_PROXY_H_

#include "Attribute.h"

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

namespace CommonAPI {

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


class Proxy {
 public:
	virtual ~Proxy() { }

 	// The addressing scheme has the following format: "domain:service:instance"
 	virtual std::string getAddress() const = 0;

 	// i.e. "local"
 	virtual const std::string& getDomain() const = 0;

 	// i.e. "com.bmw.infotainment"
 	virtual const std::string& getServiceId() const = 0;

 	// i.e. "com.bmw.infotainment.low"
 	virtual const std::string& getInstanceId() const = 0;

	virtual bool isAvailable() const = 0;

	virtual bool isAvailableBlocking() const = 0;

	virtual ProxyStatusEvent& getProxyStatusEvent() = 0;

	virtual InterfaceVersionAttribute& getInterfaceVersionAttribute() = 0;
};

} // namespace CommonAPI

#endif // COMMONAPI_PROXY_H_