Source code for pcapkit.const.tcp.flags

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

.. module:: pcapkit.const.tcp.flags

This module contains the constant enumeration for **TCP Header Flags**,
which is automatically generated from :class:`pcapkit.vendor.tcp.flags.Flags`.

"""

from typing import TYPE_CHECKING

from aenum import IntFlag

if TYPE_CHECKING:
    from typing import Optional

__all__ = ['Flags']



class Flags(IntFlag):
    """[Flags] TCP Header Flags"""

    #: Reserved for future use [:rfc:`9293`]
    Reserved_4 = 1 << 4

    #: Reserved for future use [:rfc:`9293`]
    Reserved_5 = 1 << 5

    #: Reserved for future use [:rfc:`9293`]
    Reserved_6 = 1 << 6

    #: Reserved for future use [:rfc:`8311`]
    Reserved_7 = 1 << 7

    #: CWR (Congestion Window Reduced) [:rfc:`3168`]
    CWR = 1 << 8

    #: ECE (ECN-Echo) [:rfc:`3168`]
    ECE = 1 << 9

    #: Urgent Pointer field is significant (URG) [:rfc:`9293`]
    URG = 1 << 10

    #: Acknowledgment field is significant (ACK) [:rfc:`9293`]
    ACK = 1 << 11

    #: Push Function (PSH) [:rfc:`9293`]
    PSH = 1 << 12

    #: Reset the connection (RST) [:rfc:`9293`]
    RST = 1 << 13

    #: Synchronize sequence numbers (SYN) [:rfc:`9293`]
    SYN = 1 << 14

    #: No more data from sender (FIN) [:rfc:`9293`]
    FIN = 1 << 15

    @staticmethod
    def get(key: 'int | str', default: 'Optional[int]' = -1) -> 'Flags':
        """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 Flags(key)
        return Flags[key]  # type: ignore[misc]