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

Part of twisted.web2.xmlrpc View Source View In Hierarchy

Known subclasses: twisted.web2.xmlrpc.XMLRPCIntrospection

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 __init__(self): (source)
Undocumented
def putSubHandler(self, prefix, handler): (source)
Undocumented
def getSubHandler(self, prefix): (source)
Undocumented
def getSubHandlerPrefixes(self): (source)
Undocumented
def render(self, request): (source)
Subclasses should implement this method to do page rendering. See http_GET.
Parametersrequestthe request to process.
Returnsan object adaptable to iweb.IResponse.
def http_POST(self, request): (source)
Undocumented
def _cbDispatch(self, request, parser, unmarshaller): (source)
Undocumented
def _cbRender(self, result, request): (source)
Undocumented
def _ebRender(self, failure): (source)
Undocumented
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.
def _listFunctions(self): (source)
Return a list of the names of all xmlrpc methods.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.