twisted.internet.utils._BackRelay(protocol.ProcessProtocol) class documentation

Part of twisted.internet.utils View Source (View In Hierarchy)

Trivial protocol for communicating with a process and turning its output into the result of a Deferred.

Instance Variable deferred A Deferred which will be called back with all of stdout and, if errortoo is true, all of stderr as well (mixed together in one string). If errortoo is false and any bytes are received over stderr, this will fire with an _UnexpectedErrorOutput instance and the attribute will be set to None.
Instance Variable onProcessEnded If errortoo is false and bytes are received over stderr, this attribute will refer to a Deferred which will be called back when the process ends. This Deferred is also associated with the _UnexpectedErrorOutput which deferred fires with earlier in this case so that users can determine when the process has actually ended, in addition to knowing when bytes have been received via stderr.
Method __init__ Undocumented
Method errReceivedIsBad Undocumented
Method errReceivedIsGood Undocumented
Method outReceived Some data was received from stdout.
Method processEnded Called when the child process exits and all file descriptors associated with it have been closed.

Inherited from ProcessProtocol:

Method childDataReceived Called when data arrives from the child process.
Method errReceived Some data was received from stderr.
Method childConnectionLost Called when a file descriptor associated with the child process is closed.
Method inConnectionLost This will be called when stdin is closed.
Method outConnectionLost This will be called when stdout is closed.
Method errConnectionLost This will be called when stderr is closed.
Method processExited This will be called when the subprocess exits.

Inherited from BaseProtocol (via ProcessProtocol):

Method makeConnection Make a connection to a transport and a server.
Method connectionMade Called when a connection is made.
deferred =
A Deferred which will be called back with all of stdout and, if errortoo is true, all of stderr as well (mixed together in one string). If errortoo is false and any bytes are received over stderr, this will fire with an _UnexpectedErrorOutput instance and the attribute will be set to None.
onProcessEnded =
If errortoo is false and bytes are received over stderr, this attribute will refer to a Deferred which will be called back when the process ends. This Deferred is also associated with the _UnexpectedErrorOutput which deferred fires with earlier in this case so that users can determine when the process has actually ended, in addition to knowing when bytes have been received via stderr.
def __init__(self, deferred, errortoo=0): (source)
Undocumented
def errReceivedIsBad(self, text): (source)
Undocumented
def errReceivedIsGood(self, text): (source)
Undocumented
def outReceived(self, text): (source)
overrides twisted.internet.protocol.ProcessProtocol.outReceived

Some data was received from stdout.

def processEnded(self, reason): (source)
from twisted.internet.interfaces.IProcessProtocol
overrides twisted.internet.protocol.ProcessProtocol.processEnded

Called when the child process exits and all file descriptors associated with it have been closed.

API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.