class ProtocolWrapper(protocol.Protocol): (source)
Undocumented
| Method | __init__ |
Undocumented |
| Instance Variable | original |
Undocumented |
| Instance Variable | deferred |
Undocumented |
| Method | makeConnection |
Make a connection to a transport and a server. |
| Method | dataReceived |
Called whenever data is received. |
| Method | connectionLost |
Called when the connection is shut down. |
Inherited from Protocol:
| Class Variable | factory |
Undocumented |
| Method | logPrefix |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via Protocol):
| Instance Variable | connected |
Undocumented |
| Instance Variable | transport |
Undocumented |
| Method | connectionMade |
Called when a connection is made. |
Make a connection to a transport and a server.
This sets the 'transport' attribute of this Protocol, and calls the connectionMade() callback.
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. |
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.
| Parameters | reason | Undocumented (type: twisted.python.failure.Failure) |