:tocdepth: 3

base/packet-protocols/igmp/spicy-events.zeek
============================================

Events generated by the IGMP analyzer.

See :rfc:`3376`.


Summary
~~~~~~~
Events
######
========================================================= =======================================================
:zeek:id:`IGMP::leave_group`: :zeek:type:`event`          Generated for every IGMP Version 2 Leave Group Message.
:zeek:id:`IGMP::membership_query`: :zeek:type:`event`     Generated for every IGMP Membership Query.
:zeek:id:`IGMP::membership_report_v1`: :zeek:type:`event` Generated for every IGMP Version 1 Membership Report.
:zeek:id:`IGMP::membership_report_v2`: :zeek:type:`event` Generated for every IGMP Version 2 Membership Report.
:zeek:id:`IGMP::membership_report_v3`: :zeek:type:`event` Generated for every IGMP Version 3 Membership Report.
:zeek:id:`IGMP::message`: :zeek:type:`event`              Generated for every processed IGMP message.
========================================================= =======================================================


Detailed Interface
~~~~~~~~~~~~~~~~~~
Events
######
.. zeek:id:: IGMP::leave_group
   :source-code: policy/protocols/conn/multicast-participants.zeek 174 180

   :Type: :zeek:type:`event` (source: :zeek:type:`addr`, group_addr: :zeek:type:`addr`)

   Generated for every IGMP Version 2 Leave Group Message.


   :param source: The address of the source for this report.


   :param group_addr: Multicast group address

.. zeek:id:: IGMP::membership_query
   :source-code: base/packet-protocols/igmp/spicy-events.zeek 17 17

   :Type: :zeek:type:`event` (source: :zeek:type:`addr`, group_addr: :zeek:type:`addr`)

   Generated for every IGMP Membership Query.


   :param source: The address of the source for this query.


   :param group_addr: Multicast group address

.. zeek:id:: IGMP::membership_report_v1
   :source-code: policy/protocols/conn/multicast-participants.zeek 143 146

   :Type: :zeek:type:`event` (source: :zeek:type:`addr`, group_addr: :zeek:type:`addr`)

   Generated for every IGMP Version 1 Membership Report.


   :param source: The address of the source for this report.


   :param group_addr: Multicast group address

.. zeek:id:: IGMP::membership_report_v2
   :source-code: policy/protocols/conn/multicast-participants.zeek 148 151

   :Type: :zeek:type:`event` (source: :zeek:type:`addr`, group_addr: :zeek:type:`addr`)

   Generated for every IGMP Version 2 Membership Report.


   :param source: The address of the source for this report.


   :param group_addr: Multicast group address

.. zeek:id:: IGMP::membership_report_v3
   :source-code: policy/protocols/conn/multicast-participants.zeek 153 172

   :Type: :zeek:type:`event` (source: :zeek:type:`addr`, groups: :zeek:type:`vector` of :zeek:type:`IGMP::Group`)

   Generated for every IGMP Version 3 Membership Report.


   :param source: The address of the source for this report.


   :param groups: vector of Multicast groups

.. zeek:id:: IGMP::message
   :source-code: base/packet-protocols/igmp/spicy-events.zeek 10 10

   :Type: :zeek:type:`event` (packet: :zeek:type:`raw_pkt_hdr`, msg_type: :zeek:type:`IGMP::MessageType`)

   Generated for every processed IGMP message.


   :param packet: Raw packet header.


   :param msg_type: The type of message received.


