coap_endpoint.h

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
// CoAP endpoint (i.e., client, server, or combined client+server)
 
#pragma once
 
#include <satcat5/ccsds_spp.h>
#include <satcat5/coap_connection.h>
#include <satcat5/udp_dispatch.h>
#include <satcat5/utils.h>
 
namespace satcat5 {
    namespace coap {
        class Endpoint : public satcat5::net::Protocol {
        public:
            inline satcat5::net::Dispatch* iface() const
                { return m_iface; }
            inline satcat5::udp::Port srcport() const
                { return satcat5::udp::Port(m_filter.as_u16()); }
 
            Connection* find_token(u32 token) const;
 
            satcat5::coap::Connection* get_idle_connection() const;
 
            void set_connection(satcat5::coap::Connection* obj)
                { m_prefer = obj; }
 
            inline void set_filter(const satcat5::net::Type& filter)
                { m_filter = filter; }
 
        protected:
            explicit Endpoint(satcat5::net::Dispatch* iface);
            ~Endpoint() SATCAT5_OPTIONAL_DTOR;
 
            friend satcat5::coap::EndpointSppFwd;
 
            virtual void coap_request(Connection* obj, Reader* msg)     // GCOVR_EXCL_LINE
                { obj->error_response(CODE_NOT_IMPL); }                 // GCOVR_EXCL_LINE
            virtual void coap_response(Connection* obj, Reader* msg) {} // GCOVR_EXCL_LINE
            virtual void coap_reqwait(Connection* obj, Reader* msg) {}  // GCOVR_EXCL_LINE
            virtual void coap_separate(Connection* obj, Reader* msg) {} // GCOVR_EXCL_LINE
            virtual void coap_error(Connection* obj) {}                 // GCOVR_EXCL_LINE
            virtual void coap_ping(const Reader* msg) {}                // GCOVR_EXCL_LINE
            virtual void coap_timeout(Connection* obj) {}               // GCOVR_EXCL_LINE
 
            // Network event handling.
            void frame_rcvd(satcat5::io::LimitedRead& src) override;
 
            // Internal event handling.
            friend satcat5::coap::Connection;
            inline void add_connection(Connection* item)
                { m_list.add(item); }
            inline void remove_connection(Connection* item)
                { m_list.remove(item); }
            bool reply(u8 type, const satcat5::coap::ReadHeader* msg);
 
            // Internal state.
            satcat5::net::Dispatch* const m_iface;
            satcat5::util::List<satcat5::coap::Connection> m_list;
            satcat5::coap::Connection* m_prefer;
            satcat5::coap::Endpoint* m_aux_ep;
        };
 
        class ManageSpp {
        public:
            inline satcat5::coap::ConnectionSpp* connection()
                { return &m_connection; }
 
        protected:
            ManageSpp(satcat5::coap::Endpoint* coap, u16 apid);
            ~ManageSpp() {}
 
            satcat5::coap::ConnectionSpp m_connection;
        };
 
        class EndpointSpp
            : public satcat5::coap::Endpoint
            , public satcat5::coap::ManageSpp
        {
        protected:
            EndpointSpp(satcat5::ccsds_spp::Dispatch* iface, u16 apid);
            ~EndpointSpp() {}
        };
 
        class EndpointSppFwd : public satcat5::coap::EndpointSpp {
        public:
            EndpointSppFwd(
                satcat5::ccsds_spp::Dispatch* iface, u16 apid,
                satcat5::coap::Endpoint* backing_endpoint);
 
        protected:
            void coap_request(Connection* obj, Reader* msg) override;
            void coap_response(Connection* obj, Reader* msg) override;
            void coap_error(Connection* obj) override;
            void coap_ping(const Reader* msg) override;
 
            satcat5::coap::Endpoint* const m_endpoint;
        };
 
        class ManageUdp {
        public:
            void bind(satcat5::udp::Port req_port = satcat5::udp::PORT_COAP);
 
            satcat5::coap::ConnectionUdp* connect(
                const satcat5::udp::Addr& dstaddr,
                const satcat5::udp::Port& dstport = satcat5::udp::PORT_COAP,
                const satcat5::udp::Port& srcport = satcat5::udp::PORT_NONE);
 
            inline satcat5::eth::Dispatch* eth() const
                { return ip()->iface(); }
            inline satcat5::ip::Dispatch* ip() const
                { return udp()->iface(); }
            inline satcat5::udp::Dispatch* udp() const
                { return (satcat5::udp::Dispatch*)m_endpoint->iface(); }
 
        protected:
            explicit ManageUdp(satcat5::coap::Endpoint* coap,
                satcat5::udp::Port req_port = satcat5::udp::PORT_NONE);
            ~ManageUdp() {}
 
            satcat5::coap::Endpoint* const m_endpoint;
        };
 
        class EndpointUdp
            : public satcat5::coap::Endpoint
            , public satcat5::coap::ManageUdp
        {
        protected:
            explicit EndpointUdp(satcat5::udp::Dispatch* iface,
                satcat5::udp::Port req_port = satcat5::udp::PORT_NONE);
            ~EndpointUdp() {}
        };
 
        class EndpointUdpSimple : public satcat5::coap::EndpointUdp {
        protected:
            explicit EndpointUdpSimple(satcat5::udp::Dispatch* iface,
                satcat5::udp::Port req_port = satcat5::udp::PORT_NONE)
                : EndpointUdp(iface, req_port), m_connection(this, iface) {}
            ~EndpointUdpSimple() {}
 
            satcat5::coap::ConnectionUdp m_connection;
        };
 
        template <unsigned SIZE>
        class EndpointUdpStatic : public satcat5::coap::EndpointUdp {
        public:
            inline ConnectionUdp& connections(unsigned idx)
                { return m_connections[idx]; }
 
        protected:
            explicit EndpointUdpStatic(satcat5::udp::Dispatch* iface,
                satcat5::udp::Port req_port = satcat5::udp::PORT_NONE)
                : EndpointUdp(iface, req_port), m_connections(this, iface) {}
            ~EndpointUdpStatic() {}
 
            satcat5::coap::ConnectionUdpArray<SIZE> m_connections;
        };
    }
}