Qore JsonRpcHandler Module Reference  1.3
JsonRpcHandler.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* JsonRpcHandler.qm Copyright (C) 2012 - 2018 Qore Technologies, s.r.o.
5 
6  Permission is hereby granted, free of charge, to any person obtaining a
7  copy of this software and associated documentation files (the "Software"),
8  to deal in the Software without restriction, including without limitation
9  the rights to use, copy, modify, merge, publish, distribute, sublicense,
10  and/or sell copies of the Software, and to permit persons to whom the
11  Software is furnished to do so, subject to the following conditions:
12 
13  The above copyright notice and this permission notice shall be included in
14  all copies or substantial portions of the Software.
15 
16  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22  DEALINGS IN THE SOFTWARE.
23 */
24 
25 // minimum qore version
26 
27 // requires the binary json module
28 
29 // need mime definitions
30 
31 // need Util functions
32 
33 // need HttpServerUtil definitions
34 
35 // don't use "$" for vars, members, and method calls, assume local var scope
36 
37 
96 namespace JsonRpcHandler {
98 
100 class JsonRpcHandler : public AbstractHttpRequestHandler {
101 
102 public:
104  const Version = "1.3";
105 
107  const InternalMethods = ...;
108 
109 
111  const JRE_ParseError = -32700;
112 
114  const JRE_InvalidRequest = -32600;
115 
117  const JRE_MethodNotFound = -32601;
118 
120  const JRE_InvalidParams = -32602;
121 
123  const JRE_InternalError = -32603;
124 
126 private:
127  list methods = ();
128  hash mi;
129  int loglevel;
130 
131  // if True then verbose exception info will be logged
132  bool debug;
133 
134  // prefix to add to derived methods with GET requests if no "." characters are in the path
135  *string get_prefix;
136 
137  // a closure/call reference to get the log message and/or process arguments in incoming requests
138  *code getLogMessage;
139 
140  // a closure/call reference for logging (when set this is used instead of the HTTP server's logfunc for logging)
141  *code log_code;
142 
143 public:
145 
147 
162  constructor(HttpServer::AbstractAuthenticator n_auth, list<auto> n_methods, *code n_getLogMessage, bool n_dbg = False, *string n_get_prefix, *code n_log) ;
163 
164 
166 
173  addMethod(string name, code func, string text, string help, auto logopt, auto cmark);
174 
175 
177  setDebug(bool dbg = True);
178 
179 
181  bool getDebug();
182 
183 
185  // don't reimplement this method; fix/enhance it in the module
186 protected:
187  final addMethodInternal(hash<auto> h);
188 public:
189 
190 
191 protected:
192  hash<auto> help();
193 public:
194 
195 
196 protected:
197  hash systemDescribe();
198 public:
199 
200 
201 protected:
202  softlist<string> listMethods();
203 public:
204 
205 
206 protected:
207  log(hash<auto> cx, string str);
208 public:
209 
210 
211  // don't reimplement this method; fix/enhance it in the module
212 protected:
213  final hash callMethod(hash<auto> cx, auto params);
214 public:
215 
216 
217  // method called by HttpServer to handle a request
218  // don't reimplement this method; fix/enhance it in the module
219  final hash<auto> handleRequest(hash<auto> cx, hash<auto> hdr, *data body);
220 
221 
222 protected:
223  hash<auto> processBatchMessage(hash<auto> cx, list<auto> l);
224 public:
225 
226  };
227 };
final addMethodInternal(hash< auto > h)
@conf nodoc
bool getDebug()
returns the current status of the debug flag
constructor(HttpServer::AbstractAuthenticator n_auth, list< auto > n_methods, *code n_getLogMessage, bool n_dbg=False, *string n_get_prefix, *code n_log)
creates the handler with the given method list
addMethod(string name, code func, string text, string help, auto logopt, auto cmark)
adds a method to the handler dynamically
setDebug(bool dbg=True)
turns on or off debugging; when debugging is enabled more verbose error messages are reported
the JsonRpcHandler namespace holds all public definitions in the JsonRpcHandler module
Definition: JsonRpcHandler.qm.dox.h:96