summaryrefslogtreecommitdiff
path: root/interface/vsomeip/application.hpp
blob: 529b1c2fb9775cbdcf283be44d2dc6c9456814d3 (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
// Copyright (C) 2014 BMW Group
// Author: Lutz Bichler (lutz.bichler@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/.

#ifndef VSOMEIP_APPLICATION_HPP
#define VSOMEIP_APPLICATION_HPP

#include <memory>

#include <vsomeip/primitive_types.hpp>
#include <vsomeip/enumeration_types.hpp>
#include <vsomeip/constants.hpp>
#include <vsomeip/handler.hpp>

namespace vsomeip {

class event;
class payload;

class application {
public:
	virtual ~application() {};

	// get name
	virtual const std::string & get_name() const = 0;
	virtual client_t get_client() const = 0;

	// Lifecycle
	virtual bool init() = 0;
	virtual void start() = 0;
	virtual void stop() = 0;

	// Provide services
	virtual void offer_service(service_t _service, instance_t _instance,
			major_version_t _major = DEFAULT_MAJOR, minor_version_t _minor =
					DEFAULT_MINOR, ttl_t _ttl = DEFAULT_TTL) = 0;

	virtual void stop_offer_service(service_t _service,
			instance_t _instance) = 0;

	// Consume services
	virtual void request_service(service_t _service, instance_t _instance,
			major_version_t _major = ANY_MAJOR, minor_version_t _minor =
					ANY_MINOR, ttl_t _ttl = ANY_TTL) = 0;

	virtual void release_service(service_t _service, instance_t _instance) = 0;

	virtual void subscribe(service_t _service, instance_t _instance,
			eventgroup_t _eventgroup, major_version_t _major = ANY_MAJOR,
			ttl_t _ttl = ANY_TTL) = 0;

	virtual void unsubscribe(service_t _service, instance_t _instance,
			eventgroup_t _eventgroup) = 0;

	virtual bool is_available(service_t _service, instance_t _instance) = 0;

	// Send a message
	virtual void send(std::shared_ptr<message> _message, bool _flush = true,
			bool _reliable = false) = 0;

	// Notify subscribers in case an event payload changes
	virtual void notify(service_t _service, instance_t _instance, event_t _event,
						std::shared_ptr<payload> _payload) const = 0;

	// Receive events (Non-SOME/IP)
	virtual void register_event_handler(event_handler_t _handler) = 0;
	virtual void unregister_event_handler() = 0;

	// Receive messages
	virtual void register_message_handler(service_t _service,
			instance_t _instance, method_t _method,
			message_handler_t _handler) = 0;
	virtual void unregister_message_handler(service_t _service,
			instance_t _instance, method_t _method) = 0;

	// Receive availability
	virtual void register_availability_handler(service_t _service,
			instance_t _instance, availability_handler_t _handler) = 0;
	virtual void unregister_availability_handler(service_t _service,
			instance_t _instance) = 0;
};

} // namespace vsomeip

#endif // VSOMEIP_APPLICATION_HPP