twisted.internet.interfaces.IProcessTransport : API documentation

interface documentation

class twisted.internet.interfaces.IProcessTransport(ITransport): (source)

A process transport.

Attribute	pid	From before `IProcessProtocol.makeConnection` is called to before `IProcessProtocol.processEnded` is called, `pid` is an `int` giving the platform process ID of this process. `pid` is `None` at all other times.
Method	closeStdin	Close stdin after all data has been written out.
Method	closeStdout	Close stdout.
Method	closeStderr	Close stderr.
Method	closeChildFD	Close a file descriptor which is connected to the child process, identified by its FD in the child process.
Method	writeToChild	Similar to `ITransport.write` but also allows the file descriptor in the child process which will receive the bytes to be specified.
Method	loseConnection	Close stdin, stderr and stdout.
Method	signalProcess	Send a signal to the process.

Inherited from ITransport:

Method	write	Write some data to the physical connection, in sequence, in a non-blocking fashion.
Method	writeSequence	Write an iterable of byte strings to the physical connection.
Method	getPeer	Get the remote address of this connection.
Method	getHost	Similar to getPeer, but returns an address describing this side of the connection.

From before IProcessProtocol.makeConnection is called to before IProcessProtocol.processEnded is called, pid is an int giving the platform process ID of this process. pid is None at all other times.

def closeStdin(): (source)

Close stdin after all data has been written out.

def closeStdout(): (source)

Close stdout.

def closeStderr(): (source)

Close stderr.

def closeChildFD(descriptor): (source)

Close a file descriptor which is connected to the child process, identified by its FD in the child process.

Parameters descriptor Undocumented (type: int)

def writeToChild(childFD, data): (source)

Similar to ITransport.write but also allows the file descriptor in the child process which will receive the bytes to be specified.

Parameters	childFD	The file descriptor to which to write. (type: `int`)
	data	The bytes to write. (type: `bytes`)
Raises	KeyError	If `childFD` is not a file descriptor that was mapped in the child when `IReactorProcess.spawnProcess` was used to create it.

def loseConnection(): (source)

Close stdin, stderr and stdout.

def signalProcess(signalID): (source)

Send a signal to the process.

Parameters	signalID	can be one of `"KILL"`, `"TERM"`, or `"INT"`. These will be implemented in a cross-platform manner, and so should be used if possible. an integer, where it represents a POSIX signal ID. (type: `Union[str, int]`)
Raises	twisted.internet.error.ProcessExitedAlready	If the process has already exited.
	OSError	If the `os.kill` call fails with an errno different from `ESRCH`.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.