twisted.protocols.portforward.Proxy(protocol.Protocol) class documentationtwisted.protocols.portforward
View Source
(View In Hierarchy)
Known subclasses: twisted.protocols.portforward.ProxyClient, twisted.protocols.portforward.ProxyServer
| 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. |
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. |