Source code for pcapkit.const.tcp.mp_tcp_option

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Multipath TCP options
===========================

.. module:: pcapkit.const.tcp.mp_tcp_option

This module contains the constant enumeration for **Multipath TCP options**,
which is automatically generated from :class:`pcapkit.vendor.tcp.mp_tcp_option.MPTCPOption`.

"""

from typing import TYPE_CHECKING

from aenum import IntEnum

from pcapkit.corekit.enum import EnumRegistry
from pcapkit.utilities.exceptions import EnumValueError

if TYPE_CHECKING:
    from typing import Any

__all__ = ['MPTCPOption']




class MPTCPOption(EnumRegistry, IntEnum):
    """[MPTCPOption] Multipath TCP options [:rfc:`6824`]"""

    #: Multipath Capable [:rfc:`8684#section-3.1`]
    MP_CAPABLE = 0x0

    #: Join Connection [:rfc:`8684#section-3.2`]
    MP_JOIN = 0x1

    #: Data Sequence Signal (Data ACK and Data Sequence Mapping)
    #: [:rfc:`8684#section-3.3`]
    DSS = 0x2

    #: Add Address [:rfc:`8684#section-3.4.1`]
    ADD_ADDR = 0x3

    #: Remove Address [:rfc:`8684#section-3.4.2`]
    REMOVE_ADDR = 0x4

    #: Change Subflow Priority [:rfc:`8684#section-3.3.8`]
    MP_PRIO = 0x5

    #: Fallback [:rfc:`8684#section-3.7`]
    MP_FAIL = 0x6

    #: Fast Close [:rfc:`8684#section-3.5`]
    MP_FASTCLOSE = 0x7

    #: Subflow Reset [:rfc:`8684#section-3.6`]
    MP_TCPRST = 0x8

    #: [:rfc:`8684`]
    Reserved_for_Private_Use = 0xf



    @classmethod
    def _validate_value(cls, value: 'Any') -> 'None':
        """Reject ``value`` unless it passes the range check :meth:`_missing_` makes.

        Overrides :meth:`~pcapkit.corekit.enum.EnumLookup._validate_value`
        with that check and the message it raises, so
        :meth:`~pcapkit.corekit.enum.EnumRegistry.register` refuses exactly the
        values :meth:`~pcapkit.corekit.enum.EnumLookup.get` refuses, in the
        same words (:issue:`1816`).

        Args:
            value: Value about to be looked up or minted.

        Raises:
            EnumValueError: If ``value`` fails that check. A
                :exc:`ValueError`, so an ``except ValueError`` caller is
                unaffected.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




    @classmethod
    def _missing_(cls, value: 'int') -> 'MPTCPOption':
        """Lookup function used when value is not found.

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 0x9 <= value <= 0xe:
            #:
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)