Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/source/contributing/conventions/mint-criterion.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,9 @@ Measured against the tree, by class:
:mod:`mh.dhcp_support_mode <pcapkit.const.mh.dhcp_support_mode>` and
:mod:`vlan.priority_level <pcapkit.const.vlan.priority_level>`.
* **Cache in the value table only**: :class:`~pcapkit.const.tcp.flags.Flags`,
:class:`~pcapkit.const.ftp.command.CommandType` and the Mobility Header flag
registries, such as :class:`~pcapkit.const.mh.binding_ack_flag.BindingACKFlag`. They
:class:`~pcapkit.const.ftp.command.CommandType`, the Mobility Header flag
registries, such as :class:`~pcapkit.const.mh.binding_ack_flag.BindingACKFlag`, and
the radiotap flag registries, such as :class:`~pcapkit.const.radiotap.flags.Flags`. They
range-check and hand back to ``super()._missing_``, which for an ``aenum.IntFlag``
reaches ``_create_pseudo_member_`` and ends in
``cls._value2member_map_.setdefault(value, pseudo_member)``.
Expand Down Expand Up @@ -232,8 +233,8 @@ only ``ast.Name`` nodes finds every mint and no unmint at all:
lookup then finds. :class:`~pcapkit.const.mh.cga_type.CGAType`
grows ``__members__``, ``_member_map_`` and ``_value2member_map_``;
:class:`~pcapkit.const.tcp.flags.Flags`,
:class:`~pcapkit.const.ftp.command.CommandType` and the Mobility Header flag
registries grow ``_value2member_map_`` only. Snapshot
:class:`~pcapkit.const.ftp.command.CommandType` and the Mobility Header and
radiotap flag registries grow ``_value2member_map_`` only. Snapshot
``{member.value for member in Cls}`` before any lookup regardless -- that snapshot
cannot see the flag registries' cache, so compare ``len(Cls._value2member_map_)``
too -- and use a throwaway process per registry when comparing behaviour across
Expand Down
15 changes: 15 additions & 0 deletions docs/source/contributing/conventions/registry-protocol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -863,6 +863,21 @@ unless its ``EXCUSED`` table gives the reason. It fails as well on a map whose o
defines no ``register*`` classmethod of its own, unless its ``INHERITED`` table names
the one typed for that map's keys.

**A protocol's table from a code to the layout read under it is such a map as well, and
each layout is a concrete schema.** Ruled in review of :pr:`2657` (:issue:`2576`): the
table is a class-level map on the protocol, with its ``register_<kind>`` classmethod and
its wrapper, and never a dictionary at module level; each layout is a
:class:`~pcapkit.protocols.schema.schema.Schema` subclass with typed fields, defined with
the protocol's other schemas, and never built inside the map. Radiotap's field types are
the example:
:attr:`Radiotap.__field__ <pcapkit.protocols.link.radiotap.Radiotap.__field__>` is
written by :meth:`Radiotap.register_field <pcapkit.protocols.link.radiotap.Radiotap.register_field>`
and :func:`~pcapkit.foundation.registry.protocols.link.register_radiotap_field`, in the
shape of :func:`~pcapkit.foundation.registry.protocols.transport.register_sctp_chunk`
above, and each type's layout is a
:class:`~pcapkit.protocols.schema.link.radiotap.RadiotapField` subclass, whose fields
are the type's subfields and whose ``__align__`` is its alignment.

.. _registry-protocol-index:

The Registry Index
Expand Down
4 changes: 2 additions & 2 deletions docs/source/contributing/pep.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1220,8 +1220,8 @@ neither header treats as carrying an EtherType each have a dissector of their ow
``NETLINK`` to :class:`~pcapkit.protocols.link.netlink.Netlink`, ``IPGRE`` and
``IP6GRE`` to :class:`~pcapkit.protocols.link.gre.GRE`, ``FRAD`` to
:class:`~pcapkit.protocols.link.frad.FRAD`, and ``IEEE80211_RADIOTAP`` to
:class:`~pcapkit.protocols.link.radiotap.Radiotap` (:issue:`2502`), which keeps its
optional fields undissected (:issue:`2576`) and hands the 802.11 frame to
:class:`~pcapkit.protocols.link.radiotap.Radiotap` (:issue:`2502`), which decodes its
optional fields (:issue:`2576`) and hands the 802.11 frame to
:class:`~pcapkit.protocols.link.ieee802_11.IEEE802_11`, which dissects the MAC
header and keeps the frame body :class:`~pcapkit.protocols.misc.raw.Raw`
(:issue:`2575`).
Expand Down
5 changes: 3 additions & 2 deletions docs/source/pcapkit/const/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Some behave otherwise, and :ref:`mint-criterion` gives the full split:

