ip_address.h

// Copyright 2021-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// IPv4 address with automatic or manual MAC-address resolution
 
#pragma once
 
#include <satcat5/eth_arp.h>
#include <satcat5/igmp_client.h>
#include <satcat5/ip_dispatch.h>
#include <satcat5/net_core.h>
#include <satcat5/timeref.h>
 
namespace satcat5 {
    namespace ip {
        class Address final
            : public satcat5::net::Address
            , public satcat5::eth::ArpListener
        {
        public:
            Address(satcat5::ip::Dispatch* iface, u8 proto);
            ~Address() SATCAT5_OPTIONAL_DTOR;
 
            void init(satcat5::ip::Dispatch* iface);
 
            void connect(
                const satcat5::ip::Addr& dstaddr,
                const satcat5::eth::VlanTag& vtag = satcat5::eth::VTAG_NONE);
 
            void connect(
                const satcat5::ip::Addr& dstaddr,
                const satcat5::eth::MacAddr& dstmac,
                const satcat5::eth::VlanTag& vtag = satcat5::eth::VTAG_NONE);
 
            // Required overrides from net::Address:
            void close() override;
            bool ready() const override {return m_ready;}
            void retry() override;
            satcat5::net::Dispatch* iface() const override;
            satcat5::io::Writeable* open_write(unsigned len) override;
            bool is_multicast() const override;
            bool matches_reply_address() const override;
            bool reply_is_multicast() const override;
            void save_reply_address() override;
 
            // Various accessors.
            inline satcat5::eth::MacAddr dstmac() const
                { return m_dstmac; }
            inline satcat5::eth::MacAddr srcmac() const
                { return m_iface->macaddr(); }
            inline satcat5::eth::VlanTag vtag() const
                { return m_vtag; }
            inline satcat5::eth::Dispatch* eth() const
                { return m_iface->iface(); }
            inline satcat5::eth::Header eth_header() const
                { return {dstmac(), srcmac(), satcat5::eth::ETYPE_IPV4, vtag()}; }
            inline satcat5::ip::Addr dstaddr() const
                { return m_dstaddr; }
            inline satcat5::ip::Addr gateway() const
                { return m_gateway; }
 
        protected:
            void arp_event(
                const satcat5::eth::MacAddr& mac,
                const satcat5::ip::Addr& ip) override;
            void gateway_change(
                const satcat5::ip::Addr& dstaddr,
                const satcat5::ip::Addr& gateway) override;
 
            satcat5::ip::Dispatch* m_iface;
            const u8 m_proto;
            u8 m_ready;
            satcat5::util::TimeVal m_arp_tref;
            satcat5::eth::MacAddr m_dstmac;
            satcat5::ip::Addr m_dstaddr;
            satcat5::ip::Addr m_gateway;
            satcat5::eth::VlanTag m_vtag;
            satcat5::igmp::Address m_igmp;
        };
    }
}