sipxtacklib
Version 3.3
|
A XmlRpcMethod is a dynamically loaded object that is invoked by the XmlRpcDispatch during the runtime. More...
#include <XmlRpcMethod.h>
Public Types | |
enum | ExecutionStatus { OK, FAILED, REQUIRE_AUTHENTICATION } |
typedef enum XmlRpcMethod::ExecutionStatus | ExecutionStatus |
typedef XmlRpcMethod * | Get() |
Public Member Functions | |
virtual | ~XmlRpcMethod () |
Destructor. More... | |
virtual bool | execute (const HttpRequestContext &requestContext, UtlSList ¶ms, void *userData, XmlRpcResponse &response, ExecutionStatus &status)=0 |
Execute the method. Subclasses must provide a definition for this method. More... | |
Static Public Member Functions | |
static XmlRpcMethod * | get () |
Get the instance of this method. Subclasses must provide a definition for this method. More... | |
Protected Member Functions | |
XmlRpcMethod () | |
Constructor. More... | |
A XmlRpcMethod is a dynamically loaded object that is invoked by the XmlRpcDispatch during the runtime.
This class is the abstract base from which all XML-RPC methods must inherit. Two methods must be implemented by the subclasses:
All the params in the XML-RPC request are stored in a UtlSList and passed to the service in execute(). All the param values are stored in UtlContainable types. The mapping between XML-RPC value types and UtlContainable types is:
<i8> is a SIPfoundry extension to XML-RPC that is not compatible with other XML-RPC implementations. <double> and <base64> are currently not supported.
typedef enum XmlRpcMethod::ExecutionStatus ExecutionStatus |
typedef XmlRpcMethod* Get() |
enum ExecutionStatus |
|
virtual |
Destructor.
|
protected |
Constructor.
|
static |
Get the instance of this method. Subclasses must provide a definition for this method.
|
pure virtual |
Execute the method. Subclasses must provide a definition for this method.
execution status
requestContext | request context |
params | request param list |
userData | user data |
response | request response |
Implemented in ProvisioningAgentXmlRpcAction, ProvisioningAgentXmlRpcGet, ProvisioningAgentXmlRpcSet, ProvisioningAgentXmlRpcDelete, and ProvisioningAgentXmlRpcCreate.