Source code for pcapkit.const.hip.packet

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""HIP Packet Types
======================

.. module:: pcapkit.const.hip.packet

This module contains the constant enumeration for **HIP Packet Types**,
which is automatically generated from :class:`pcapkit.vendor.hip.packet.Packet`.

"""

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__ = ['Packet']




class Packet(EnumRegistry, IntEnum):
    """[Packet] HIP Packet Types"""

    #: Reserved [:rfc:`7401`]
    Reserved_0 = 0

    #: I1 the HIP Initiator Packet [:rfc:`7401`]
    I1 = 1

    #: R1 the HIP Responder Packet [:rfc:`7401`]
    R1 = 2

    #: I2 the Second HIP Initiator Packet [:rfc:`7401`]
    I2 = 3

    #: R2 the Second HIP Responder Packet [:rfc:`7401`]
    R2 = 4

    #: UPDATE the HIP Update Packet [:rfc:`7401`]
    UPDATE = 16

    #: NOTIFY the HIP Notify Packet [:rfc:`7401`]
    NOTIFY = 17

    #: CLOSE the HIP Association Closing Packet [:rfc:`7401`]
    CLOSE = 18

    #: CLOSE_ACK the HIP Closing Acknowledgment Packet [:rfc:`7401`]
    CLOSE_ACK = 19

    #: HDRR (HIP Distributed Hash Table Resource Record) [:rfc:`6537`]
    HDRR = 20

    #: HIP_DATA [:rfc:`6078`]
    HIP_DATA = 32



    @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 <= 127):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




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

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 127):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 5 <= value <= 15:
            # Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 21 <= value <= 31:
            # Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        if 33 <= value <= 127:
            # Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)