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`.`http`.`_XForwardedForRequest``

class documentation

`class _XForwardedForRequest(proxyForInterface(IRequest, '_request')): (source)`

View In Hierarchy

Add a layer on top of another request that only uses the value of an X-Forwarded-For header as the result of `getClientAddress`.

Method | `getClientAddress` | The client address (the first address) in the value of the X-Forwarded-For header. If the header is not present, the IP is considered to be `b"-"`.
Property | `clientproto` | The protocol version in the request.
Property | `code` | The response code for the request.
Property | `sentLength` | The number of bytes sent in the response body.

def getClientAddress(self): (source)

The client address (the first address) in the value of the X-Forwarded-For header. If the header is not present, the IP is considered to be `b"-"`.

Returns
`_XForwardedForAddress` which wraps the client address as expected by `combinedLogFormatter`.

@property
clientproto: `bytes` = (source)

The protocol version in the request.

@property
code: `int` = (source)

The response code for the request.

@property
sentLength: `int` = (source)

The number of bytes sent in the response body.