Base Protocol

pcapkit.protocols.link.link contains Link, which is a base class for link layer protocols, e.g. ARP/InARP, Ethernet, L2TP, OSPF, RARP/DRARP and etc.

class pcapkit.protocols.link.link.Link(file=None, length=None, **kwargs)

Bases: ProtocolBase[_PT, _ST], Generic[_PT, _ST]

Abstract base class for link layer protocol family.

This class currently supports parsing of the following protocols, which are registered in the self.__proto__ attribute:

Index	Protocol
Address_Resolution_Protocol	pcapkit.protocols.link.arp.ARP
Reverse_Address_Resolution_Protocol	pcapkit.protocols.link.rarp.RARP
Customer_VLAN_Tag_Type	pcapkit.protocols.link.c_tag.C_Tag
IEEE_Std_802_1Q_Service_VLAN_tag_identifier	pcapkit.protocols.link.s_tag.S_Tag
Internet_Protocol_version_4	pcapkit.protocols.internet.ipv4.IPv4
Internet_Protocol_version_6	pcapkit.protocols.internet.ipv6.IPv6
0x8137	pcapkit.protocols.internet.ipx.IPX

property layer: Literal['Link']

Protocol layer.

classmethod register(code, protocol)

Register a new protocol class.

Notes

The full qualified class name of the new protocol class should be as {protocol.module}.{protocol.name}.

Parameters:

• code (EtherType) – protocol code as in EtherType

• protocol (ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]) – module descriptor or a Protocol subclass

Raises:

pcapkit.utilities.exceptions.RegistryError – If protocol is not a Protocol subclass.

Warns:

pcapkit.utilities.warnings.RegistryWarning – If this EtherType is already registered, naming the displaced entry and its replacement so a caller can tell what was lost. Fires only when the incumbent differs from the replacement – see ProtocolBase.register for the guard this shares with register_protocol.

__layer__: Literal['Link'] = 'Link'

Layer of protocol.

__proto__: DefaultDict[int | EtherType, ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]]

Protocol index mapping for decoding next layer, c.f. self._decode_next_layer & self._import_next_layer.

Type:

DefaultDict[int, ModuleDescriptor[ProtocolBase] | Type[ProtocolBase]]