twisted.test.process_twisted.Echo(protocol.Protocol) class documentationtwisted.test.process_twisted
(View In Hierarchy)
Implements interfaces: twisted.internet.interfaces.IHalfCloseableProtocol
| Method | connectionMade | Called when a connection is made. |
| Method | dataReceived | Called whenever data is received. |
| Method | readConnectionLost | Notification of the read connection being closed. |
| Method | writeConnectionLost | Notification of the write connection being closed. |
| Method | connectionLost | Called when the connection is shut down. |
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. |
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.
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. |
Notification of the read connection being closed.
This indicates peer did half-close of write side. It is now the responsibility of the this protocol to call loseConnection(). In addition, the protocol MUST make sure a reference to it still exists (i.e. by doing a callLater with one of its methods, etc.) as the reactor will only have a reference to it if it is writing.
If the protocol does not do so, it might get garbage collected without the connectionLost method ever being called.
Notification of the write connection being closed.
This will never be called for TCP connections as TCP does not support notification of this type of half-close.