twisted.internet.protocol.Protocol

Package twisted :: Package internet :: Module protocol :: Class Protocol

[show private | hide private]

Class Protocol

BaseProtocol --+
               |
              Protocol

Known Subclasses:: Banana, ScanProtocol, SSHTransportBase, Telnet, ZenTcpTest

Method Summary
	`connectionLost(self, reason)` Called when the connection is shut down.
	`dataReceived(self, data)` Called whenever data is received.
Inherited from `BaseProtocol`: `connectionMade`, `makeConnection`

Class Variable Summary
`Implements`	`__implemented__` = `<implementedBy twisted.internet.protoc...`
`ClassProvides`	`__provides__` = `<zope.interface.declarations.ClassProvide...`
Inherited from `BaseProtocol`: `__providedBy__`, `connected`, `transport`

Method Details

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

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.

Parameters:: data - a 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.

Class Variable Details

Generated by Epydoc 2.1 on Thu Aug 16 09:55:12 2007