twisted.protocols.haproxy._v1parser.V1Parser(object)
class documentationtwisted.protocols.haproxy._v1parser
View Source
(View In Hierarchy)
Implements interfaces: ._interfaces.IProxyParser
PROXY protocol version one header parser.
Version one of the PROXY protocol is a human readable format represented by a single, newline delimited binary string that contains all of the relevant source and destination data.
Method | __init__ | Undocumented |
Method | feed | Consume a chunk of data and attempt to parse it. |
Class Method | parse | Parse a bytestring as a full PROXY protocol header line. |
Consume a chunk of data and attempt to parse it.
Parameters | data | A bytestring. (type: bytes ) |
Returns | A two-tuple containing, in order, a _interfaces.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 | InvalidProxyHeader | If the bytes fed to the parser create an invalid PROXY header. |
Parse a bytestring as a full PROXY protocol header line.
Parameters | line | A bytestring that represents a valid HAProxy PROXY protocol header line. (type: bytes) |
Returns | A _interfaces.IProxyInfo
containing the parsed data. | |
Raises | InvalidProxyHeader | If the bytestring does not represent a valid PROXY header. |
InvalidNetworkProtocol | When no protocol can be parsed or is not one of the allowed values. | |
MissingAddressData | When the protocol is TCP* but the header does not contain a complete set of addresses and ports. |