Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`web`.`twcgi`.`CGIProcessProtocol``

class documentation

`class CGIProcessProtocol(protocol.ProcessProtocol, pb.Viewable): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `connectionMade` | Called when a connection is made.
Method | `errReceived` | Some data was received from stderr.
Method | `outReceived` | Handle a chunk of input
Method | `pauseProducing` | Undocumented
Method | `processEnded` | Called when the child process exits and all file descriptors associated with it have been closed.
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | Undocumented
Method | `view_pauseProducing` | Undocumented
Method | `view_resumeProducing` | Undocumented
Method | `view_stopProducing` | Undocumented
Class Variable | `headers_written` | Undocumented
Instance Variable | `errortext` | Undocumented
Instance Variable | `handling_headers` | Undocumented
Instance Variable | `headertext` | Undocumented
Instance Variable | `request` | Undocumented
Method | `_finished` | Record the end of the response generation for the request being serviced.
Class Variable | `_log` | Undocumented
Instance Variable | `_requestFinished` | Undocumented

Inherited from `ProcessProtocol`:

Method | `childConnectionLost` | Called when a file descriptor associated with the child process is closed.
Method | `childDataReceived` | Called when data arrives from the child process.
Method | `errConnectionLost` | This will be called when stderr is closed.
Method | `inConnectionLost` | This will be called when stdin is closed.
Method | `outConnectionLost` | This will be called when stdout 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.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

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

Method | `jellyFor` | Serialize a `ViewPoint` for me and the perspective of the given broker.

Inherited from `Serializable` (via `ProcessProtocol`, `BaseProtocol`, `Viewable`):

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `ProcessProtocol`, `BaseProtocol`, `Viewable`, `Serializable`):

Method | `getStateFor` | Undocumented

def __init__(self, request): (source)

Undocumented

def connectionMade(self): (source)
overrides `twisted.internet.protocol.BaseProtocol.connectionMade`

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 errReceived(self, error): (source)
overrides `twisted.internet.protocol.ProcessProtocol.errReceived`

Some data was received from stderr.

def outReceived(self, output): (source)
overrides `twisted.internet.protocol.ProcessProtocol.outReceived`

Handle a chunk of input

def pauseProducing(self): (source)

Undocumented

def processEnded(self, reason): (source)
from `twisted.internet.interfaces.IProcessProtocol`
overrides `twisted.internet.protocol.ProcessProtocol.processEnded`

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

Parameters
reason:`twisted.python.failure.Failure` | Undocumented

def resumeProducing(self): (source)

Undocumented

def stopProducing(self): (source)

Undocumented

def view_pauseProducing(self, issuer): (source)

Undocumented

def view_resumeProducing(self, issuer): (source)

Undocumented

def view_stopProducing(self, issuer): (source)

Undocumented

headers_written: `int` = (source)

Undocumented

errortext = (source)

Undocumented

handling_headers: `int` = (source)

Undocumented

headertext = (source)

Undocumented

request = (source)

Undocumented

def _finished(self, ignored): (source)

Record the end of the response generation for the request being serviced.

_log = (source)

Undocumented

_requestFinished: `bool` = (source)

Undocumented