t.i.i.IProcessProtocol(Interface) : interface documentation

Part of twisted.internet.interfaces View Source View In Hierarchy

Known implementations: twisted.internet.protocol.ProcessProtocol

Interface for process-related event handlers.

Method	makeConnection	Called when the process has been created.
Method	childDataReceived	Called when data arrives from the child process.
Method	childConnectionLost	Called when a file descriptor associated with the child process is closed.
Method	processExited	Called when the child process exits.
Method	processEnded	Called when the child process exits and all file descriptors associated with it have been closed.

def makeConnection(process): (source)

Called when the process has been created.

Parameters process An object representing the process which has been created and associated with this protocol. (type: IProcessTransport provider)

def childDataReceived(childFD, data): (source)

Called when data arrives from the child process.

Parameters	childFD	The file descriptor from which the data was received. (type: `int`)
	data	The data read from the child's file descriptor. (type: `str`)

def childConnectionLost(childFD): (source)

Called when a file descriptor associated with the child process is closed.

Parameters childFD The file descriptor which was closed. (type: int)

def processExited(reason): (source)

Called when the child process exits.

Parameters	reason	A failure giving the reason the child process terminated. The type of exception for this failure is either `twisted.internet.error.ProcessDone` or `twisted.internet.error.ProcessTerminated`. (type: `twisted.python.failure.Failure`)
Present Since	8.2

def processEnded(reason): (source)

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

Parameters reason A failure giving the reason the child process terminated. The type of exception for this failure is either twisted.internet.error.ProcessDone or twisted.internet.error.ProcessTerminated. (type: twisted.python.failure.Failure)

API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.