Class t.p.s.SOCKSv4(protocol.Protocol):

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

Undocumented

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
60 Method __init__ Undocumented
63 Method connectionMade Called when a connection is made.
67 Method dataReceived Called whenever data is received.
99 Method connectionLost Called when the connection is shut down.
103 Method authorize Undocumented
107 Method connectClass Undocumented
110 Method listenClass Undocumented
114 Method makeReply Undocumented
118 Method write Undocumented
122 Method log Undocumented

Inherited from BaseProtocol (via Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.
Line # Kind Name Docs
60 Method __init__ Undocumented
103 Method authorize Undocumented
107 Method connectClass Undocumented
99 Method connectionLost Called when the connection is shut down.
63 Method connectionMade Called when a connection is made.
67 Method dataReceived Called whenever data is received.
110 Method listenClass Undocumented
122 Method log Undocumented
341 Method makeConnection Make a connection to a transport and a server.
114 Method makeReply Undocumented
118 Method write Undocumented
def __init__(self, logging=None): (source)
Undocumented
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 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 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 authorize(self, code, server, port, user): (source)
Undocumented
def connectClass(self, host, port, klass, *args): (source)
Undocumented
def listenClass(self, port, klass, *args): (source)
Undocumented
def makeReply(self, reply, version=0, port=0, ip='0.0.0.0'): (source)
Undocumented
def write(self, data): (source)
Undocumented
def log(self, proto, data): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.