REDROOM

Edit File Size: 1.85 KB

//lib/python3/dist-packages/twisted/protocols/haproxy/_interfaces.py

Text Base64

# -*- test-case-name: twisted.protocols.haproxy.test -*-
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.

"""
Interfaces used by the PROXY protocol modules.
"""
from typing import Tuple, Union

import zope.interface

class IProxyInfo(zope.interface.Interface):
    """
    Data container for PROXY protocol header data.
    """

header = zope.interface.Attribute(
        "The raw byestring that represents the PROXY protocol header.",
    )
    source = zope.interface.Attribute(
        "An L{twisted.internet.interfaces.IAddress} representing the "
        "connection source."
    )
    destination = zope.interface.Attribute(
        "An L{twisted.internet.interfaces.IAddress} representing the "
        "connection destination."
    )

class IProxyParser(zope.interface.Interface):
    """
    Streaming parser that handles PROXY protocol headers.
    """

def feed(data: bytes) -> Union[Tuple[IProxyInfo, bytes], Tuple[None, None]]:
        """
        Consume a chunk of data and attempt to parse it.

@param data: A bytestring.
        @type data: bytes

@return: A two-tuple containing, in order, an L{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.
        """

def parse(line: bytes) -> IProxyInfo:
        """
        Parse a bytestring as a full PROXY protocol header line.

@param line: A bytestring that represents a valid HAProxy PROXY
            protocol header line.
        @type line: bytes

@return: An L{IProxyInfo} containing the parsed data.

@raises InvalidProxyHeader: If the bytestring does not represent a
            valid PROXY header.
        """

Exit & Reset Text mode: syntax highlighting auto-detects file type.

Name	Size	Perms	Modified	Actions
test DIR	-	drwxr-xr-x	2026-01-08 12:56:22	Edit Download recursive recursive
__pycache__ DIR	-	drwxr-xr-x	2026-01-08 12:56:23	Edit Download recursive recursive
_exceptions.py	1.15 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_info.py	917 B	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_interfaces.py	1.85 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_parser.py	2.10 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_v1parser.py	4.39 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_v2parser.py	6.47 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
_wrapper.py	3.59 KB	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive
__init__.py	243 B	lrw-r--r--	2024-08-27 10:30:39	Edit Download recursive recursive

Directory Contents