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
|
/* <!-- copyright */
/*
* aria2 - The high speed download utility
*
* Copyright (C) 2009 Tatsuhiro Tsujikawa
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*
* In addition, as a special exception, the copyright holders give
* permission to link the code of portions of this program with the
* OpenSSL library under certain conditions as described in each
* individual source file, and distribute linked combinations
* including the two.
* You must obey the GNU General Public License in all respects
* for all of the code used other than OpenSSL. If you modify
* file(s) with this exception, you may extend this exception to your
* version of the file(s), but you are not obligated to do so. If you
* do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source
* files in the program, then also delete it here.
*/
/* copyright --> */
#ifndef D_RPC_METHOD_H
#define D_RPC_METHOD_H
#include "common.h"
#include <string>
#include <memory>
#include "ValueBase.h"
namespace aria2 {
class DownloadEngine;
class OptionParser;
class Option;
class Exception;
namespace rpc {
struct RpcRequest;
struct RpcResponse;
// This class offers abstract implementation of processing RPC
// request. You have to inherit this class and implement process()
// method to add new RPC API. The derived class must be stateless
// since we reuse the instances.
//
// There is RpcMethodFactory class which instantiates RpcMethod
// subclass. If you add new RpcMethod subclass, don't forget to add it
// to RpcMethodFactory.
class RpcMethod {
private:
std::shared_ptr<OptionParser> optionParser_;
protected:
// Subclass must implement this function to fulfil RpcRequest req.
// The return value of this method is used as a return value of RPC
// request.
virtual std::unique_ptr<ValueBase> process
(const RpcRequest& req, DownloadEngine* e) = 0;
void gatherRequestOption(Option* option, const Dict* optionsDict);
void gatherChangeableOption(Option* option, const Dict* optionDict);
void gatherChangeableOptionForReserved
(Option* option, const Dict* optionsDict);
void gatherChangeableGlobalOption(Option* option, const Dict* optionDict);
std::unique_ptr<ValueBase> createErrorResponse
(const Exception& e, const RpcRequest& req);
const std::shared_ptr<OptionParser>& getOptionParser() const
{
return optionParser_;
}
public:
RpcMethod();
virtual ~RpcMethod();
virtual void authorize(RpcRequest& req, DownloadEngine* e);
// Do work to fulfill RpcRequest req and returns its result as
// RpcResponse. This method delegates to process() method.
RpcResponse execute(RpcRequest req, DownloadEngine* e);
};
} // namespace rpc
} // namespace aria2
#endif // D_RPC_METHOD_H
|
