pypcapkit 1.3.5.post6__cp313-none-any.whl

pcapkit/const/mh/handover_ack_status.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Handover Acknowledge Status Codes
+=======================================
+
+.. module:: pcapkit.const.mh.handover_ack_status
+
+This module contains the constant enumeration for **Handover Acknowledge Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.handover_ack_status.HandoverACKStatus`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['HandoverACKStatus']
+
+
+class HandoverACKStatus(IntEnum):
+    """[HandoverACKStatus] Handover Acknowledge Status Codes"""
+
+    #: Handover Accepted or Successful (when 'P' flag is set) [:rfc:`5949`]
+    Handover_Accepted_or_Successful = 0
+
+    #: Handover Accepted with NCoA valid [:rfc:`5568`]
+    Handover_Accepted_with_NCoA_valid = 0
+
+    #: Handover Accepted, NCoA not valid [:rfc:`5568`]
+    Handover_Accepted_NCoA_not_valid = 1
+
+    #: Handover Accepted, NCoA assigned [:rfc:`5568`]
+    Handover_Accepted_NCoA_assigned = 2
+
+    #: Handover Accepted, use PCoA [:rfc:`5568`]
+    Handover_Accepted_use_PCoA = 3
+
+    #: Message sent unsolicited [:rfc:`5568`]
+    Message_sent_unsolicited = 4
+
+    #: Context Transfer Accepted or Successful [:rfc:`5949`]
+    Context_Transfer_Accepted_or_Successful = 5
+
+    #: All available Context Transferred [:rfc:`5949`]
+    All_available_Context_Transferred = 6
+
+    #: Handover Not Accepted, reason unspecified [:rfc:`5568`]
+    Handover_Not_Accepted_reason_unspecified = 128
+
+    #: Administratively prohibited [:rfc:`5568`]
+    Administratively_prohibited = 129
+
+    #: Insufficient resources [:rfc:`5568`]
+    Insufficient_resources = 130
+
+    #: Requested Context Not Available [:rfc:`5949`]
+    Requested_Context_Not_Available = 131
+
+    #: Forwarding Not Available [:rfc:`5949`]
+    Forwarding_Not_Available = 132
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'HandoverACKStatus':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return HandoverACKStatus(key)
+        if key not in HandoverACKStatus._member_map_:  # pylint: disable=no-member
+            return extend_enum(HandoverACKStatus, key, default)
+        return HandoverACKStatus[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'HandoverACKStatus':
+        """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 <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 133 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/handover_initiate_flag.py

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Handover Initiate Flags
+=============================
+
+.. module:: pcapkit.const.mh.handover_initiate_flag
+
+This module contains the constant enumeration for **Handover Initiate Flags**,
+which is automatically generated from :class:`pcapkit.vendor.mh.handover_initiate_flag.HandoverInitiateFlag`.
+
+"""
+
+from aenum import IntFlag
+
+__all__ = ['HandoverInitiateFlag']
+
+
+class HandoverInitiateFlag(IntFlag):
+    """[HandoverInitiateFlag] Handover Initiate Flags"""
+
+    #: Assigned Address Configuration flag [:rfc:`5568`]
+    S = 0x80
+
+    #: Buffer flag [:rfc:`5568`]
+    U = 0x40
+
+    #: Proxy flag [:rfc:`5949`]
+    P = 0x20
+
+    #: Forwarding flag [:rfc:`5949`]
+    F = 0x10
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'HandoverInitiateFlag':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return HandoverInitiateFlag(key)
+        return HandoverInitiateFlag[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'HandoverInitiateFlag':
+        """Lookup function used when value is not found.
+
+        Args:
+            value: Value to get enum item.
+
+        """
+        if not (isinstance(value, int) and 0 <= value <= 0xFF):
+            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
+        return cls(value)

pcapkit/const/mh/handover_initiate_status.py

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Handover Initiate Status Codes
+====================================
+
+.. module:: pcapkit.const.mh.handover_initiate_status
+
+This module contains the constant enumeration for **Handover Initiate Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.handover_initiate_status.HandoverInitiateStatus`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['HandoverInitiateStatus']
+
+
+class HandoverInitiateStatus(IntEnum):
+    """[HandoverInitiateStatus] Handover Initiate Status Codes"""
+
+    #: FBU with the PCoA as source IP address [:rfc:`5568`]
+    FBU_with_the_PCoA_as_source_IP_address = 0
+
+    #: FBU whose source IP address is not PCoA [:rfc:`5568`]
+    FBU_whose_source_IP_address_is_not_PCoA = 1
+
+    #: Indicate the completion of forwarding [:rfc:`5949`]
+    Indicate_the_completion_of_forwarding = 2
+
+    #: All available context transferred [:rfc:`5949`]
+    All_available_context_transferred = 3
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'HandoverInitiateStatus':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        """
+        if isinstance(key, int):
+            return HandoverInitiateStatus(key)
+        if key not in HandoverInitiateStatus._member_map_:  # pylint: disable=no-member
+            extend_enum(HandoverInitiateStatus, key, default)
+        return HandoverInitiateStatus[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'HandoverInitiateStatus':
+        """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 4 <= value <= 255:
+            #: Unassigned
+            extend_enum(cls, 'Unassigned_%d' % value, value)
+            return cls(value)
+        return super()._missing_(value)

