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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/*
* Copyright (c) 2014, 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_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_MANAGER_LISTENER_H_
#define SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_MANAGER_LISTENER_H_
#include <map>
#include <vector>
#include "transport_manager/common.h"
#include "transport_manager/info.h"
#include "transport_manager/error.h"
#include "protocol/common.h"
namespace transport_manager {
class TransportManagerListener {
public:
/**
* @brief Destructor.
*/
virtual ~TransportManagerListener() {}
/**
* @brief Reaction to the event, when the list of devices is updated.
*
* @param Container that holds information about devices.
*/
virtual void OnDeviceListUpdated(const std::vector<DeviceInfo>&) = 0;
/**
* @brief Reaction to "Find new applications" request
*/
virtual void OnFindNewApplicationsRequest() = 0;
/**
* @brief Reaction to the event, when the device is found.
*
* @param device_info Variable that hold information about device.
*/
virtual void OnDeviceFound(const DeviceInfo& device_info) = 0;
virtual void OnDeviceAdded(const DeviceInfo& device_info) = 0;
virtual void OnDeviceRemoved(const DeviceInfo& device_info) = 0;
/**
* @brief OnDeviceSwitchingStart allows to notify listener that device is
* going to switch its connection.
* @param device_uid_from the id of the device which has to switch its
* transport
* @param device_uid_to the id of the device on new transport
*/
virtual void OnDeviceSwitchingStart(const DeviceUID& device_uid_from,
const DeviceUID& device_uid_to) = 0;
/**
* @brief OnDeviceSwitchingFinish notifies listener that device reconnection
* fails due to some reason.
* @param device_uid the id for the device which is fails to reconnect.
*/
virtual void OnDeviceSwitchingFinish(const DeviceUID& device_uid) = 0;
/**
* @brief Reaction to the event, when scanning of devices is finished.
*/
virtual void OnScanDevicesFinished() = 0;
/**
* @brief Reaction to the event, when scanning of devices is failed.
*
* @param error Error information about possible reason of scanning of devices
*failure.
*/
virtual void OnScanDevicesFailed(const SearchDeviceError& error) = 0;
/**
* @brief Reaction to the event, when the cloud connection status is updated.
*/
virtual void OnConnectionStatusUpdated() = 0;
/**
* @brief Reaction to the event, when connection is pending.
*
* @param devcie_info Variable that hold information about device.
* @param connection_id connection unique identifier.
*/
virtual void OnConnectionPending(const DeviceInfo& device_info,
const ConnectionUID connection_id) = 0;
/**
* @brief Reaction to the event, when connection is established.
*
* @param devcie_info Variable that hold information about device.
* @param connection_id connection unique identifier.
*/
virtual void OnConnectionEstablished(const DeviceInfo& device_info,
const ConnectionUID connection_id) = 0;
/**
* @brief Reaction to the event, when connection to the device is failed.
*
* @param device_info Variable that hold information about device.
* @param error Error information about possible reason of connect failure.
*/
virtual void OnConnectionFailed(const DeviceInfo& device_info,
const ConnectError& error) = 0;
/**
* @brief Reaction to the event, when connection is closed.
*
* @param connection_id Connection unique identifier.
*/
virtual void OnConnectionClosed(const ConnectionUID connection_id) = 0;
/**
* @brief Called when connection is closed unexpectedly, i.e. disconnect was
*not requested
*
* @param connection_id Connection ID.
* @param error Error information.
*/
virtual void OnUnexpectedDisconnect(const ConnectionUID connection_id,
const CommunicationError& error) = 0;
/**
* @brief Reaction to the event, when connection close is failed.
*
* @param connection_id Connection unique identifier.
* @param error Error information about possible reason of failure.
*/
virtual void OnConnectionClosedFailure(const ConnectionUID connection_id,
const DisconnectError& error) = 0;
/**
* \brief Inform about losing connection with device.
* \param device Handle of device.
* \param error Error information about possible reason of loosing connection.
*/
virtual void OnDeviceConnectionLost(const DeviceHandle& device,
const DisconnectDeviceError& error) = 0;
/**
* \brief Inform about failure during DisconnectDevice procedure of transport
* manager.
* \param device Handle of device.
* \param error Error information about possible reason of disconnecting
* failure.
*/
virtual void OnDisconnectFailed(const DeviceHandle& device,
const DisconnectDeviceError& error) = 0;
/**
* @brief Notifies about recieving message from TM.
*
* @param message Received message
**/
virtual void OnTMMessageReceived(
const ::protocol_handler::RawMessagePtr message) = 0;
/**
* @brief Reaction to the event, when receiving of massage for transport
*manager is failed.
*
* @param connection_id connection unique identifier.
* @param error Error information about possible reason of failure.
*/
virtual void OnTMMessageReceiveFailed(const DataReceiveError& error) = 0;
/**
* @brief Reaction to the event, when transport manager sent a massage.
*/
virtual void OnTMMessageSend(
const ::protocol_handler::RawMessagePtr message) = 0;
/**
* @brief Reaction to the event, when sending of massage by transport manager
*is failed.
*
* @param error Error information about possible reason of failure.
* @param message Smart pointer to the raw massage.
*/
virtual void OnTMMessageSendFailed(
const DataSendError& error,
const ::protocol_handler::RawMessagePtr message) = 0;
/**
* @brief Notifies that configuration of a transport has been updated.
*
* @param configs pairs of key and value that represent configuration.
*/
virtual void OnTransportConfigUpdated(
const std::map<std::string, std::string>& configs) = 0;
};
} // namespace transport_manager
#endif // SRC_COMPONENTS_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_MANAGER_LISTENER_H_
|
