t.p.s.SOCKSv4Incoming(protocol.Protocol) : class documentation

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

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

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 __init__(self, socks): (source)
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, 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.
def write(self, data): (source)
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:27:37.