aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/Twisted/py3/twisted/protocols/haproxy/_info.py
blob: 9dda6e06efcd1f807f76622101b4ee19ec3cbf76 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# -*- test-case-name: twisted.protocols.haproxy.test -*-
# Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.

"""
IProxyInfo implementation.
"""
from typing import Optional

from zope.interface import implementer

import attr

from twisted.internet.interfaces import IAddress
from ._interfaces import IProxyInfo


@implementer(IProxyInfo)
@attr.s(frozen=True, slots=True, auto_attribs=True)
class ProxyInfo:
    """
    A data container for parsed PROXY protocol information.

    @ivar header: The raw header bytes extracted from the connection.
    @type header: C{bytes}
    @ivar source: The connection source address.
    @type source: L{twisted.internet.interfaces.IAddress}
    @ivar destination: The connection destination address.
    @type destination: L{twisted.internet.interfaces.IAddress}
    """

    header: bytes
    source: Optional[IAddress]
    destination: Optional[IAddress]