twisted.test.proto_helpers.LineSendingProtocol(basic.LineReceiver) class documentationtwisted.test.proto_helpers
View Source
(View In Hierarchy)
| Method | __init__ | Undocumented |
| Method | connectionMade | Called when a connection is made. |
| Method | lineReceived | Override this for when each line is received. |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from LineReceiver:
| Class Variable | delimiter | The line-ending delimiter to use. By default this is b'\r\n'. |
| Class Variable | MAX_LENGTH | The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
| Method | clearLineBuffer | Clear buffered data. |
| Method | dataReceived | Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
| Method | setLineMode | Sets the line-mode of this receiver. |
| Method | setRawMode | Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
| Method | rawDataReceived | Override this for when raw data is received. |
| Method | sendLine | Sends a line to the other end of the connection. |
| Method | lineLengthExceeded | Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Inherited from Protocol (via LineReceiver):
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via LineReceiver, Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
Inherited from _PauseableMixin (via LineReceiver):
| Method | pauseProducing | Undocumented |
| Method | resumeProducing | Undocumented |
| Method | stopProducing | Undocumented |
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.
Override this for when each line is received.
| Parameters | line | The line which was received with the delimiter removed. (type: bytes) |
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.