summaryrefslogtreecommitdiff
path: root/src/components/application_manager/include/application_manager/event_engine/event_dispatcher_impl.h
blob: ffe659a07c2c9b66643c35f0931fe4961144ff71 (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
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
 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_DISPATCHER_IMPL_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_DISPATCHER_IMPL_H_

#include <map>
#include <vector>

#include "utils/lock.h"

#include "application_manager/event_engine/event.h"
#include "application_manager/event_engine/event_dispatcher.h"

namespace application_manager {
namespace event_engine {

class EventObserver;

class EventDispatcherImpl : public EventDispatcher {
 public:
  // Data types section
  typedef std::vector<EventObserver*> ObserverVector;
  typedef std::map<int32_t, ObserverVector> ObserversMap;
  typedef std::map<Event::EventID, ObserversMap> EventObserverMap;
  typedef std::map<MobileEvent::MobileEventID, ObserversMap>
      MobileEventObserverMap;
  /*
   * @brief Destructor
   */
  virtual ~EventDispatcherImpl();

  /*
   * @brief Default constructor
   */
  EventDispatcherImpl();

#ifdef BUILD_TESTS
  EventObserverMap get_observers() const {
    return observers_event_;
  }
  MobileEventObserverMap get_mobile_observers() const {
    return mobile_observers_event_;
  }
  ObserverVector get_observers_list() const {
    return observers_;
  }
#endif  // BUILD_TESTS

  /*
   * @brief Delivers the event to all subscribers
   *
   * @param event Received event
   */
  void raise_event(const Event& event) OVERRIDE;

  void remove_observer(const Event::EventID& event_id,
                       const int32_t hmi_correlation_id) OVERRIDE;

  /*
   * @brief Subscribe the observer to event
   *
   * @param event_id    The event ID to subscribe for
   * @param hmi_correlation_id  The event HMI correlation ID
   * @param observer    The observer to subscribe for event
   */
  void add_observer(const Event::EventID& event_id,
                    int32_t hmi_correlation_id,
                    EventObserver& observer) OVERRIDE;

  /*
   * @brief Unsubscribes the observer from specific event
   *
   * @param event_id    The event ID to unsubscribe from
   * @param observer    The observer to be unsubscribed
   */
  void remove_observer(const Event::EventID& event_id,
                       EventObserver& observer) OVERRIDE;

  /*
   * @brief Unsubscribes the observer from all events
   *
   * @param observer  The observer to be unsubscribed
   */
  void remove_observer(EventObserver& observer) OVERRIDE;

  // Mobile requests
  /*
   * @brief Delivers the event to all subscribers
   *
   * @param event Received event
   */
  void raise_mobile_event(const MobileEvent& event) OVERRIDE;

  /*
   * @brief Subscribe the observer to event
   *
   * @param event_id    The event ID to subscribe for
   * @param hmi_correlation_id  The event HMI correlation ID
   * @param observer    The observer to subscribe for event
   */
  void add_mobile_observer(const MobileEvent::MobileEventID& event_id,
                           int32_t mobile_correlation_id,
                           EventObserver& observer) OVERRIDE;

  /*
   * @brief Unsubscribes the observer from specific event
   *
   * @param event_id    The event ID to unsubscribe from
   * @param observer    The observer to be unsubscribed
   */
  void remove_mobile_observer(const MobileEvent::MobileEventID& event_id,
                              EventObserver& observer) OVERRIDE;

  /*
   * @brief Unsubscribes the observer from all events
   *
   * @param observer  The observer to be unsubscribed
   */
  void remove_mobile_observer(EventObserver& observer) OVERRIDE;

 private:
  /*
   * @brief removes observer
   * when occurs unsubscribe from event
   * @param observer to be removed
   */
  void remove_observer_from_vector(EventObserver& observer);

  /*
   * @brief removes observer
   * when occurs unsubscribe from event
   * @param observer to be removed
   */
  void remove_mobile_observer_from_vector(EventObserver& observer);

  DISALLOW_COPY_AND_ASSIGN(EventDispatcherImpl);

 private:
  // Members section
  sync_primitives::Lock state_lock_;
  sync_primitives::Lock mobile_state_lock_;
  sync_primitives::RecursiveLock observer_lock_;
  sync_primitives::RecursiveLock mobile_observer_lock_;
  EventObserverMap observers_event_;
  MobileEventObserverMap mobile_observers_event_;
  ObserverVector observers_;
  ObserverVector mobile_observers_;
};

}  // namespace event_engine
}  // namespace application_manager

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_EVENT_ENGINE_EVENT_DISPATCHER_IMPL_H_