twisted.test.test_ssl.LineCollector

class documentation

class LineCollector(basic.LineReceiver): (source)

View In Hierarchy

Method __init__ Undocumented
Method connectionLost Called when the connection is shut down.
Method connectionMade Called when a connection is made.
Method lineReceived Override this for when each line is received.
Method rawDataReceived Override this for when raw data is received.
Instance Variable deferred a deferred that will fire at connection lost.
Instance Variable doTLS whether the protocol is initiate TLS or not.
Instance Variable fillBuffer if set to True, it will send lots of data once STARTTLS is received.

Inherited from LineReceiver:

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method sendLine Sends a line to the other end of the connection.
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.
Constant 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.
Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Instance Variable line_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via LineReceiver):

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable factory Undocumented

Inherited from BaseProtocol (via LineReceiver, Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via LineReceiver, Protocol, BaseProtocol):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented
def __init__(self, doTLS, fillBuffer=False): (source)

Undocumented

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

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:twisted.python.failure.FailureUndocumented
def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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.

def lineReceived(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters
line:bytesThe line which was received with the delimiter removed.
def rawDataReceived(self, data): (source)
overrides twisted.protocols.basic.LineReceiver.rawDataReceived

Override this for when raw data is received.

deferred: defer.Deferred = (source)

a deferred that will fire at connection lost.

doTLS: bool = (source)

whether the protocol is initiate TLS or not.

fillBuffer: bool = (source)

if set to True, it will send lots of data once STARTTLS is received.