Go to the latest version of this document.

# ``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.