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
|
/**
* 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_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_MESSAGE_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_MESSAGE_H_
#include <string>
#include <vector>
#include "utils/shared_ptr.h"
#include "protocol_handler/message_priority.h"
#include "smart_objects/smart_object.h"
#include "protocol_handler/rpc_type.h"
namespace smart_objects = NsSmartDeviceLink::NsSmartObjects;
namespace application_manager {
typedef std::vector<uint8_t> BinaryData;
// Message type is a general type used by both mobile and HMI messages
enum MessageType {
kUnknownType = -1,
kRequest = 0,
kResponse = 1,
kNotification = 2,
kErrorResponse = 3
};
// Map PrcType to corresponding MessageType
MessageType MessageTypeFromRpcType(protocol_handler::RpcType rpc_type);
enum ProtocolVersion {
kUnknownProtocol = -1,
kHMI = 0,
kV1 = 1,
kV2 = 2
};
class Message {
public:
Message(protocol_handler::MessagePriority priority);
Message(const Message& message);
Message& operator=(const Message& message);
bool operator==(const Message& message);
~Message();
//! --------------------------------------------------------------------------
int32_t function_id() const;
int32_t correlation_id() const;
int32_t connection_key() const;
MessageType type() const;
ProtocolVersion protocol_version() const;
const std::string& json_message() const;
const BinaryData* binary_data() const;
bool has_binary_data() const;
const smart_objects::SmartObject& smart_object() const;
//! --------------------------------------------------------------------------
void set_function_id(int32_t id);
void set_correlation_id(int32_t id);
void set_connection_key(int32_t key);
void set_message_type(MessageType type);
void set_binary_data(BinaryData* data);
void set_json_message(const std::string& json_message);
void set_protocol_version(ProtocolVersion version);
void set_smart_object(const smart_objects::SmartObject& object);
protocol_handler::MessagePriority Priority() const { return priority_; }
private:
int32_t function_id_; // @remark protocol V2.
int32_t correlation_id_; // @remark protocol V2.
MessageType type_; // @remark protocol V2.
// Pre-calculated message priority, higher priority messages are
// Processed first
protocol_handler::MessagePriority priority_;
int32_t connection_key_;
ProtocolVersion version_;
std::string json_message_;
smart_objects::SmartObject smart_object_;
// TODO(akandul): replace with shared_ptr
BinaryData* binary_data_;
};
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_MESSAGE_H_
|
