igmp_server.h

Go to the documentation of this file.

// Copyright 2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/eth_plugin.h>
#include <satcat5/ip_core.h>
#include <satcat5/polling.h>
 
namespace satcat5 {
    namespace igmp {
        struct Group {
            satcat5::ip::Addr group;
            SATCAT5_PMASK_TYPE mask_active;
            SATCAT5_PMASK_TYPE mask_rcvd1;
            SATCAT5_PMASK_TYPE mask_rcvd2;
            u16 query_count, query_timer;
 
            constexpr Group()
                : group(satcat5::ip::ADDR_NONE)
                , mask_active(0), mask_rcvd1(0), mask_rcvd2(0)
                , query_count(0), query_timer(0) {}
 
            void reset(const satcat5::ip::Addr& addr);
            void rcvd(SATCAT5_PMASK_TYPE mask);
            void refresh();
        };
 
        class Server
            : public satcat5::eth::PluginCore
            , protected satcat5::poll::Timer {
        public:
            Server(
                satcat5::eth::SwitchCore* sw,
                satcat5::ip::Dispatch* iface,
                satcat5::igmp::Group* groups,
                unsigned gcount);
            ~Server() SATCAT5_OPTIONAL_DTOR;
 
            void flush();
 
            inline void force_version(u8 version)
                { m_vmax = version; }
 
            SATCAT5_PMASK_TYPE get_mask(const satcat5::ip::Addr& addr) const;
 
            bool is_querier() const;
 
            void query(satcat5::eth::PluginPacket& pkt) override;
 
            inline void set_mdly(u8 fast, u8 slow)
                { m_mdly_fast = fast; m_mdly_slow = slow; }
 
            u8 version() const;
 
        protected:
            void timer_event() override;
            satcat5::igmp::Group* find_or_create(const satcat5::ip::Addr& group);
            satcat5::igmp::Group* find_match(const satcat5::ip::Addr& group) const;
            void rcvd_igmp(satcat5::eth::PluginPacket& pkt);
            void rcvd_mcast(satcat5::eth::PluginPacket& pkt);
            void send_query(satcat5::igmp::Group* group, bool first);
 
            satcat5::ip::Dispatch* const m_iface;
            satcat5::igmp::Group* const m_groups;
            const u16 m_gcount;     // Size of working buffer
            u8 m_status;            // Status flag
            u8 m_mdly_fast;         // Single-group query delay
            u8 m_mdly_slow;         // General query delay
            u8 m_vmin, m_vmax;      // Current IGMP version
            u32 m_query_timer;      // Countdown to next outgoing query
            u32 m_window_timer;     // Countdown to end of query window
        };
 
        template <unsigned SIZE>
        class ServerStatic final : public satcat5::igmp::Server {
        public:
            ServerStatic(
                satcat5::eth::SwitchCore* sw,
                satcat5::ip::Dispatch* iface)
                : Server(sw, iface, m_buff, SIZE) {}
 
        protected:
            satcat5::igmp::Group m_buff[SIZE];
        };
    }
}