twisted.protocols.haproxy._interfaces.IProxyParser

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: bytes) -> tuple[IProxyInfo, bytes] | tuple[None, None]: (source)

Consume a chunk of data and attempt to parse it.

Parameters
data:bytesA bytestring.
Returns
tuple[IProxyInfo, bytes] | tuple[None, None]A 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.
Raises
InvalidProxyHeaderIf the bytes fed to the parser create an invalid PROXY header.
def parse(line: bytes) -> IProxyInfo: (source)

Parse a bytestring as a full PROXY protocol header line.

Parameters
line:bytesA bytestring that represents a valid HAProxy PROXY protocol header line.
Returns
IProxyInfoAn IProxyInfo containing the parsed data.
Raises
InvalidProxyHeaderIf the bytestring does not represent a valid PROXY header.