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
|
/*
* JsonRpc-Cpp - JSON-RPC implementation.
* Copyright (C) 2008-2012 Sebastien Vincent <sebastien.vincent@cppextrem.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \file jsonrpc_client.h
* \brief JSON-RPC client.
* \author Sebastien Vincent
*/
#ifndef JSONRPC_CLIENT_H
#define JSONRPC_CLIENT_H
#include "jsonrpc_common.h"
#include "jsonrpc_handler.h"
#include "networking.h"
namespace Json
{
namespace Rpc
{
/**
* \class Client
* \brief Abstract JSON-RPC client.
*/
class Client
{
public:
/**
* \brief Constructor.
* \param address remote network address or FQDN to contact
* \param port remote local port to contact
*/
Client(const std::string& address, uint16_t port);
/**
* \brief Destructor.
*/
virtual ~Client();
/**
* \brief Set the encapsulated format (default is RAW).
* \param format encapsulated format
*/
void SetEncapsulatedFormat(enum EncapsulatedFormat format);
/**
* \brief Get the encapsulated format.
* \return encapsulated format
*/
enum EncapsulatedFormat GetEncapsulatedFormat() const;
/**
* \brief Get socket descriptor.
* \return socket descriptor.
*/
int GetSocket() const;
/**
* \brief Get the address.
* \return address or FQDN
*/
std::string GetAddress() const;
/**
* \brief Get the port.
* \return local port
*/
uint16_t GetPort() const;
/**
* \brief Connect to the remote machine
* \return true if success, false otherwise
* \note on connectionless protocol like UDP, this function
* always returns true even if remote peer is not reachable.
*/
virtual bool Connect();
/**
* \brief Receive data from the network.
* \param data if data is received it will put in this reference
* \return number of bytes received or -1 if error
* \note This method will blocked until data comes.
*/
virtual ssize_t Recv(std::string& data) = 0;
/**
* \brief Close socket.
*/
virtual void Close();
protected:
/**
* \brief Socket descriptor.
*/
int m_sock;
/**
* \brief Transport protocol of the socket.
*/
enum networking::TransportProtocol m_protocol;
/**
* \brief Remote socket address.
*/
struct sockaddr_storage m_sockaddr;
/**
* \brief Remote socket address length.
*/
socklen_t m_sockaddrlen;
/**
* \brief Protected constructor so our inherited classes
* don't need to call the default constructor
*/
Client();
/**
* \brief Protected SetAddress so out inherited classes
* don't need to call the default constructor
*/
void SetAddress(const std::string& address);
/**
* \brief Protected SetPort so out inherited classes
* don't need to call the default constructor
*/
void SetPort(uint16_t port);
private:
/**
* \brief Copy constructor (private to avoid copy).
* \param obj object to copy
*/
Client(const Client& obj);
/**
* \brief Operator copy assignment (redefined because of "resource"
* class).
* \param obj object to copy
* \return object copied object reference
*/
Client& operator=(const Client& obj);
/**
* \brief Network address or FQDN.
*/
std::string m_address;
/**
* \brief Local port.
*/
uint16_t m_port;
/**
* \brief Encapsulated format.
*/
enum EncapsulatedFormat m_format;
};
} /* namespace Rpc */
} /* namespace Json */
#endif /* JSONRPC_CLIENT_H */
|
