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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
//
// Copyright 2017 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef INCLUDED_UTILS_RPC_HPP
#define INCLUDED_UTILS_RPC_HPP
#include <rpc/client.h>
#include <rpc/rpc_error.h>
#include <uhd/utils/log.hpp>
#include <uhd/exception.hpp>
#include <boost/format.hpp>
constexpr uint64_t DEFAULT_RPC_TIMEOUT_MS = 2000;
namespace uhd {
/*! Abstraction for RPC client
*
* Purpose of this class is to wrap the underlying RPC implementation.
* This class holds a connection to an RPC server (the connection is severed on
* destruction).
*/
class rpc_client
{
public:
using sptr = std::shared_ptr<rpc_client>;
static sptr make(
const std::string &addr,
const uint16_t port,
const uint64_t timeout_ms = DEFAULT_RPC_TIMEOUT_MS,
const std::string &get_last_error_cmd=""
) {
return std::make_shared<rpc_client>(addr, port, timeout_ms, get_last_error_cmd);
}
/*!
* \param addr An IP address to connect to
* \param port Port to connect to
* \param get_last_error_cmd A command that queries an error string from
* the RPC server. If set, the RPC client will
* try and use this command to fetch information
* about what went wrong on the client side.
*/
rpc_client(
const std::string &addr,
const uint16_t port,
const uint64_t timeout_ms = DEFAULT_RPC_TIMEOUT_MS,
std::string const &get_last_error_cmd=""
) : _client(addr, port)
, _get_last_error_cmd(get_last_error_cmd)
, _default_timeout_ms(timeout_ms)
{
_client.set_timeout(_default_timeout_ms);
// nop
}
/*! Perform an RPC request.
*
* Thread safe (locked). This function blocks until it receives a valid
* response from the server.
*
* \param func_name The function name that is called via RPC
* \param args All these arguments are passed to the RPC call
*
* \throws uhd::runtime_error in case of failure
*/
template <typename return_type, typename... Args>
return_type request(std::string const& func_name, Args&&... args)
{
std::lock_guard<std::mutex> lock(_mutex);
try {
return _client.call(func_name, std::forward<Args>(args)...)
.template as<return_type>();
} catch (const ::rpc::rpc_error &ex) {
const std::string error = _get_last_error_safe();
if (not error.empty()) {
UHD_LOG_ERROR("RPC", error);
}
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % (error.empty() ? ex.what() : error)
));
} catch (const std::bad_cast& ex) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
}
};
/*! Perform an RPC request.
*
* Thread safe (locked). This function blocks until it receives a valid
* response from the server.
*
* \param timeout_ms is time limit for this RPC call.
* \param func_name The function name that is called via RPC
* \param args All these arguments are passed to the RPC call
*
* \throws uhd::runtime_error in case of failure
*/
template <typename return_type, typename... Args>
return_type request(uint64_t timeout_ms, std::string const& func_name, Args&&... args)
{
std::lock_guard<std::mutex> lock(_mutex);
auto holder = rpcc_timeout_holder(&_client, timeout_ms, _default_timeout_ms);
try {
return _client.call(func_name, std::forward<Args>(args)...)
.template as<return_type>();
} catch (const ::rpc::rpc_error &ex) {
const std::string error = _get_last_error_safe();
if (not error.empty()) {
UHD_LOG_ERROR("RPC", error);
}
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % (error.empty() ? ex.what() : error)
));
} catch (const std::bad_cast& ex) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
}
};
/*! Perform an RPC notification.
*
* Thread safe (locked). This function does not require a response from the
* server, although the underlying implementation may provide one.
*
* \param timeout_ms is time limit for this RPC call.
* \param func_name The function name that is called via RPC
* \param args All these arguments are passed to the RPC call
*
* \throws uhd::runtime_error in case of failure
*/
template <typename... Args>
void notify(uint64_t timeout_ms, std::string const& func_name, Args&&... args)
{
std::lock_guard<std::mutex> lock(_mutex);
auto holder = rpcc_timeout_holder(&_client, timeout_ms, _default_timeout_ms);
try {
_client.call(func_name, std::forward<Args>(args)...);
} catch (const ::rpc::rpc_error &ex) {
const std::string error = _get_last_error_safe();
if (not error.empty()) {
UHD_LOG_ERROR("RPC", error);
}
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % (error.empty() ? ex.what() : error)
));
} catch (const std::bad_cast& ex) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
}
};
/*! Perform an RPC notification.
*
* Thread safe (locked). This function does not require a response from the
* server, although the underlying implementation may provide one.
*
* \param func_name The function name that is called via RPC
* \param args All these arguments are passed to the RPC call
*
* \throws uhd::runtime_error in case of failure
*/
template <typename... Args>
void notify(std::string const& func_name, Args&&... args)
{
std::lock_guard<std::mutex> lock(_mutex);
try {
_client.call(func_name, std::forward<Args>(args)...);
} catch (const ::rpc::rpc_error &ex) {
const std::string error = _get_last_error_safe();
if (not error.empty()) {
UHD_LOG_ERROR("RPC", error);
}
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % (error.empty() ? ex.what() : error)
));
} catch (const std::bad_cast& ex) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
}
};
/*! Like request(), also provides a token.
*
* This is a convenience wrapper to directly call a function that requires
* a token without having to have a copy of the token.
*/
template <typename return_type, typename... Args>
return_type request_with_token(std::string const& func_name, Args&&... args)
{
return request<return_type>(func_name, _token, std::forward<Args>(args)...);
};
/*! Like request_with_token(), but it can be specified different timeout than default.
*/
template <typename return_type, typename... Args>
return_type request_with_token(uint64_t timeout_ms, std::string const& func_name, Args&&... args)
{
return request<return_type>(timeout_ms, func_name, _token, std::forward<Args>(args)...);
};
/*! Like notify(), also provides a token.
*
* This is a convenience wrapper to directly call a function that requires
* a token without having to have a copy of the token.
*/
template <typename... Args>
void notify_with_token(std::string const& func_name, Args&&... args)
{
notify(func_name, _token, std::forward<Args>(args)...);
};
/*! Like notify_with_token() but it can be specified different timeout than default.
*/
template <typename... Args>
void notify_with_token(uint64_t timeout_ms, std::string const& func_name, Args&&... args)
{
notify(timeout_ms, func_name, _token, std::forward<Args>(args)...);
};
/*! Sets the token value. This is used by the `_with_token` methods.
*/
void set_token(const std::string &token)
{
_token = token;
}
private:
/*! This is internal object to hold timeout of the rpc client
* it is used as an RAII in code block.
*/
class rpcc_timeout_holder{
public:
rpcc_timeout_holder(::rpc::client *client,
uint64_t set_timeout,
uint64_t resume_timeout
): _rpcc(client), _save_timeout(resume_timeout)
{
_rpcc->set_timeout(set_timeout);
}
~rpcc_timeout_holder(){
_rpcc->set_timeout(_save_timeout);
}
private:
::rpc::client *_rpcc;
uint64_t _save_timeout;
};
/*! Pull the last error out of the RPC server. Not thread-safe, meant to
* be called from notify() or request().
*
* This function will do its best not to get in anyone's way. If it can't
* get an error string, it'll return an empty string.
*/
std::string _get_last_error_safe()
{
if (_get_last_error_cmd.empty()) {
return "";
}
try {
return _client.call(_get_last_error_cmd).as<std::string>();
} catch (const ::rpc::rpc_error &ex) {
// nop
} catch (const std::bad_cast& ex) {
// nop
} catch (...) {
// nop
}
return "";
}
//! Reference the actual RPC client
::rpc::client _client;
//! If set, this is the command that will retrieve an error
const std::string _get_last_error_cmd;
uint64_t _default_timeout_ms;
std::string _token;
std::mutex _mutex;
};
} /* namespace uhd */
#endif /* INCLUDED_UTILS_RPC_HPP */
|
