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`.`proxy`.`ProxyClient``

class documentation

`class ProxyClient(HTTPClient): (source)`

View In Hierarchy

Used by ProxyClientFactory to implement a simple web proxy.

Method | `__init__` | Undocumented
Method | `connectionMade` | Called when a connection is made.
Method | `handleHeader` | Called every time a header is received.
Method | `handleResponseEnd` | Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.
Method | `handleResponsePart` | Undocumented
Method | `handleStatus` | Called when the status-line is received.
Instance Variable | `command` | Undocumented
Instance Variable | `data` | Undocumented
Instance Variable | `father` | Undocumented
Instance Variable | `headers` | Undocumented
Instance Variable | `rest` | Undocumented
Instance Variable | `_finished` | A flag which indicates whether or not the original request has been finished yet.

Inherited from `HTTPClient`:

Method | `connectionLost` | Called when the connection is shut down.
Method | `endHeaders` | Undocumented
Method | `extractHeader` | Given a complete HTTP header, extract the field name and value and process the header.
Method | `handleEndHeaders` | Called when all headers have been received.
Method | `lineReceived` | Parse the status line and headers for an HTTP request.
Method | `rawDataReceived` | Override this for when raw data is received.
Method | `sendCommand` | Undocumented
Method | `sendHeader` | Undocumented
Instance Variable | `firstLine` | Are we waiting for the first header line?
Instance Variable | `length` | The length of the request body in bytes.
Instance Variable | `__buffer` | The buffer that stores the response to the HTTP request.
Instance Variable | `_header` | Part or all of an HTTP request header.

Inherited from `LineReceiver` (via `HTTPClient`):

Method | `clearLineBuffer` | Clear buffered data.
Method | `dataReceived` | Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method | `lineLengthExceeded` | Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method | `sendLine` | Sends a line to the other end of the connection.
Method | `setLineMode` | Sets the line-mode of this receiver.
Method | `setRawMode` | Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Constant | `MAX_LENGTH` | The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Class Variable | `delimiter` | The line-ending delimiter to use. By default this is `b'\r\n'`.
Instance Variable | `line_mode` | Undocumented
Instance Variable | `_buffer` | Undocumented
Instance Variable | `_busyReceiving` | Undocumented

Inherited from `Protocol` (via `HTTPClient`, `LineReceiver`):

Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

Inherited from `BaseProtocol` (via `HTTPClient`, `LineReceiver`, `Protocol`):

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

Inherited from `_PauseableMixin` (via `HTTPClient`, `LineReceiver`, `Protocol`, `BaseProtocol`):

Method | `pauseProducing` | Undocumented
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | Undocumented
Instance Variable | `paused` | Undocumented

def __init__(self, command, rest, version, headers, data, father): (source)

Undocumented

def connectionMade(self): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.web.http.HTTPClient.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 handleHeader(self, key, value): (source)
overrides `twisted.web.http.HTTPClient.handleHeader`

Called every time a header is received.

def handleResponseEnd(self): (source)
overrides `twisted.web.http.HTTPClient.handleResponseEnd`

Finish the original request, indicating that the response has been completely written to it, and disconnect the outgoing transport.

def handleResponsePart(self, buffer): (source)
overrides `twisted.web.http.HTTPClient.handleResponsePart`

Undocumented

def handleStatus(self, version, code, message): (source)
overrides `twisted.web.http.HTTPClient.handleStatus`

Called when the status-line is received.

Parameters
version | e.g. 'HTTP/1.0'
code | Undocumented
message | e.g. 'OK'
status:`bytes` | e.g. '200'

command = (source)

Undocumented

data = (source)

Undocumented

father = (source)

Undocumented

headers = (source)

Undocumented

rest = (source)

Undocumented

_finished: `bool` = (source)

A flag which indicates whether or not the original request has been finished yet.