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
|
/**
* \file transport_adapter_controller.h
* \brief TransportAdapterController class header file.
* Copyright (c) 2013, 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_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_TRANSPORT_ADAPTER_CONTROLLER_H_
#define SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_TRANSPORT_ADAPTER_CONTROLLER_H_
#include "transport_manager/transport_adapter/device.h"
#include "transport_manager/transport_adapter/connection.h"
namespace transport_manager {
namespace transport_adapter {
class TransportAdapterController {
public:
virtual ~TransportAdapterController() {
}
/**
* @brief Add device to the container(map), if container doesn't hold it yet.
*
* @param device Smart pointer to the device.
*
* @return Smart pointer to the device.
*/
virtual DeviceSptr AddDevice(DeviceSptr device) = 0;
/**
* @brief Search for device in container of devices, if it is not there - adds it.
*
* @param devices Container(vector) of smart pointers to devices.
*/
virtual void SearchDeviceDone(const DeviceVector& devices) = 0;
/**
* @brief Launch OnSearchDeviceFailed event in device adapter listener.
*
* @param error Error class that contains details of this error situation.
*/
virtual void SearchDeviceFailed(const SearchDeviceError& error) = 0;
/**
* @brief Find device in the internal container(map).
*
* @param device_handle Device unique identifier.
*
* @return Smart pointer to the device.
*/
virtual DeviceSptr FindDevice(const DeviceUID& device_handle) const = 0;
/**
* @brief Create connection and fill its parameters.
*
* @param connection Smart pointer to the connection.
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
*/
virtual void ConnectionCreated(ConnectionSptr connection,
const DeviceUID& device_handle,
const ApplicationHandle& app_handle) = 0;
/**
* @brief Make state of specified connection - ESTABLISHED and launch OnConnectDone event in device adapter listener.
*
* @param devcie_handle Device unique identifier.
* @param app_handle Handle of application.
*/
virtual void ConnectDone(const DeviceUID& device_handle,
const ApplicationHandle& app_handle) = 0;
/**
* @brief Delete connection from the container of connections and launch OnConnectFailed event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
*/
virtual void ConnectFailed(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
const ConnectError& error) = 0;
/**
* @brief Make state of specified connection - FINILIZING.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
*/
virtual void ConnectionFinished(const DeviceUID& device_handle,
const ApplicationHandle& app_handle) = 0;
/**
* @brief Set specified connection state to FINILIZING and launch OnUnexpectedDisconnect event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
* @param error Error class that contains details of this error situation.
*/
virtual void ConnectionAborted(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
const CommunicationError& error) = 0;
/**
* @brief Delete specified connection from the container(map) of connections and launch event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
*/
virtual void DisconnectDone(const DeviceUID& device_handle,
const ApplicationHandle& app_handle) = 0;
/**
* @brief Launch OnDataReceiveDone event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
* @param message Smart pointer to the raw message.
*/
virtual void DataReceiveDone(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
RawMessageSptr message) = 0;
/**
* @brief Launch OnDataReceiveFailed event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
* @param error Class that contains details of this error situation.
*/
virtual void DataReceiveFailed(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
const DataReceiveError&) = 0;
/**
* @brief Launch OnDataSendDone event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
* @param message Smart pointer to raw message.
*/
virtual void DataSendDone(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
RawMessageSptr message) = 0;
/**
* @brief Launch OnDataSendFailed event in the device adapter listener.
*
* @param device_handle Device unique identifier.
* @param app_handle Handle of application.
* @param message Smart pointer to raw message.
* @param error Class that contains details of this error situation.
*/
virtual void DataSendFailed(const DeviceUID& device_handle,
const ApplicationHandle& app_handle,
RawMessageSptr message, const DataSendError&) = 0;
};
} // namespace transport_adapter
} // namespace transport_manager
#endif /* transport_adapter_CONTROLLER_H_ */
|
