Qore YamlRpcHandler Module Reference  1.4
YamlRpcHandler.qm.dox.h
1 // -*- mode: c++; indent-tabs-mode: nil -*-
3 
4 /* YamlRpcHandler.qm Copyright (C) 2012 - 2019 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 yaml module
28 
29 // need mime definitions
30 
31 // need Util module
32 
33 // need HttpServerUtil module at a minimum in this module
34 
35 // do not use $ signs in declarations
36 
37 
101 namespace YamlRpcHandler {
103 
105 class YamlRpcHandler : public AbstractHttpRequestHandler {
106 
107 public:
109  const Version = "1.0";
110 
112  const InternalMethods = ...;
113 
114 
116 protected:
117  list methods = ();
118  hash mi;
119  int loglevel;
120 
121  // if True then verbose exception info will be logged
122  bool debug;
123 
124  // prefix to add to derived methods with GET requests if no "." characters are in the path
125  *string get_prefix;
126 
127  // a closure/call reference to get the log message and/or process arguments in incoming requests
128  *code getLogMessage;
129 
130  // a closure/call reference for logging (when set this is used instead of the HTTP server's logfunc for logging)
131  *code clog;
132 
133 public:
135 
137 
151  constructor(HttpServer::AbstractAuthenticator v_auth, list v_methods, *code v_get_log_msg, bool v_dbg = False, *string v_get_prefix, *code v_log) ;
152 
153 
155 
162  addMethod(string name, code func, string text, string help, auto logopt, auto cmark);
163 
164 
166  setDebug(bool dbg = True);
167 
168 
170  bool getDebug();
171 
172 
174  static string makeResponse(auto response, int flags = YAML::None);
175 
177  static string makeErrorResponse(int code, string mess, auto err, int flags = YAML::None);
178 
180  // method called by HttpServer to handle a request
181  // don't reimplement this method; fix/enhance it in the module
182  final hash handleRequest(hash cx, hash hdr, *data body);
183 
184 
185  // don't reimplement this method; fix/enhance it in the module
186 protected:
187  final addMethodInternal(hash h);
188 public:
189 
190 
191 protected:
192  hash help();
193 public:
194 
195 
196 protected:
197  hash system_describe();
198 public:
199 
200 
201 protected:
202  softlist<string> listMethods();
203 public:
204 
205 
206 protected:
207  log(hash 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 cx, auto params);
214 public:
215 
217  };
218 };
addMethod(string name, code func, string text, string help, auto logopt, auto cmark)
adds a method to the handler dynamically
bool getDebug()
returns the current status of the debug flag
setDebug(bool dbg=True)
turns on or off debugging; when debugging is enabled more verbose error messages are reported
static string makeErrorResponse(int code, string mess, auto err, int flags=YAML::None)
serializes an error reponse in YAML-RPC format given the arguments
constructor(HttpServer::AbstractAuthenticator v_auth, list v_methods, *code v_get_log_msg, bool v_dbg=False, *string v_get_prefix, *code v_log)
creates the handler with the given method list
static string makeResponse(auto response, int flags=YAML::None)
serializes a reponse in YAML-RPC format given the arguments
the YamlRpcHandler namespace holds all public definitions in the YamlRpcHandler module
Definition: YamlRpcHandler.qm.dox.h:101