class documentation

class AddErrorsCommand(BaseCommand): (source)

View In Hierarchy

This is a command which subclasses another command but adds errors to the list.

Class Variable arguments Undocumented
Class Variable errors Undocumented

Inherited from Command (via BaseCommand):

Class Method makeArguments Serialize a mapping of arguments using this Command's argument schema.
Class Method makeResponse Serialize a mapping of arguments using this Command's response schema.
Class Method parseArguments Parse a mapping of serialized arguments using this Command's argument schema.
Class Method parseResponse Parse a mapping of serialized arguments using this Command's response schema.
Class Method responder Declare a method to be a responder for a particular command.
Method __init__ Create an instance of this command with specified values for its parameters.
Class Variable commandType The type of Box used to issue commands; useful only for protocol-modifying behavior like startTLS or protocol switching. Defaults to a plain vanilla Box.
Class Variable extra Undocumented
Class Variable fatalErrors like 'errors', but errors in this list will always terminate the connection, despite being of a recognizable error type.
Class Variable response A list like arguments, but instead used for the return value.
Class Variable responseType The type of Box used to respond to this command; only useful for protocol-modifying behavior like startTLS or protocol switching. Defaults to a plain vanilla Box.
Instance Variable requiresAnswer a boolean; defaults to True. Set it to False on your subclass if you want callRemote to return None. Note: this is a hint only to the client side of the protocol. The return-type of a command responder method must always be a dictionary adhering to the contract specified by ...
Instance Variable structured Undocumented
Method _doCommand Encode and send this Command to the given protocol.