summaryrefslogtreecommitdiff
path: root/interface/vsomeip/plugins/application_plugin.hpp
blob: 90e3e64d2399d9ce60adcfbdb9620152d360ffa8 (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
// Copyright (C) 2016-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/.

#ifndef VSOMEIP_V3_APPLICATION_PLUGIN_HPP_
#define VSOMEIP_V3_APPLICATION_PLUGIN_HPP_

#include <string>
#include <memory>

#include <vsomeip/export.hpp>

// Version should be incremented on breaking API change
#define VSOMEIP_APPLICATION_PLUGIN_VERSION              1

namespace vsomeip_v3 {

enum class application_plugin_state_e : uint8_t {
    STATE_INITIALIZED,
    STATE_STARTED,
    STATE_STOPPED
};

/**
 * The application plug-in can be used to extend application behavior
 * via an module/plug-in.
 */
class application_plugin {
public:
    virtual ~application_plugin() {}

    // Called by vSomeIP to inform an application plug-in about its actual state
    // Call should not be blocked from plug-in as there is no threading.
    // The caller thread of "application::init/::start/::stop" will inform the plug-in.
    virtual void on_application_state_change(const std::string _application_name,
            const application_plugin_state_e _app_state) = 0;
};

} // namespace vsomeip_v3

#endif // VSOMEIP_V3_APPLICATION_PLUGIN_HPP_