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
|
/*
* \file threaded_socket_connection.h
* \brief Header for classes responsible for communication over sockets.
* Copyright (c) 2017, 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_THREADED_SOCKET_CONNECTION_H_
#define SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_THREADED_SOCKET_CONNECTION_H_
#include <poll.h>
#include <queue>
#include "transport_manager/transport_adapter/connection.h"
#include "protocol/common.h"
#include "utils/atomic_object.h"
#include "utils/threads/thread_delegate.h"
#include "utils/lock.h"
using ::transport_manager::transport_adapter::Connection;
class Thread;
namespace transport_manager {
namespace transport_adapter {
class TransportAdapterController;
/**
* @brief Class responsible for communication over sockets.
*/
class ThreadedSocketConnection : public Connection {
public:
/**
* @brief Send data frame.
*
* @param message Smart pointer to the raw message.
*
* @return Error Information about possible reason of sending data failure.
*/
TransportAdapter::Error SendData(::protocol_handler::RawMessagePtr message);
/**
* @brief Disconnect the current connection.
*
* @return Error Information about possible reason of Disconnect failure.
*/
TransportAdapter::Error Disconnect();
/**
* @brief Start thread creation.
*
* @return Information about possible reason of thread creation error.
*/
TransportAdapter::Error Start();
/**
* @brief Checks is queue with frames to send empty or not.
*
* @return Information about queue is empty or not.
*/
bool IsFramesToSendQueueEmpty() const;
/**
* @brief Check if connection has been terminated.
*
* @return Information which states that connection was marked as terminated.
*/
bool IsConnectionTerminated() const {
return terminate_flag_;
}
/**
* @brief Set variable that hold socket No.
*/
void set_socket(int socket) {
socket_ = socket;
}
protected:
/**
* @brief Constructor.
*
* @param device_uid Device unique identifier.
* @param app_handle Handle of application.
* @param controller Pointer to the device adapter controller.
*/
ThreadedSocketConnection(const DeviceUID& device_uid,
const ApplicationHandle& app_handle,
TransportAdapterController* controller);
/**
* @brief Destructor.
*/
virtual ~ThreadedSocketConnection();
/**
* @brief Check if we can start the connection attempt and establish
*connection status.
*
* @param error contains information of any error that occurred during
*connection attempt.
*
* @return result that states whether we successfully connected or not.
*/
virtual bool Establish(ConnectError** error) = 0;
/**
* @brief Return pointer to the device adapter controller.
*/
TransportAdapterController* controller() {
return controller_;
}
/**
* @brief Return device unique identifier.
*/
DeviceUID device_handle() const {
return device_uid_;
}
/**
* @brief Return handle of application.
*/
ApplicationHandle application_handle() const {
return app_handle_;
}
/**
* @brief Get variable that hold socket No.
*/
int get_socket() const {
return socket_;
}
/**
* @brief Checks current socket value, sends shutdown and close commands for
* this socket and clear current socket value.
*/
void ShutdownAndCloseSocket();
/**
* @brief This method will ensure that thread has finished running and then it
* will delete this thread.
*/
void StopAndJoinThread();
private:
class SocketConnectionDelegate : public threads::ThreadDelegate {
public:
explicit SocketConnectionDelegate(ThreadedSocketConnection* connection);
void threadMain() OVERRIDE;
void exitThreadMain() OVERRIDE;
private:
ThreadedSocketConnection* connection_;
};
int read_fd_;
int write_fd_;
void threadMain();
void Transmit();
void Finalize();
TransportAdapter::Error Notify() const;
bool Receive();
bool Send();
void Abort();
TransportAdapterController* controller_;
/**
* @brief Frames that must be sent to remote device.
**/
typedef std::queue<protocol_handler::RawMessagePtr> FrameQueue;
FrameQueue frames_to_send_;
mutable sync_primitives::Lock frames_to_send_mutex_;
sync_primitives::atomic_int socket_;
bool terminate_flag_;
bool unexpected_disconnect_;
const DeviceUID device_uid_;
const ApplicationHandle app_handle_;
threads::Thread* thread_;
};
} // namespace transport_adapter
} // namespace transport_manager
#endif // SRC_COMPONENTS_TRANSPORT_MANAGER_INCLUDE_TRANSPORT_MANAGER_TRANSPORT_ADAPTER_THREADED_SOCKET_CONNECTION_H_
|
