twisted.internet.endpoints._WrapIProtocol : API documentation

class documentation

class twisted.internet.endpoints._WrapIProtocol(ProcessProtocol): (source)

An IProcessProtocol provider that wraps an IProtocol.

See Also protocol.ProcessProtocol

Instance Variable	transport	A `_ProcessEndpointTransport` provider that is hooked to the wrapped `IProtocol` provider.
Method	__init__	No summary
Instance Variable	protocol	Undocumented
Instance Variable	errFlag	Undocumented
Instance Variable	executable	Undocumented
Method	makeConnection	Call `IProtocol` provider's makeConnection method with an `ITransport` provider.
Method	childDataReceived	This is called with data from the process's stdout or stderr pipes. It checks the status of the errFlag to setermine if stderr should be logged (default) or dropped.
Method	processEnded	If the process ends with `error.ProcessDone`, this method calls the `IProtocol` provider's `connectionLost` with a `error.ConnectionDone`

Inherited from ProcessProtocol:

Method	outReceived	Some data was received from stdout.
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):

Instance Variable	connected	Undocumented
Method	connectionMade	Called when a connection is made.

transport = (source)

overrides twisted.internet.protocol.BaseProtocol.transport

A _ProcessEndpointTransport provider that is hooked to the wrapped IProtocol provider.

def __init__(self, proto, executable, errFlag): (source)

Parameters	proto	An `IProtocol` provider.
	executable	The file name (full path) to spawn.
	errFlag	A constant belonging to `StandardErrorBehavior` that determines if stderr is logged or dropped.

protocol = (source)

Undocumented

errFlag = (source)

Undocumented

executable = (source)

Undocumented

def makeConnection(self, process): (source)

from twisted.internet.interfaces.IProcessProtocol

overrides twisted.internet.protocol.BaseProtocol.makeConnection

Call IProtocol provider's makeConnection method with an ITransport provider.

Parameters process An IProcessTransport provider.

def childDataReceived(self, childFD, data): (source)

from twisted.internet.interfaces.IProcessProtocol

overrides twisted.internet.protocol.ProcessProtocol.childDataReceived

This is called with data from the process's stdout or stderr pipes. It checks the status of the errFlag to setermine if stderr should be logged (default) or dropped.

def processEnded(self, reason): (source)

from twisted.internet.interfaces.IProcessProtocol

overrides twisted.internet.protocol.ProcessProtocol.processEnded

If the process ends with error.ProcessDone, this method calls the IProtocol provider's connectionLost with a error.ConnectionDone