← Back to branch summary

~ubuntu-branches/ubuntu/quantal/aria2/quantal

« back to all changes in this revision

Viewing changes to src/RpcMethod.h

  • Committer: Bazaar Package Importer
  • Author(s): Kartik Mistry
  • Date: 2011-04-02 12:38:55 UTC
  • mfrom: (2.5.2 sid)
  • Revision ID: james.westby@ubuntu.com-20110402123855-znkslovhf5qvkjut
Tags: 1.11.1-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/RpcMethod.h
 
1
/* <!-- copyright */
 
2
/*
 
3
 * aria2 - The high speed download utility
 
4
 *
 
5
 * Copyright (C) 2009 Tatsuhiro Tsujikawa
 
6
 *
 
7
 * This program is free software; you can redistribute it and/or modify
 
8
 * it under the terms of the GNU General Public License as published by
 
9
 * the Free Software Foundation; either version 2 of the License, or
 
10
 * (at your option) any later version.
 
11
 *
 
12
 * This program is distributed in the hope that it will be useful,
 
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
15
 * GNU General Public License for more details.
 
16
 *
 
17
 * You should have received a copy of the GNU General Public License
 
18
 * along with this program; if not, write to the Free Software
 
19
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
20
 *
 
21
 * In addition, as a special exception, the copyright holders give
 
22
 * permission to link the code of portions of this program with the
 
23
 * OpenSSL library under certain conditions as described in each
 
24
 * individual source file, and distribute linked combinations
 
25
 * including the two.
 
26
 * You must obey the GNU General Public License in all respects
 
27
 * for all of the code used other than OpenSSL.  If you modify
 
28
 * file(s) with this exception, you may extend this exception to your
 
29
 * version of the file(s), but you are not obligated to do so.  If you
 
30
 * do not wish to do so, delete this exception statement from your
 
31
 * version.  If you delete this exception statement from all source
 
32
 * files in the program, then also delete it here.
 
33
 */
 
34
/* copyright --> */
 
35
#ifndef D_RPC_METHOD_H
 
36
#define D_RPC_METHOD_H
 
37
 
 
38
#include "common.h"
 
39
 
 
40
#include <string>
 
41
 
 
42
#include "SharedHandle.h"
 
43
#include "ValueBase.h"
 
44
 
 
45
namespace aria2 {
 
46
 
 
47
class DownloadEngine;
 
48
class OptionParser;
 
49
class Option;
 
50
class Exception;
 
51
 
 
52
namespace rpc {
 
53
 
 
54
struct RpcRequest;
 
55
struct RpcResponse;
 
56
 
 
57
// This class offers abstract implementation of processing RPC
 
58
// request. You have to inherit this class and implement process()
 
59
// method to add new RPC API.
 
60
//
 
61
// There is RpcMethodFactory class which instantiates RpcMethod
 
62
// subclass. If you add new RpcMethod subclass, don't forget to add it
 
63
// to RpcMethodFactory.
 
64
class RpcMethod {
 
65
private:
 
66
  SharedHandle<OptionParser> optionParser_;
 
67
  bool jsonRpc_;
 
68
protected:
 
69
  // Subclass must implement this function to fulfil RpcRequest req.
 
70
  // The return value of this method is used as a return value of RPC
 
71
  // request.
 
72
  virtual SharedHandle<ValueBase> process
 
73
  (const RpcRequest& req, DownloadEngine* e) = 0;
 
74
 
 
75
  void gatherRequestOption
 
76
  (const SharedHandle<Option>& option, const Dict* optionsDict);
 
77
 
 
78
  void gatherChangeableOption
 
79
  (const SharedHandle<Option>& option, const Dict* optionDict);
 
80
 
 
81
  // Copy options which is changeable in RPC changeOption command to
 
82
  // dest.
 
83
  void applyChangeableOption(Option* dest, Option* src) const;
 
84
 
 
85
  void gatherChangeableGlobalOption(const SharedHandle<Option>& option,
 
86
                                    const Dict* optionDict);
 
87
 
 
88
  // Copy options which is changeable in RPC changeGlobalOption
 
89
  // command to dest.
 
90
  void applyChangeableGlobalOption(Option* dest, Option* src) const;
 
91
 
 
92
  SharedHandle<ValueBase> createErrorResponse(const Exception& e);
 
93
 
 
94
  const SharedHandle<OptionParser>& getOptionParser() const
 
95
  {
 
96
    return optionParser_;
 
97
  }
 
98
public:
 
99
  RpcMethod();
 
100
 
 
101
  virtual ~RpcMethod();
 
102
 
 
103
  // Do work to fulfill RpcRequest req and returns its result as
 
104
  // RpcResponse. This method delegates to process() method.
 
105
  RpcResponse execute(const RpcRequest& req, DownloadEngine* e);
 
106
  // Set whether JSON-RPC style parameter handling.
 
107
  void setJsonRpc(bool f)
 
108
  {
 
109
    jsonRpc_ = f;
 
110
  }
 
111
  bool getJsonRpc() const
 
112
  {
 
113
    return jsonRpc_;
 
114
  }
 
115
};
 
116
 
 
117
} // namespace rpc
 
118
 
 
119
} // namespace aria2
 
120
 
 
121
#endif // D_RPC_METHOD_H