class documentation

class StreamOpen(Command): (source)

Constructor: StreamOpen(**kw)

View In Hierarchy

Open a new stream.

Class Variable response Undocumented

Inherited from Command:

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 arguments A list of 2-tuples of (name, Argument-subclass-instance), specifying the names and values of the parameters which are required for this command.
Class Variable commandName Undocumented
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 errors A mapping of subclasses of Exception to wire-protocol tags for errors represented as strs. 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 fatalErrors like 'errors', but errors in this list will always terminate the connection, despite being of a recognizable error type.
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.