t.c.s.s._ProtocolWrapper(protocol.ProcessProtocol) : class documentation

Part of twisted.conch.ssh.session View Source View In Hierarchy

This class wraps a Protocol instance in a ProcessProtocol instance.
Method __init__ Undocumented
Method connectionMade Called when a connection is made.
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.
def __init__(self, proto): (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 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.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.