class documentation
Add a failure.
Class Variable | arguments |
Undocumented |
Class Variable | response |
Undocumented |
Inherited from Command
:
Class Method | make |
Serialize a mapping of arguments using this Command 's argument schema. |
Class Method | make |
Serialize a mapping of arguments using this Command 's response schema. |
Class Method | parse |
Parse a mapping of serialized arguments using this Command 's argument schema. |
Class Method | parse |
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 | command |
Undocumented |
Class Variable | command |
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 | errors |
A mapping of subclasses of Exception to wire-protocol tags for errors represented as str s. Responders which raise keys from this dictionary will have the error translated to the corresponding tag on the wire... |
Class Variable | extra |
Undocumented |
Class Variable | fatal |
like 'errors', but errors in this list will always terminate the connection, despite being of a recognizable error type. |
Class Variable | response |
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 | requires |
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 | _do |
Encode and send this Command to the given protocol. |