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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
/*
Copyright (c) 2016, Ford Motor Company
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the
distribution.
Neither the name of the Ford Motor Company nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_OBSERVER_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_OBSERVER_H_
#include <string>
#include "application_manager/event_engine/event.h"
namespace application_manager {
namespace event_engine {
class EventDispatcher;
class EventObserver {
public:
friend class EventDispatcher;
// Typedef for possible Observer ID's from mobile_apis functionID enum
typedef unsigned long ObserverID;
/*
* @brief Constructor
*
*/
EventObserver(EventDispatcher& event_dispatcher);
/*
* @brief Destructor
*/
virtual ~EventObserver();
/**
* @brief Retrieves observer unique id
*
* @return Unique Observer id
*/
inline const ObserverID& id() const;
/**
* @brief Interface method that is called whenever new event received
*
* @param event The received event
*/
virtual void HandleOnEvent(const Event& event) = 0;
virtual void HandleOnEvent(const MobileEvent& event);
/**
* @brief Increments reference count to avoid observer destruction while
* event dispatcher keeping pointer to that observer
* @return true if request reference was incremented, otherwise returns false
*/
virtual bool IncrementReferenceCount() const;
/**
* @brief Decrements reference count to allow observer be safely destroyed
* as event dispatcher does not keep any pointers to it
* @return true if request reference was decremented, otherwise returns false
*/
virtual bool DecrementReferenceCount() const;
protected:
/*
* @brief Subscribe to an event
*
* @param event_id The event ID to subscribe for
* @param hmi_correlation_id The event HMI correlation ID.
* If param is omitted, it means subscription for HMI notification
*/
void subscribe_on_event(const Event::EventID& event_id,
int32_t hmi_correlation_id = 0);
/*
* @brief Unsubscribes the observer from specific event
*
* @param event_id The event ID to unsubscribe from
*/
void unsubscribe_from_event(const Event::EventID& event_id);
/*
* @brief Unsubscribes the observer from all events
*
*/
void unsubscribe_from_all_hmi_events();
// Mobile Events
/*
* @brief Subscribe to an event
*
* @param event_id The event ID to subscribe for
* @param mobile_correlation_id The event mobile correlation ID.
* If param is omitted, it means subscription for mobile notification
*/
void subscribe_on_event(const MobileEvent::MobileEventID& event_id,
int32_t mobile_correlation_id = 0);
/*
* @brief Unsubscribes the observer from specific event
*
* @param event_id The event ID to unsubscribe from
*/
void unsubscribe_from_event(const MobileEvent::MobileEventID& event_id);
/*
* @brief Unsubscribes the observer from all events
*
*/
void unsubscribe_from_all_mobile_events();
private:
ObserverID id_;
EventDispatcher& event_dispatcher_;
DISALLOW_COPY_AND_ASSIGN(EventObserver);
};
const EventObserver::ObserverID& EventObserver::id() const {
return id_;
}
} // namespace event_engine
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_OBSERVER_H_
|
