Source code for pcapkit.const.ipx.socket

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

.. module:: pcapkit.const.ipx.socket

This module contains the constant enumeration for **Socket Types**,
which is automatically generated from :class:`pcapkit.vendor.ipx.socket.Socket`.

"""

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




class Socket(EnumRegistry, IntEnum):
    """[Socket] Socket Types"""

    #: Unspecified socket; this is IPX's own default for the dst/src socket field.
    Unspecified = 0x0000

    #: Routing Information Packet
    Routing_Information_Packet = 0x0001

    #: Echo Protocol Packet
    Echo_Protocol_Packet = 0x0002

    #: Error Handling Packet
    Error_Handling_Packet = 0x0003

    #: NetWare Core Protocol, NCP – used by Novell NetWare servers
    NetWare_Core_Protocol = 0x0451

    #: Service Advertising Protocol, SAP
    Service_Advertising_Protocol = 0x0452

    #: Routing Information Protocol, RIP
    Routing_Information_Protocol = 0x0453

    #: NetBIOS
    NetBIOS = 0x0455

    #: Diagnostic Packet
    Diagnostic_Packet = 0x0456

    #: Serialization Packet, used for NCP as well
    Serialization_Packet = 0x0457

    #: Used by Novell NetWare Client
    Used_by_Novell_NetWare_Client = 0x4003

    #: LLC [ 4 ]
    LLC_4 = 0x8060

    #: TCP over IPXF
    TCP_over_IPXF = 0x9091

    #: UDP over IPXF
    UDP_over_IPXF = 0x9092

    #: IPXF, IPX Fragmentation Protocol
    IPXF = 0x9093



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




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

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0x0000 <= value <= 0xFFFF):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 0x0020 <= value <= 0x003F:
            #: Experimental
            return cls._unregistered_member(value, 'Experimental')
        if 0x0001 <= value <= 0x0BB8:
            #: Registered by Xerox
            return cls._unregistered_member(value, 'Registered by Xerox_0x%s' % hex(value)[2:].upper().zfill(4))
        if 0x4000 <= value <= 0x4FFF:
            #: Dynamically Assigned Socket Numbers
            return cls._unregistered_member(value, 'Dynamically Assigned Socket Numbers')
        if 0x8000 <= value <= 0xFFFF:
            #: Statically Assigned Socket Numbers
            return cls._unregistered_member(value, 'Statically Assigned Socket Numbers')
        if 0x0BB9 <= value <= 0xFFFF:
            #: Dynamically Assigned
            return cls._unregistered_member(value, 'Dynamically Assigned')
        return super()._missing_(value)