interface documentation

class IProxyParser(zope.interface.Interface): (source)

Known implementations: twisted.protocols.haproxy._v1parser.V1Parser, twisted.protocols.haproxy._v2parser.V2Parser

View In Hierarchy

Streaming parser that handles PROXY protocol headers.

Method feed Consume a chunk of data and attempt to parse it.
Method parse Parse a bytestring as a full PROXY protocol header line.
def feed(data): (source)

Consume a chunk of data and attempt to parse it.

ParametersdataA bytestring. (type: bytes)
ReturnsA two-tuple containing, in order, an IProxyInfo and any bytes fed to the parser that followed the end of the header. Both of these values are None until a complete header is parsed.
RaisesInvalidProxyHeaderIf the bytes fed to the parser create an invalid PROXY header.
def parse(line): (source)

Parse a bytestring as a full PROXY protocol header line.

ParameterslineA bytestring that represents a valid HAProxy PROXY protocol header line. (type: bytes)
ReturnsAn IProxyInfo containing the parsed data.
RaisesInvalidProxyHeaderIf the bytestring does not represent a valid PROXY header.
API Documentation for Twisted, generated by pydoctor 21.2.0 at 2021-02-28 21:00:42.