twisted.web.resource.IResource

Package twisted :: Package web :: Module resource :: Class IResource

[show private | hide private]

Type IResource

Interface --+
            |
           IResource

A web resource.

Class Variable Summary
`str`	`getChildWithDefault` = `'Return a child with the given nam...`
`str`	`isLeaf` = `'Signal if this IResource implementor is a "lea...`
`str`	`putChild` = `'Put a child IResource implementor at the giv...`
`str`	`render` = `'Render a request. This is called on the leaf r...`

Class Variable Details

Type:: str
Value:: '''Return a child with the given name for the given request. This is the external interface used by the Resource publishing machinery. If implementing IResource without subclassing Resource, it must be provided. However, if subclassing Resourc\ e, getChild overridden instead. '''

Type:: str
Value:: '''Signal if this IResource implementor is a "leaf node" or not. If Tr\ ue, getChildWithDefault will not be called on this Resource.'''

Type:: str
Value:: '''Render a request. This is called on the leaf resource for a request. Render must return either a string, which will be sent to the browser as the HTML for the request, or server.NOT_DONE_YET. If NOT_DONE_YET is returned, at some point later (in a Deferred callback, usually) call request.write("<html>") to write data to the request, and request.finish() to send the data to the browser. '''

Generated by Epydoc 2.1 on Fri Jun 30 16:38:46 2006