twisted.web2.xmlrpc.XMLRPC : API documentation

A resource that implements XML-RPC.

You probably want to connect this to '/RPC2'.

Methods published can return XML-RPC serializable results, Faults, Binary, Boolean, DateTime, Deferreds, or Handler instances.

By default methods beginning with 'xmlrpc_' are published.

Sub-handlers for prefixed methods (e.g., system.listMethods) can be added with putSubHandler. By default, prefixes are separated with a '.'. Override self.separator to change this.

Method	__init__	Undocumented
Method	putSubHandler	Undocumented
Method	getSubHandler	Undocumented
Method	getSubHandlerPrefixes	Undocumented
Method	render	No summary
Method	http_POST	Undocumented
Method	getFunction	Given a string, return a function, or raise NoSuchFunction.
Method	_cbDispatch	Undocumented
Method	_cbRender	Undocumented
Method	_ebRender	Undocumented
Method	_listFunctions	Return a list of the names of all xmlrpc methods.

Inherited from Resource:

Method	locateChild	No summary
Method	child_	This method locates a child with a trailing `"/"` in the URL. @param request: the request to process.
Method	putChild	Register a static child.
Method	http_GET	Respond to a GET request.

Inherited from RenderMixin (via Resource):

Method	allowedMethods
Method	checkPreconditions	No summary
Method	renderHTTP	See `iweb.IResource.renderHTTP`.
Method	http_OPTIONS	Respond to a OPTIONS request. @param request: the request to process. @return: an object adaptable to `iweb.IResponse`.
Method	http_TRACE	Respond to a TRACE request. @param request: the request to process. @return: an object adaptable to `iweb.IResponse`.
Method	http_HEAD	Respond to a HEAD request. @param request: the request to process. @return: an object adaptable to `iweb.IResponse`.

def render(self, request): (source)

overrides twisted.web2.resource.RenderMixin.render

Subclasses should implement this method to do page rendering. See http_GET.

Parameters	request	the request to process.
Returns	an object adaptable to `iweb.IResponse`.

def getFunction(self, functionPath): (source)

Given a string, return a function, or raise NoSuchFunction.

This returned function will be called, and should return the result of the call, a Deferred, or a Fault instance.

Override in subclasses if you want your own policy. The default policy is that given functionPath 'foo', return the method at self.xmlrpc_foo, i.e. getattr(self, "xmlrpc_" + functionPath). If functionPath contains self.separator, the sub-handler for the initial prefix is used to search for the remaining path.

t.w.x.XMLRPC(resource.Resource) : class documentation