twisted.internet.test.test_endpoints.TestHalfCloseableProtocol(TestProtocol) class documentation

Part of twisted.internet.test.test_endpoints (View In Hierarchy)

Implements interfaces: twisted.internet.interfaces.IHalfCloseableProtocol

A Protocol that implements IHalfCloseableProtocol and records whether its readConnectionLost and {writeConnectionLost} methods are called.

Instance Variable readLost A bool indicating whether readConnectionLost has been called.
Instance Variable writeLost A bool indicating whether writeConnectionLost has been called.
Method __init__ Undocumented
Method readConnectionLost Notification of the read connection being closed.
Method writeConnectionLost Notification of the write connection being closed.

Inherited from TestProtocol:

Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method connectionMade Called when a connection is made.
Method dataReceived Called whenever data is received.
Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via TestProtocol, Protocol):

Method makeConnection Make a connection to a transport and a server.
readLost =
A bool indicating whether readConnectionLost has been called.
writeLost =
A bool indicating whether writeConnectionLost has been called.
def __init__(self):
overrides twisted.internet.test.test_endpoints.TestProtocol.__init__
Undocumented
def readConnectionLost(self):
from twisted.internet.interfaces.IHalfCloseableProtocol

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.

def writeConnectionLost(self):
from twisted.internet.interfaces.IHalfCloseableProtocol

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.

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.