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
|
//
// Copyright 2017 Ettus Research (National Instruments)
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_UTILS_RPC_HPP
#define INCLUDED_UTILS_RPC_HPP
#include <rpc/client.h>
#include <rpc/rpc_error.h>
#include <uhd/exception.hpp>
#include <boost/format.hpp>
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(std::string const& addr, uint16_t port) {
return std::make_shared<rpc_client>(addr, port);
}
/*!
* \param addr An IP address to connect to
* \param port Port to connect to
*/
rpc_client(std::string const& addr, uint16_t port) : _client(addr, port) {}
/*! 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) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
} 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) {
throw uhd::runtime_error(str(
boost::format("Error during RPC call to `%s'. Error message: %s")
% func_name % ex.what()
));
} 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 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)...);
};
/*! Sets the token value. This is used by the `_with_token` methods.
*/
void set_token(const std::string &token)
{
_token = token;
}
private:
std::string _token;
std::mutex _mutex;
::rpc::client _client;
};
} /* namespace uhd */
#endif /* INCLUDED_UTILS_RPC_HPP */
|
