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
|
/*
* JsonRpc-Cpp - JSON-RPC implementation.
* Copyright (C) 2008-2011 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_server.h
* \brief JSON-RPC server.
* \author Sebastien Vincent
*/
#ifndef JSONRPC_SERVER_H
#define JSONRPC_SERVER_H
#include "jsonrpc_common.h"
#include "jsonrpc_handler.h"
#include "networking.h"
namespace Json
{
namespace Rpc
{
/**
* \class Server
* \brief Abstract JSON-RPC server.
*/
class Server
{
public:
/**
* \brief Constructor.
* \param address network address or FQDN to bind
* \param port local port to bind
*/
Server(const std::string& address, uint16_t port);
/**
* \brief Destructor.
*/
virtual ~Server();
/**
* \brief Wait message.
*
* This function do a select() on the socket and Process() immediately
* the JSON-RPC message.
* \param ms millisecond to wait (0 means infinite)
*/
virtual void WaitMessage(uint32_t ms) = 0;
/**
* \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 Bind the socket.
* \return true if success, false otherwise
*/
bool Bind();
/**
* \brief Receive data from the network and process it.
* \param fd file descriptor on which receive
* \return true if message has been correctly received, processed and
* response sent, false otherwise (mainly send/receive error)
* \note This method will blocked until data comes.
*/
virtual bool Recv(int fd) = 0;
/**
* \brief Close socket.
* \note It should be overriden for connection-oriented protocol
* like TCP to properly close all client sockets.
*/
virtual void Close();
/**
* \brief Add a RPC method.
* \param method RPC method
*/
void AddMethod(CallbackMethod* method);
/**
* \brief Delete a RPC method.
* \param method RPC method name
*/
void DeleteMethod(const std::string& method);
protected:
/**
* \brief Copy constructor (private because of "resource" class).
* \param obj object to copy
*/
Server(const Server& obj);
/**
* \brief Operator copy assignment (private because of "resource"
* class).
* \param obj object to copy
* \return copied object reference
*/
Server& operator=(const Server& obj);
/**
* \brief Socket descriptor.
*/
int m_sock;
/**
* \brief Transport protocol of the socket.
*/
enum networking::TransportProtocol m_protocol;
/**
* \brief JSON-RPC handler.
*/
Handler m_jsonHandler;
private:
/**
* \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_SERVER_H */
|
