twisted.internet.endpoints._WrapIProtocol

class documentation

class _WrapIProtocol(ProcessProtocol): (source)

View In Hierarchy

An IProcessProtocol provider that wraps an IProtocol.
See Also
protocol.ProcessProtocol
Method __init__ No summary
Method child​Data​Received 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 make​Connection Call IProtocol provider's makeConnection method with an ITransport provider.
Method process​Ended If the process ends with error.ProcessDone, this method calls the IProtocol provider's connectionLost with a error.ConnectionDone
Instance Variable err​Flag Undocumented
Instance Variable executable Undocumented
Instance Variable protocol Undocumented
Instance Variable transport A _ProcessEndpointTransport provider that is hooked to the wrapped IProtocol provider.

Inherited from ProcessProtocol:

Method child​Connection​Lost Called when a file descriptor associated with the child process is closed.
Method err​Connection​Lost This will be called when stderr is closed.
Method err​Received Some data was received from stderr.
Method in​Connection​Lost This will be called when stdin is closed.
Method out​Connection​Lost This will be called when stdout is closed.
Method out​Received Some data was received from stdout.
Method process​Exited This will be called when the subprocess exits.

Inherited from BaseProtocol (via ProcessProtocol):

Method connection​Made Called when a connection is made.
Instance Variable connected Undocumented
def __init__(self, proto, executable, errFlag): (source)
Parameters
protoAn IProtocol provider.
executableThe file name (full path) to spawn.
err​FlagA constant belonging to StandardErrorBehavior that determines if stderr is logged or dropped.
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 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
processAn IProcessTransport provider.
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
See Also
ProcessProtocol.processEnded
errFlag = (source)

Undocumented

executable = (source)

Undocumented

protocol = (source)

Undocumented

transport = (source)
overrides twisted.internet.protocol.BaseProtocol.transport
A _ProcessEndpointTransport provider that is hooked to the wrapped IProtocol provider.