twisted.internet.protocol.Protocol

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

[show private | hide private]

Class Protocol

BaseProtocol --+
               |
              Protocol

Known Subclasses:: Proxy, Telnet, LineReceiver, SSHForwardingClient, SSHSessionProtocol, SSHSessionClient, SSHTransportBase, InsultsClient, _Protocol, IRC, TOCClient, Pynana, NetstringReceiver, Int32StringReceiver, Int16StringReceiver, DNSProtocol, DTP, SenderProtocol, ProtocolWrapper, DccSendProtocol, DccFileReceiveBasic, OscarConnection, ProtocolWrapper, SOCKSv4Outgoing, SOCKSv4Incoming, SOCKSv4, XMLParser, TOC, GetFileTransfer, SendFileTransfer, QOTD, Time, Who, Daytime, Chargen, Discard, Echo, Zodiac, MouseMan, InetdProtocol

Method Summary
	`connectionFailed(self)` (Deprecated)
	`connectionLost(self, reason)` Called when the connection is shut down.
	`connectionMade(self)` Called when a connection is made. (inherited from `BaseProtocol`)
	`dataReceived(self, data)` Called whenever data is received.
	`makeConnection(self, transport)` Make a connection to a transport and a server. (inherited from `BaseProtocol`)

Class Variable Summary
`tuple`	`__implements__`

Method Details

(Deprecated)

This used to be called when the connection was not properly established.

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

Type:

tuple

Value:

(<class twisted.internet.interfaces.IProtocol at 0x8243ddc>,)

Generated by Epydoc 1.1 on Fri Jun 27 03:48:12 2003