twisted.test.stdio_test_halfclose.HalfCloseProtocol

class documentation

class HalfCloseProtocol(protocol.Protocol): (source)

Implements interfaces: twisted.internet.interfaces.IHalfCloseableProtocol

View In Hierarchy

A protocol to hook up to stdio and observe its transport being half-closed. If all goes as expected, exitCode will be set to 0; otherwise it will be set to 1 to indicate failure.

Method connectionLost This may only be invoked after readConnectionLost. If it happens otherwise, mark it as an error and shut down.
Method connectionMade Signal the parent process that we're ready.
Method readConnectionLost This is the desired event. Once it has happened, stop the reactor so the process will exit.
Method writeConnectionLost Notification of the write connection being closed.
Instance Variable exitCode Undocumented

Inherited from Protocol:

Method dataReceived Called whenever data is received.
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 Protocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented
def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.Protocol.connectionLost

This may only be invoked after readConnectionLost. If it happens otherwise, mark it as an error and shut down.

def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

Signal the parent process that we're ready.

def readConnectionLost(self): (source)
from twisted.internet.interfaces.IHalfCloseableProtocol

This is the desired event. Once it has happened, stop the reactor so the process will exit.

def writeConnectionLost(self): (source)
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.

exitCode: int = (source)

Undocumented