Protocol Chain

pcapkit.corekit.protochain contains special protocol collection class ProtoChain.

class pcapkit.corekit.protochain.ProtoChain(proto, alias=None, *, basis=None)

Bases: Sequence

Protocols chain.

Parameters

• proto (Protocol | Type[Protocol]) – New protocol class on the top stack.

• alias (Optional[str]) – New protocol alias on the top stack.

• basis (Optional[ProtoChain]) – Original protocol chain as base stacks.

property protocols: tuple[Type[Protocol], ...]

List of protocols in the chain.

property aliases: tuple[str, ...]

Protocol names.

property chain: str

Protocol chain string.

Return type

str

classmethod from_list(data)

Create a protocol chain from a list.

Parameters

data (list[Protocol | Type[Protocol]]) – Protocol chain list.

Return type

ProtoChain

index(value, start=None, stop=None)

First index of value.

Parameters

• value (str | Protocol | Type[Protocol]) – Value to search.

• start (Optional[int]) – start offset.

• stop (Optional[int]) – stop offset.

Raises

IndexNotFound – If the value is not present.

Return type

int

count(value)

Number of occurrences of value.

Parameters

value (str | Protocol | Type[Protocol]) – Value to search.

Return type

int

__init__(proto, alias=None, *, basis=None)

Initialisation.

Parameters

• proto – New protocol class on the top stack.

• alias – New protocol alias on the top stack.

• basis – Original protocol chain as base stacks.

__str__()

Returns formatted hex representation of source data stream.

Example

>>> protochain
ProtoChain(Ethernet, IPv6, Raw)
>>> print(protochain)
Ethernet:IPv6:Raw

Return type

str

__repr__()

Returns representation of protocol chain data.

Example

>>> protochain
ProtoChain(Ethernet, IPv6, Raw)

Return type

str