class documentation

class twisted.conch.stdio.TerminalProcessProtocol(protocol.ProcessProtocol): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Instance Variable proto Undocumented
Instance Variable onConnection Undocumented
Method connectionMade Called when a connection is made.
Method write Write to the terminal.
Method outReceived Receive data from the terminal.
Method errReceived Report an error.
Method childConnectionLost Called when a file descriptor associated with the child process is closed.
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 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):

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

Undocumented

proto = (source)

Undocumented

onConnection = (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 write(self, data): (source)

Write to the terminal.

ParametersdataData to write. (type: bytes)
def outReceived(self, data): (source)

Receive data from the terminal.

ParametersdataData received. (type: bytes)
def errReceived(self, data): (source)

Report an error.

ParametersdataData to include in Failure. (type: bytes)
def childConnectionLost(self, childFD): (source)

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

ParameterschildFDThe file descriptor which was closed.
def processEnded(self, reason): (source)

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

ParametersreasonUndocumented (type: twisted.python.failure.Failure)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.