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
|
/**
* \file SmartDeviceLinkRawMessage.h
* \brief SmartDeviceLinkRawMessage 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_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_RAW_MESSAGE_H_
#define SRC_COMPONENTS_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_RAW_MESSAGE_H_
#include "utils/macro.h"
#include "utils/shared_ptr.h"
#include "protocol_handler/service_type.h"
#include "protocol_handler/message_priority.h"
/**
*\namespace NsProtocolHandler
*\brief Namespace for SmartDeviceLink ProtocolHandler related functionality.
*/
namespace protocol_handler {
/**
* \class SmartDeviceLinkRawMessage
* \brief Class-wraper for information about message for interchanging
* between components.
*/
class RawMessage {
public:
/**
* \brief Constructor
* \param connectionKey Identifier of connection within wich message
* is transferred
* \param protocolVersion Version of protocol of the message
* \param data Message string
* \param dataSize Message size
*/
RawMessage(int32_t connectionKey, uint32_t protocolVersion,
uint8_t* data_param, uint32_t dataSize,
uint8_t type = ServiceType::kRpc);
/**
* \brief Destructor
*/
~RawMessage();
/**
* \brief Getter for connection identifier
*/
int32_t connection_key() const;
void set_connection_key(uint32_t);
/**
* \brief Getter for message string
*/
uint8_t* data() const;
/**
* \brief Getter for message size
*/
uint32_t data_size() const;
/**
* \brief Getter for protocol version
*/
uint32_t protocol_version() const;
/**
* \brief Getter for service type
*/
ServiceType service_type() const {
return service_type_;
}
bool IsWaiting() const;
void set_waiting(bool v);
/*
* \brief Priority of this message based on it's service type
*/
MessagePriority Priority() const;
private:
/**
* \brief Connection Identifier
* Obtained from \saCconnection_handler
*/
int32_t connection_key_;
/**
* \brief Message string
*/
uint8_t* data_;
/**
* \brief Size of message
*/
uint32_t data_size_;
/**
* \brief Version of SmartDeviceLink protocol (currently 1,2)
* used for tranferring message.
*/
uint32_t protocol_version_;
/**
* \brief Type of service message belongs to
*/
ServiceType service_type_;
/**
* specifies current state of message in queue. if false message is "ready to be processed"
* otherwise it is "waiting for response"
*
*/
bool waiting_;
/**
* \brief Specifies if this is binary data
* (used by ProtocolObserver).
*/
bool fully_binary_;
/**
* \brief Id of connection (for service messages like start/end session)
*
*/
DISALLOW_COPY_AND_ASSIGN(RawMessage);
};
typedef utils::SharedPtr<RawMessage> RawMessagePtr;
} // namespace protocol_handler
#endif // SRC_COMPONENTS_PROTOCOL_HANDLER_INCLUDE_PROTOCOL_HANDLER_RAW_MESSAGE_H_
|
