zeek/doc/scripts/base/bif/plugins/Zeek_PPPoE.functions.bif.zeek.rst
Tim Wojtulewicz ded98cd373 Copy docs into Zeek repo directly
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the
zeek-docs repo.
2025-09-26 02:58:29 +00:00

37 lines
1.1 KiB
ReStructuredText

:tocdepth: 3
base/bif/plugins/Zeek_PPPoE.functions.bif.zeek
==============================================
.. zeek:namespace:: GLOBAL
.. zeek:namespace:: PacketAnalyzer::PPPoE
:Namespaces: GLOBAL, PacketAnalyzer::PPPoE
Summary
~~~~~~~
Functions
#########
=================================================================== ===============================================================
:zeek:id:`PacketAnalyzer::PPPoE::session_id`: :zeek:type:`function` Returns the PPPoE Session ID of the current packet, if present.
=================================================================== ===============================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. zeek:id:: PacketAnalyzer::PPPoE::session_id
:source-code: base/bif/plugins/Zeek_PPPoE.functions.bif.zeek 15 15
:Type: :zeek:type:`function` () : :zeek:type:`count`
Returns the PPPoE Session ID of the current packet, if present.
If no PPPoE Session ID is present, 0xFFFFFFFF is returned, which
is out of range of the session ID.
:returns: The PPPoE session ID if present, 0xFFFFFFFF otherwise.