Go to the latest version of this document.

# ``twisted`.`internet`.`endpoints`.`_WrapIProtocol``

class documentation

`class _WrapIProtocol(ProcessProtocol): (source)`

Constructor: `_WrapIProtocol(proto, executable, errFlag)`

View In Hierarchy

An `IProcessProtocol` provider that wraps an `IProtocol`.

See Also
`protocol.ProcessProtocol`

Method | `__init__` | No summary
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 | `makeConnection` | Call `IProtocol` provider's makeConnection method with an `ITransport` provider.
Method | `processEnded` | If the process ends with `error.ProcessDone`, this method calls the `IProtocol` provider's `connectionLost` with a `error.ConnectionDone`
Instance Variable | `errFlag` | 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 | `childConnectionLost` | Called when a file descriptor associated with the child process is closed.
Method | `errConnectionLost` | This will be called when stderr is closed.
Method | `errReceived` | Some data was received from stderr.
Method | `inConnectionLost` | This will be called when stdin is closed.
Method | `outConnectionLost` | This will be called when stdout is closed.
Method | `outReceived` | Some data was received from stdout.
Method | `processExited` | This will be called when the subprocess exits.

Inherited from `BaseProtocol` (via `ProcessProtocol`):

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

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.

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
process | An `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.ProcessProtocol.transport`

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