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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/**
* \file JSONRPC2Handler.hpp
* \brief JSONRPC2Handler class header.
* 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 JSONRPC2HANDLER_CLASS
#define JSONRPC2HANDLER_CLASS
#include <json/value.h>
#include "mb_controller.hpp"
#include "Logger.hpp"
#include "JSONHandler/IJSONRPC2Handler.h"
#include "JSONHandler/IRPC2CommandsObserver.h"
#include "JSONHandler/RPC2Command.h"
#include "JSONHandler/RPC2Notification.h"
#include "JSONHandler/RPC2Response.h"
#include "JSONHandler/RPC2Request.h"
#include "JSONHandler/MessageQueue.h"
/**
* \class JSONRPC2Handler
* \brief Class for handling message exchange between RPCBus and Application Manager.
* Receives RPC2 Json message from RPCBus (HMI), creates corresponding object and sends it to Application Manager.
* Receives RPC2 message object from Application manager, serializes it into Json object and sends to RPCBus (HMI).
*/
class JSONRPC2Handler : public IJSONRPC2Handler, public NsMessageBroker::CMessageBrokerController
{
public:
/**
* \brief Constructor
* \param address Address of Message Broker (RPCBus) server.
* \param port Port of Message Broker (RPCBus) server.
*/
JSONRPC2Handler( const std::string& address, uint16_t port );
/**
* \brief Destructor
*/
virtual ~JSONRPC2Handler();
/*Methods from CMessageBrokerController*/
/**
* \brief Called on receiving response message from RPCBus.
* \param method Name of corresponding request method that was sent previously to RPCBus.
* \param root Received Json object.
*/
void processResponse(std::string method, Json::Value& root);
/**
* \brief Called on receiving request message from RPCBus.
* \param root Received Json object.
*/
void processRequest(Json::Value& root);
/**
* \brief Called on receiving notification message from RPCBus.
* \param root Received Json object.
*/
void processNotification(Json::Value& root);
/**
* \brief Notifies RPCBus of the will to receive specific notifications.
*/
void subscribeToNotifications( );
/*End of ethods from CMessageBrokerController*/
/*Methods for IRPC2CommandsObserver*/
/**
* \brief Sets pointer to instance of the class implementing RPC handling (App Manager).
* \param commandsObserver Pointer to implementation of IRPC2CommandsObserver.
* \sa IRPC2CommandsObserver.
*/
void setRPC2CommandsObserver( IRPC2CommandsObserver * commandsObserver );
/**
* \brief Sends notification to RPCBus.
* \param command Json RPC2 notification to be sent to RPCBus.
*/
void sendNotification( const NsRPC2Communication::RPC2Notification * command );
/**
* \brief Sends response to RPCBus.
* \param command Json RPC2 response to be sent to RPCBus.
*/
void sendResponse( const NsRPC2Communication::RPC2Response * command );
/**
* \brief Sends request to RPCBus.
* \param command Json RPC2 request to be sent to RPCBus.
*/
void sendRequest( const NsRPC2Communication::RPC2Request * command );
/*End of methods for IRPC2CommandsObserver*/
private:
/**
* \brief Static method for handling requests & notifications from RPCBus.
* \param params Pointer to JSONRPC2Handler instance.
*/
static void * waitForCommandsFromHMI( void * params );
/**
* \brief Static method for handling responses from RPCBus.
* \param params Pointer to JSONRPC2Handler instance.
*/
static void * waitForResponsesFromHMI( void * params );
/**
* \brief Static method for handling responses to RPCBus.
* \param params Pointer to JSONRPC2Handler instance.
*/
static void * waitForResponsesToHMI( void * params );
/**
* \brief Static method for handling requests to RPCBus.
* \param params Pointer to JSONRPC2Handler instance.
*/
static void * waitForRequestsToHMI( void * params );
/**
* \brief Static method for handling notifications to RPCBus.
* \param params Pointer to JSONRPC2Handler instance.
*/
static void * waitForNotificationsToHMI( void * params );
private:
/**
*\brief For logging.
*/
static log4cplus::Logger mLogger;
/**
* \struct ResponseContainer
* \brief Used for associating request method name to corresponding response.
* TODO - not needed with latest version of code generator?
*/
struct ResponseContainer
{
/**
*\brief Request method name.
*/
std::string methodName;
/**
*\brief Response.
*/
Json::Value response;
};
/**
*\brief Points on instance of class implementing RPC handling (Application Manager).
*/
IRPC2CommandsObserver * mCommandsObserver;
/**
*\brief Queue of requests & notifications from RPCBus.
*\sa MessageQueue
*/
MessageQueue<Json::Value> mCommandsFromHMI;
/**
*\brief Thread for handling requests & notifications from HMI.
*/
pthread_t mWaitForCommandsFromHMI;
/**
*\brief Thread for handling responses from HMI.
*/
pthread_t mWaitForResponsesFromHMI;
/**
*\brief Queue of responses from HMI.
* \sa MessageQueue
*/
MessageQueue<ResponseContainer> mResponsesFromHMI;
/**
*\brief Queue of requests to HMI.
* \sa MessageQueue
*/
MessageQueue<const NsRPC2Communication::RPC2Request*> mRequestsToHMI;
/**
*\brief Queue of responses to HMI.
* \sa MessageQueue
*/
MessageQueue<const NsRPC2Communication::RPC2Response*> mResponsesToHMI;
/**
*\brief Queue of notifications to HMI.
* \sa MessageQueue
*/
MessageQueue<const NsRPC2Communication::RPC2Notification*> mNotificationsToHMI;
/**
*\brief Thread for handling requests to HMI.
*/
pthread_t mWaitForRequestsToHMI;
/**
*\brief Thread for handling responses to HMI.
*/
pthread_t mWaitForResponsesToHMI;
/**
*\brief Thread for handling notifications to HMI.
*/
pthread_t mWaitForNotificationsToHMI;
};
#endif // JSONRPC2HANDLER_CLASS
|