pcapkit/const/mh/home_address_reply.py

@@ -0,0 +1,71 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""IPv4 Home Address Reply Status Codes
+==========================================
+
+.. module:: pcapkit.const.mh.home_address_reply
+
+This module contains the constant enumeration for **IPv4 Home Address Reply Status Codes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.home_address_reply.HomeAddressReply`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['HomeAddressReply']
+
+
+class HomeAddressReply(IntEnum):
+    """[HomeAddressReply] IPv4 Home Address Reply Status Codes"""
+
+    #: Success [:rfc:`5844`]
+    Success = 0
+
+    #: Failure, Reason Unspecified [:rfc:`5844`]
+    Failure_Reason_Unspecified = 128
+
+    #: Administratively prohibited [:rfc:`5844`]
+    Administratively_prohibited = 129
+
+    #: Incorrect IPv4 home address [:rfc:`5844`]
+    Incorrect_IPv4_home_address = 130
+
+    #: Invalid IPv4 address [:rfc:`5844`]
+    Invalid_IPv4_address = 131
+
+    #: Dynamic IPv4 home address assignment not available [:rfc:`5844`]
+    Dynamic_IPv4_home_address_assignment_not_available = 132
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'HomeAddressReply':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return HomeAddressReply(key)
+        if key not in HomeAddressReply._member_map_:  # pylint: disable=no-member
+            return extend_enum(HomeAddressReply, key, default)
+        return HomeAddressReply[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'HomeAddressReply':
+        """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 1 <= value <= 127:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        if 133 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/lla_code.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Link-Layer Address (LLA) Option Code
+==========================================
+
+.. module:: pcapkit.const.mh.lla_code
+
+This module contains the constant enumeration for **Link-Layer Address (LLA) Option Code**,
+which is automatically generated from :class:`pcapkit.vendor.mh.lla_code.LLACode`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['LLACode']
+
+
+class LLACode(IntEnum):
+    """[LLACode] Link-Layer Address (LLA) Option Code"""
+
+    Wilcard = 0
+
+    New_Access_Point = 1
+
+    MH = 2
+
+    NAR = 3
+
+    RtSolPr_or_PrRtAdv = 4
+
+    access_point = 5
+
+    no_prefix_information = 6
+
+    no_fast_handover_support = 7
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'LLACode':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return LLACode(key)
+        if key not in LLACode._member_map_:  # pylint: disable=no-member
+            return extend_enum(LLACode, key, default)
+        return LLACode[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'LLACode':
+        """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__))
+        return extend_enum(cls, 'Unassigned_%d' % value, value)

pcapkit/const/mh/lma_mag_suboption.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""LMA-Controlled MAG Parameters Sub-Option Type Values
+==========================================================
+
+.. module:: pcapkit.const.mh.lma_mag_suboption
+
+This module contains the constant enumeration for **LMA-Controlled MAG Parameters Sub-Option Type Values**,
+which is automatically generated from :class:`pcapkit.vendor.mh.lma_mag_suboption.LMAControlledMAGSuboption`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['LMAControlledMAGSuboption']
+
+
+class LMAControlledMAGSuboption(IntEnum):
+    """[LMAControlledMAGSuboption] LMA-Controlled MAG Parameters Sub-Option Type Values"""
+
+    #: Reserved [:rfc:`8127`]
+    Reserved_0 = 0
+
+    #: Binding Re-registration Control Sub-Option [:rfc:`8127`]
+    Binding_Re_registration_Control = 1
+
+    #: Heartbeat Control Sub-Option [:rfc:`8127`]
+    Heartbeat_Control = 2
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'LMAControlledMAGSuboption':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return LMAControlledMAGSuboption(key)
+        if key not in LMAControlledMAGSuboption._member_map_:  # pylint: disable=no-member
+            return extend_enum(LMAControlledMAGSuboption, key, default)
+        return LMAControlledMAGSuboption[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'LMAControlledMAGSuboption':
+        """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 3 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/mn_group_id.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobile Node Group Identifier Type Registry
+================================================
+
+.. module:: pcapkit.const.mh.mn_group_id
+
+This module contains the constant enumeration for **Mobile Node Group Identifier Type Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.mn_group_id.MNGroupID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['MNGroupID']
+
+
+class MNGroupID(IntEnum):
+    """[MNGroupID] Mobile Node Group Identifier Type Registry"""
+
+    #: Reserved [:rfc:`6602`]
+    Reserved_0 = 0
+
+    #: Bulk Binding Update Group [:rfc:`6602`]
+    Bulk_Binding_Update_Group = 1
+
+    #: Reserved [:rfc:`6602`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'MNGroupID':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return MNGroupID(key)
+        if key not in MNGroupID._member_map_:  # pylint: disable=no-member
+            return extend_enum(MNGroupID, key, default)
+        return MNGroupID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'MNGroupID':
+        """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 2 <= value <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/mn_id_subtype.py

@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Mobile Node Identifier Option Subtypes
+============================================
+
+.. module:: pcapkit.const.mh.mn_id_subtype
+
+This module contains the constant enumeration for **Mobile Node Identifier Option Subtypes**,
+which is automatically generated from :class:`pcapkit.vendor.mh.mn_id_subtype.MNIDSubtype`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['MNIDSubtype']
+
+
+class MNIDSubtype(IntEnum):
+    """[MNIDSubtype] Mobile Node Identifier Option Subtypes"""
+
+    #: NAI [:rfc:`4283`]
+    NAI = 1
+
+    #: IPv6 Address [:rfc:`8371`]
+    IPv6_Address = 2
+
+    #: IMSI [:rfc:`8371`]
+    IMSI = 3
+
+    #: P-TMSI [:rfc:`8371`]
+    P_TMSI = 4
+
+    #: EUI-48 address [:rfc:`8371`]
+    EUI_48_address = 5
+
+    #: EUI-64 address [:rfc:`8371`]
+    EUI_64_address = 6
+
+    #: GUTI [:rfc:`8371`]
+    GUTI = 7
+
+    #: DUID [:rfc:`8371`]
+    DUID = 8
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'MNIDSubtype':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return MNIDSubtype(key)
+        if key not in MNIDSubtype._member_map_:  # pylint: disable=no-member
+            return extend_enum(MNIDSubtype, key, default)
+        return MNIDSubtype[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'MNIDSubtype':
+        """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 9 <= value <= 15:
+            #: Reserved [:rfc:`8371`]
+            return extend_enum(cls, 'Reserved_%d' % value, value)
+        if 16 <= value <= 255:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)

pcapkit/const/mh/operator_id.py

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+# pylint: disable=line-too-long,consider-using-f-string
+"""Operator-Identifier Type Registry
+=======================================
+
+.. module:: pcapkit.const.mh.operator_id
+
+This module contains the constant enumeration for **Operator-Identifier Type Registry**,
+which is automatically generated from :class:`pcapkit.vendor.mh.operator_id.OperatorID`.
+
+"""
+
+from aenum import IntEnum, extend_enum
+
+__all__ = ['OperatorID']
+
+
+class OperatorID(IntEnum):
+    """[OperatorID] Operator-Identifier Type Registry"""
+
+    #: Reserved [:rfc:`6757`]
+    Reserved_0 = 0
+
+    #: Operator-Identifier as a variable-length Private Enterprise Number (PEN)
+    #: [:rfc:`6757`]
+    Operator_Identifier_as_a_variable_length_Private_Enterprise_Number = 1
+
+    #: Realm of the Operator [:rfc:`6757`]
+    Realm_of_the_Operator = 2
+
+    #: Reserved [:rfc:`6757`]
+    Reserved_255 = 255
+
+    @staticmethod
+    def get(key: 'int | str', default: 'int' = -1) -> 'OperatorID':
+        """Backport support for original codes.
+
+        Args:
+            key: Key to get enum item.
+            default: Default value if not found.
+
+        :meta private:
+        """
+        if isinstance(key, int):
+            return OperatorID(key)
+        if key not in OperatorID._member_map_:  # pylint: disable=no-member
+            return extend_enum(OperatorID, key, default)
+        return OperatorID[key]  # type: ignore[misc]
+
+    @classmethod
+    def _missing_(cls, value: 'int') -> 'OperatorID':
+        """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 3 <= value <= 254:
+            #: Unassigned
+            return extend_enum(cls, 'Unassigned_%d' % value, value)
+        return super()._missing_(value)