Source code for pcapkit.const.mh.handoff_type

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Handoff Indicator Option Type Values
==========================================

.. module:: pcapkit.const.mh.handoff_type

This module contains the constant enumeration for **Handoff Indicator Option Type Values**,
which is automatically generated from :class:`pcapkit.vendor.mh.handoff_type.HandoffType`.

"""

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




class HandoffType(EnumRegistry, IntEnum):
    """[HandoffType] Handoff Indicator Option Type Values"""

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

    #: Attachment over a new interface [:rfc:`5213`]
    Attachment_over_a_new_interface = 1

    #: Handoff between two different interfaces of the mobile node [:rfc:`5213`]
    Handoff_between_two_different_interfaces_of_the_mobile_node = 2

    #: Handoff between mobile access gateways for the same interface [:rfc:`5213`]
    Handoff_between_mobile_access_gateways_for_the_same_interface = 3

    #: Handoff state unknown [:rfc:`5213`]
    Handoff_state_unknown = 4

    #: Handoff state not changed (Re-registration) [:rfc:`5213`]
    Handoff_state_not_changed = 5

    #: Attachment over a new interface sharing prefixes [:rfc:`7864`]
    Attachment_over_a_new_interface_sharing_prefixes = 6



    @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') -> 'HandoffType':
        """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 7 <= value <= 255:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)