twisted.protocols.basic.LineOnlyReceiver(protocol.Protocol) class documentationtwisted.protocols.basic
View Source
(View In Hierarchy)
Known subclasses: twisted.mail.pop3.AdvancedPOP3Client, twisted.mail.pop3.POP3, twisted.mail.pop3.POP3Client, twisted.mail.smtp.SMTP, twisted.protocols.ident.IdentClient, twisted.protocols.ident.IdentServer
A protocol that receives only lines.
This is purely a speed optimisation over LineReceiver, for the cases that raw mode is known to be unnecessary.
| 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 | dataReceived | Translates bytes into lines, and calls lineReceived. |
| Method | lineReceived | Override this for when each line 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:
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
| Method | connectionMade | Called when a connection is made. |
Override this for when each line is received.
| Parameters | line | The line which was received with the delimiter removed. (type: bytes) |
Sends a line to the other end of the connection.
| Parameters | line | The line to send, not including the delimiter. (type: bytes) |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.