SoapHandler implementation; to be registered as a request handler in the HttpServer class.
More...
#include <SoapHandler.qm.dox.h>
Inherits AbstractHttpRequestHandler.
|
| constructor (AbstractAuthenticator auth, *code n_getLogMessage, bool dbg=False) |
| creates the handler with the given method list
|
|
| addMethod (WebService ws, WSOperation op, auto func, *string help, *int logopt, auto cmark, *string path, auto err_func, *string altpath, *string binding, *string unique_id) |
| 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
|
|
bool | getDebug () |
| returns the current status of the debug flag
|
|
| removeService (string unique_id) |
| call to remove the given service
|
|
|
const | Version = "0.2.6" |
| version of the SoapHandler implementation
|
|
SoapHandler implementation; to be registered as a request handler in the HttpServer class.
◆ addMethod()
SoapHandler::SoapHandler::addMethod |
( |
WebService |
ws, |
|
|
WSOperation |
op, |
|
|
auto |
func, |
|
|
*string |
help, |
|
|
*int |
logopt, |
|
|
auto |
cmark, |
|
|
*string |
path, |
|
|
auto |
err_func, |
|
|
*string |
altpath, |
|
|
*string |
binding, |
|
|
*string |
unique_id |
|
) |
| |
adds a method to the handler dynamically
- Parameters
-
ws | the WebService object for the method |
op | the WSOperation object for the web service operation the method corresponds to |
func | a call reference, a closure, or a string function name to call with the deserialized arguments to the method; the return value will be serialized to SOAP according to the WSDL and sent back to the caller |
help | optional help text for the method |
logopt | log options which can be used by a custom logger (see the getLogMessage parameter in the constructor) |
cmark | an optional "context marker" for the method |
path | an optional path for the method (assumed to be the name of the service) |
err_func | a call reference, a closure, or a string function name to call with error information if an exception is thrown with SOAP data |
altpath | an alternate path for the service / WSDL |
binding | SOAP binding name, leave empty to use the first assigned binding |
unique_id | the unique ID for the backend service implementation for all operations on this WSDL; necessary for any removeService() call |
◆ constructor()
SoapHandler::SoapHandler::constructor |
( |
AbstractAuthenticator |
auth, |
|
|
*code |
n_getLogMessage, |
|
|
bool |
dbg = False |
|
) |
| |
creates the handler with the given method list
- Parameters
-
auth | an authentication object (use new AbstractAuthenticator() for no authentication) |
n_getLogMessage | an optional closure or call reference to be called when an incoming request is received; if this is set then it will be called with the following arguments: a context hash (see HttpServer::AbstractHttpRequestHandler::handleRequest() for a description of the context hash), the method definition as passed in the methods argument to this constructor, and a reference to the arguments in this call |
dbg | this parameter is set to True, then additional information will be logged when errors occur |
◆ removeService()
SoapHandler::SoapHandler::removeService |
( |
string |
unique_id | ) |
|
call to remove the given service
- Parameters
-
unique_id | must correspond to the unique_id in any addMethod() calls |
The documentation for this class was generated from the following file:
- doxygen/qlib/SoapHandler/SoapHandler.qm.dox.h