t.p.p.Proxy(protocol.Protocol) : class documentation

Part of twisted.protocols.portforward View Source View In Hierarchy

Known subclasses: twisted.protocols.portforward.ProxyClient, twisted.protocols.portforward.ProxyServer

Undocumented
Method setPeer Undocumented
Method connectionLost Called when the connection is shut down.
Method dataReceived Called whenever data is received.

Inherited from Protocol:

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via Protocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
def setPeer(self, peer): (source)
Undocumented
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.

def dataReceived(self, data): (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.
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.