* :class:`~pcapkit.const.mh.cga_type.CGAType` installs a permanent member, so
``__members__`` and iteration grow.
* :class:`~pcapkit.const.tcp.flags.Flags` and the Mobility Header flag
registries, such as
* :class:`~pcapkit.const.tcp.flags.Flags` and the Mobility Header and radiotap
flag registries, such as
:class:`~pcapkit.const.mh.binding_ack_flag.BindingACKFlag`, hand back to
|aenum|_'s flag base, which caches the composed object in the value lookup
table only: a second lookup returns the same object, while ``__members__``
Expand Down Expand Up @@ -74,6 +74,7 @@ Link Layer
ieee802_11
l2tp
linux
radiotap
vlan

Internet Layer
Expand Down
244 changes: 244 additions & 0 deletions docs/source/pcapkit/const/radiotap.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
==========================================================================
:class:`~pcapkit.protocols.link.radiotap.Radiotap` Constant Enumerations
==========================================================================

.. module:: pcapkit.const.radiotap

This module contains all constant enumerations of
:class:`~pcapkit.protocols.link.radiotap.Radiotap` implementations, each scraped
from radiotap.org [*]_. Available enumerations include:

.. list-table::

* - :class:`Radiotap_FieldType <pcapkit.const.radiotap.field_type.FieldType>`
- Field Types
* - :class:`Radiotap_Flags <pcapkit.const.radiotap.flags.Flags>`
- Flags
* - :class:`Radiotap_ChannelFlags <pcapkit.const.radiotap.channel_flags.ChannelFlags>`
- Channel Flags
* - :class:`Radiotap_RXFlags <pcapkit.const.radiotap.rx_flags.RXFlags>`
- RX Flags
* - :class:`Radiotap_TXFlags <pcapkit.const.radiotap.tx_flags.TXFlags>`
- TX Flags
* - :class:`Radiotap_MCSKnown <pcapkit.const.radiotap.mcs_known.MCSKnown>`
- MCS Known Flags
* - :class:`Radiotap_AMPDUFlags <pcapkit.const.radiotap.ampdu_flags.AMPDUFlags>`
- A-MPDU Status Flags
* - :class:`Radiotap_VHTKnown <pcapkit.const.radiotap.vht_known.VHTKnown>`
- VHT Known Flags
* - :class:`Radiotap_VHTFlags <pcapkit.const.radiotap.vht_flags.VHTFlags>`
- VHT Flags
* - :class:`Radiotap_VHTCoding <pcapkit.const.radiotap.vht_coding.VHTCoding>`
- VHT Coding Flags
* - :class:`Radiotap_TimestampFlags <pcapkit.const.radiotap.timestamp_flags.TimestampFlags>`
- Timestamp Flags
* - :class:`Radiotap_HEMUOtherUserKnown <pcapkit.const.radiotap.he_mu_other_user_known.HEMUOtherUserKnown>`
- HE-MU-other-user Known Flags
* - :class:`Radiotap_LSIGData1 <pcapkit.const.radiotap.lsig_data1.LSIGData1>`
- L-SIG Data1 Flags
* - :class:`Radiotap_S1GKnown <pcapkit.const.radiotap.s1g_known.S1GKnown>`
- S1G Known Flags
* - :class:`Radiotap_EHTKnown <pcapkit.const.radiotap.eht_known.EHTKnown>`
- EHT Known Flags

.. versionadded:: 1.6.0

Field Types
===========

.. module:: pcapkit.const.radiotap.field_type

This module contains the constant enumeration for **Radiotap Field Types**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.field_type.FieldType`.

.. autoclass:: pcapkit.const.radiotap.field_type.FieldType
:members:
:undoc-members:
:show-inheritance:

Flags
=====

.. module:: pcapkit.const.radiotap.flags

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

.. autoclass:: pcapkit.const.radiotap.flags.Flags
:members:
:undoc-members:
:show-inheritance:

Channel Flags
=============

.. module:: pcapkit.const.radiotap.channel_flags

This module contains the constant enumeration for **Radiotap Channel Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.channel_flags.ChannelFlags`.

.. autoclass:: pcapkit.const.radiotap.channel_flags.ChannelFlags
:members:
:undoc-members:
:show-inheritance:

RX Flags
========

.. module:: pcapkit.const.radiotap.rx_flags

This module contains the constant enumeration for **Radiotap RX Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.rx_flags.RXFlags`.

.. autoclass:: pcapkit.const.radiotap.rx_flags.RXFlags
:members:
:undoc-members:
:show-inheritance:

TX Flags
========

.. module:: pcapkit.const.radiotap.tx_flags

This module contains the constant enumeration for **Radiotap TX Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.tx_flags.TXFlags`.

