class documentation

class StartStopProcessProtocol(ProcessProtocol): (source)

View In Hierarchy

An IProcessProtocol with a Deferred for events where the subprocess starts and stops.

Method __init__ Undocumented
Method connectionMade Called when a connection is made.
Method errReceived Some data was received from stderr.
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.
Instance Variable errors A str used to accumulate standard error.
Instance Variable output A str used to accumulate standard output.
Instance Variable started A Deferred which fires with this protocol's IProcessTransport provider when it is connected to one.
Instance Variable stopped A Deferred which fires with the process output or a failure if the process produces output on standard error.

Inherited from ProcessProtocol:

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

Inherited from BaseProtocol (via ProcessProtocol):

Method makeConnection Make a connection to a transport and a server.
Instance Variable connected Undocumented
def __init__(self): (source)

Undocumented

def connectionMade(self): (source)

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 errReceived(self, data): (source)

Some data was received from stderr.

def outReceived(self, data): (source)

Some data was received from stdout.

def processEnded(self, reason): (source)

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

Parameters
reason:twisted.python.failure.FailureUndocumented

A str used to accumulate standard error.

A str used to accumulate standard output.

A Deferred which fires with this protocol's IProcessTransport provider when it is connected to one.

A Deferred which fires with the process output or a failure if the process produces output on standard error.