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
|
/*
* 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_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_INCOMING_DATA_HANDLER_H_
#define SRC_COMPONENTS_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_INCOMING_DATA_HANDLER_H_
#include <list>
#include <map>
#include <vector>
#include "utils/macro.h"
#include "protocol_handler/protocol_packet.h"
#include "transport_manager/common.h"
namespace protocol_handler {
/**
* \class IncomingDataHandler
* \brief Class for contecat TM messages to ford frames and validate ford header data
* IncomingDataHandler methods are reentrant and not thread-safe
*/
class IncomingDataHandler {
public:
IncomingDataHandler();
/**
* @brief Setting additional validator for checking malformed packets
* \param validator pointer
*/
void set_validator(const ProtocolPacket::ProtocolHeaderValidator *const validator);
/**
* @brief Concatenate TM messages to ford frames and validate ford header data
* \param TM messages for converting to frames
* \param result of convertion
* \param malformed_occurrence count of malformed messages occurrence
* - RESULT_OK - no error ocures
* - RESULT_MALFORMED_OCCURS - messages concatenated,
* but malformed message occurs
* - RESULT_FAIL - packet serialization or validation error occurs
* \return list of complete, correct packets
*/
std::list<ProtocolFramePtr> ProcessData(const RawMessage &tm_message,
RESULT_CODE *result,
size_t *malformed_occurrence);
/**
* @brief Add connection for data handling and verification
*/
void AddConnection(
const transport_manager::ConnectionUID connection_id);
/**
* @brief Remove connection and all unhandled data
*/
void RemoveConnection(
const transport_manager::ConnectionUID connection_id);
private:
/**
* @brief Returns size of frame to be formed from raw bytes.
*/
static uint32_t GetPacketSize(const ProtocolPacket::ProtocolHeader &header);
/**
* @brief Try to create frame from incoming data
* \param incommung_data raw stream
* \param malformed_occurrence count of malformed messages occurrence
* \param out_frames list for read frames
*
* \return operation RESULT_CODE
* - RESULT_DEFERRED - waiting for more data
* - RESULT_OK - one or more frames successfully created
* - RESULT_FAIL - packet serialization or validation error occurs
*/
RESULT_CODE CreateFrame(std::vector<uint8_t> &incoming_data,
std::list<ProtocolFramePtr> &out_frames,
size_t &malformed_occurrence,
const transport_manager::ConnectionUID connection_id);
typedef std::map<transport_manager::ConnectionUID, std::vector<uint8_t> >
ConnectionsDataMap;
ConnectionsDataMap connections_data_;
ProtocolPacket::ProtocolHeader header_;
const ProtocolPacket::ProtocolHeaderValidator *validator_;
DISALLOW_COPY_AND_ASSIGN(IncomingDataHandler);
};
} // namespace protocol_handler
#endif // SRC_COMPONENTS_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_INCOMING_DATA_HANDLER_H_
|