.. autoclass:: pcapkit.const.radiotap.tx_flags.TXFlags
:members:
:undoc-members:
:show-inheritance:

MCS Known Flags
===============

.. module:: pcapkit.const.radiotap.mcs_known

This module contains the constant enumeration for **Radiotap MCS Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.mcs_known.MCSKnown`.

.. autoclass:: pcapkit.const.radiotap.mcs_known.MCSKnown
:members:
:undoc-members:
:show-inheritance:

A-MPDU Status Flags
===================

.. module:: pcapkit.const.radiotap.ampdu_flags

This module contains the constant enumeration for **Radiotap A-MPDU Status Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.ampdu_flags.AMPDUFlags`.

.. autoclass:: pcapkit.const.radiotap.ampdu_flags.AMPDUFlags
:members:
:undoc-members:
:show-inheritance:

VHT Known Flags
===============

.. module:: pcapkit.const.radiotap.vht_known

This module contains the constant enumeration for **Radiotap VHT Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.vht_known.VHTKnown`.

.. autoclass:: pcapkit.const.radiotap.vht_known.VHTKnown
:members:
:undoc-members:
:show-inheritance:

VHT Flags
=========

.. module:: pcapkit.const.radiotap.vht_flags

This module contains the constant enumeration for **Radiotap VHT Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.vht_flags.VHTFlags`.

.. autoclass:: pcapkit.const.radiotap.vht_flags.VHTFlags
:members:
:undoc-members:
:show-inheritance:

VHT Coding Flags
================

.. module:: pcapkit.const.radiotap.vht_coding

This module contains the constant enumeration for **Radiotap VHT Coding Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.vht_coding.VHTCoding`.

.. autoclass:: pcapkit.const.radiotap.vht_coding.VHTCoding
:members:
:undoc-members:
:show-inheritance:

Timestamp Flags
===============

.. module:: pcapkit.const.radiotap.timestamp_flags

This module contains the constant enumeration for **Radiotap Timestamp Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.timestamp_flags.TimestampFlags`.

.. autoclass:: pcapkit.const.radiotap.timestamp_flags.TimestampFlags
:members:
:undoc-members:
:show-inheritance:

HE-MU-other-user Known Flags
============================

.. module:: pcapkit.const.radiotap.he_mu_other_user_known

This module contains the constant enumeration for **Radiotap HE-MU-other-user Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.he_mu_other_user_known.HEMUOtherUserKnown`.

.. autoclass:: pcapkit.const.radiotap.he_mu_other_user_known.HEMUOtherUserKnown
:members:
:undoc-members:
:show-inheritance:

L-SIG Data1 Flags
=================

.. module:: pcapkit.const.radiotap.lsig_data1

This module contains the constant enumeration for **Radiotap L-SIG Data1 Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.lsig_data1.LSIGData1`.

.. autoclass:: pcapkit.const.radiotap.lsig_data1.LSIGData1
:members:
:undoc-members:
:show-inheritance:

S1G Known Flags
===============

.. module:: pcapkit.const.radiotap.s1g_known

This module contains the constant enumeration for **Radiotap S1G Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.s1g_known.S1GKnown`.

.. autoclass:: pcapkit.const.radiotap.s1g_known.S1GKnown
:members:
:undoc-members:
:show-inheritance:

EHT Known Flags
===============

.. module:: pcapkit.const.radiotap.eht_known

This module contains the constant enumeration for **Radiotap EHT Known Flags**,
which is automatically generated from :class:`pcapkit.vendor.radiotap.eht_known.EHTKnown`.

.. autoclass:: pcapkit.const.radiotap.eht_known.EHTKnown
:members:
:undoc-members:
:show-inheritance:

.. rubric:: Footnotes

.. [*] https://www.radiotap.org/fields/defined, its unofficial-fields
page and each field's own page.
2 changes: 2 additions & 0 deletions docs/source/pcapkit/foundation/registry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,8 @@ Link Layer Registries

.. autofunction:: pcapkit.foundation.registry.protocols.link.register_radiotap

.. autofunction:: pcapkit.foundation.registry.protocols.link.register_radiotap_field

Internet Layer Registries
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
3 changes: 2 additions & 1 deletion docs/source/pcapkit/protocols/link/ieee802_11.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Scope
* **The FCS** (§9.2.4.8), where one was captured, stays at the end of the
body: this class does not decide whether a capture carries one, which
behind radiotap is a Flags bit
:class:`~pcapkit.protocols.link.radiotap.Radiotap` does not decode.
:class:`~pcapkit.protocols.link.radiotap.Radiotap` decodes but does not
pass on.
* **Pad octets** that radiotap's data-pad flag says follow the header stay
at the start of the body, for the same reason.
* **A protocol version other than 0** is refused: version 1 is the PV1
Expand Down
Loading
Loading