80 namespace YamlRpcHandler {
94 "help" :
"shows a list of YAML-RPC methods registered with this handler",
98 (
"function":
"listMethods",
99 "help" :
"lists YAML-RPC method names registered with this handler",
100 "text" :
"system.listMethods",
103 (
"function":
"system_describe",
104 "help" :
"returns a service description object, like the one specified by the JSON-RPC 1.1 spec (even though we use YAML instead of JSON)",
105 "text" :
"system.describe",
146 constructor(AbstractAuthenticator auth, list methods, *code getLogMessage,
bool dbg = False, *
string get_prefix, *code log);
157 addMethod(
string name, code func,
string text,
string help, any logopt, any cmark);
169 static string makeResponse(any response,
int flags = YAML::None);
172 static string makeErrorResponse(
int code,
string mess, any err,
int flags = YAML::None);
177 final hash handleRequest(hash cx, hash hdr, *data body);
183 final addMethodInternal(hash h);
195 hash system_describe();
207 log(hash cx,
string str);
214 final hash callMethod(hash cx, any params);
addMethod(string name, code func, string text, string help, any logopt, any 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 ...
static string makeErrorResponse(int code, string mess, any err, int flags=YAML::None)
serializes an error reponse in YAML-RPC format given the arguments
bool getDebug()
returns the current status of the debug flag
constructor(AbstractAuthenticator auth, list methods, *code getLogMessage, bool dbg=False, *string get_prefix, *code log)
creates the handler with the given method list
static string makeResponse(any response, int flags=YAML::None)
serializes a reponse in YAML-RPC format given the arguments
const InternalMethods
internal methods of the handler (introspection)
Definition: YamlRpcHandler.qm.dox.h:92
YamlRpcHandler class definition; to be registered as a handler in the HttpServer class.
Definition: YamlRpcHandler.qm.dox.h:85
const Version
implementation of the handler
Definition: YamlRpcHandler.qm.dox.h:89