t.p.a.CommandLocator : class documentation

Part of twisted.protocols.amp View Source View In Hierarchy

Known subclasses: twisted.protocols.amp.AMP

Implements interfaces: twisted.protocols.amp.IResponderLocator

A CommandLocator is a collection of responders to AMP Commands, with the help of the Command.responder decorator.
Class __metaclass__ No summary
Method lookupFunction Deprecated synonym for locateResponder
Method locateResponder Locate a callable to invoke when executing the named command.
Method _wrapWithSerialization Wrap aCallable with its command's argument de-serialization and result serialization logic.
def _wrapWithSerialization(self, aCallable, command): (source)
Wrap aCallable with its command's argument de-serialization and result serialization logic.
ParametersaCallablea callable with a 'command' attribute, designed to be called with keyword arguments.
commandthe command class whose serialization to use.
Returnsa 1-arg callable which, when invoked with an AmpBox, will deserialize the argument list and invoke appropriate user code for the callable's command, returning a Deferred which fires with the result or fails with an error.
def lookupFunction(self, name): (source)
Deprecated synonym for locateResponder
def locateResponder(self, name): (source)
Locate a callable to invoke when executing the named command.
Parametersnamethe normalized name (from the wire) of the command.
Returnsa 1-argument function that takes a Box and returns a box or a Deferred which fires a Box, for handling the command identified by the given name, or None, if no appropriate responder can be found.
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.