t.c.i.i.ClientProtocol(protocol.Protocol) : class documentation

Part of twisted.conch.insults.insults View Source View In Hierarchy

No class docstring
Method __init__ No summary
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method dataReceived Called whenever data is received.
Class ControlSequenceParser Undocumented
Method _handleControlSequence Undocumented
Method _handleHeightWidth Undocumented

Inherited from BaseProtocol (via Protocol):

Method makeConnection Make a connection to a transport and a server.
def __init__(self, *a, terminalFactory=None, **kw): (source)
ParametersterminalFactoryA callable which will be invoked with *a, **kw and should return an ITerminalTransport provider. This will be invoked when this ClientProtocol establishes a connection.
aAny positional arguments to pass to terminalFactory.
kwAny keyword arguments to pass to terminalFactory.
def connectionMade(self): (source)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.
Parametersreason (type: twisted.python.failure.Failure )
def dataReceived(self, bytes): (source)

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.
Parametersdataa string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.
def _handleControlSequence(self, buf, terminal): (source)
def _handleHeightWidth(self, b): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.