coap_resource.h

Go to the documentation of this file.

// Copyright 2024-2025 The Aerospace Corporation.
// This file is a part of SatCat5, licensed under CERN-OHL-W v2 or later.
 
#pragma once
 
#include <satcat5/coap_connection.h>
#include <satcat5/coap_endpoint.h>
#include <satcat5/utils.h>
 
namespace satcat5 {
    namespace coap {
        class Resource {
        protected:
            constexpr explicit Resource(const char* uri_path)
                : m_uri_path(normalize_uri(uri_path))
                , m_server(nullptr)
                , m_next(nullptr) {}
 
            Resource(ResourceServer* server, const char* uri_path);
 
            ~Resource() SATCAT5_OPTIONAL_DTOR;
 
            static constexpr const char* normalize_uri(const char* uri)
                { return (uri[0] == '/') ? (uri + 1) : (uri); }
 
        public:
            bool operator==(const Resource& other) const;
            inline bool operator!=(const Resource& other) const
                { return !(*this == other); }
 
            satcat5::ip::Dispatch* ip() const;
            satcat5::udp::Dispatch* udp() const;
 
            virtual bool request_get(Connection* obj, Reader* msg)
                { return obj->error_response(CODE_BAD_METHOD); }
            virtual bool request_post(Connection* obj, Reader* msg)
                { return obj->error_response(CODE_BAD_METHOD); }
            virtual bool request_put(Connection* obj, Reader* msg)
                { return obj->error_response(CODE_BAD_METHOD); }
            virtual bool request_delete(Connection* obj, Reader* msg)
                { return obj->error_response(CODE_BAD_METHOD); }
 
        protected:
            const char* const m_uri_path;
 
            ResourceServer* const m_server;
 
        private:
            // Member variables
            friend satcat5::util::ListCore;
            Resource* m_next; // Linked list next node
        };
 
        class ResourceEcho : public Resource {
        public:
            constexpr explicit ResourceEcho(const char* uri_path)
                : Resource(uri_path) {}
            ResourceEcho(ResourceServer* server, const char* uri_path)
                : Resource(server, uri_path) {}
 
            bool request_get(Connection* obj, Reader* msg) override;
        };
 
        class ResourceError final : public Resource {
        public:
            constexpr explicit ResourceError(const char* uri_path, Code errcode)
                : Resource(uri_path), m_errcode(errcode) {}
            ResourceError(ResourceServer* server, const char* uri_path, Code errcode)
                : Resource(server, uri_path), m_errcode(errcode) {}
 
            bool request_get(Connection* obj, Reader* msg) override
                { return obj->error_response(m_errcode); }
            bool request_post(Connection* obj, Reader* msg) override
                { return obj->error_response(m_errcode); }
            bool request_put(Connection* obj, Reader* msg) override
                { return obj->error_response(m_errcode); }
            bool request_delete(Connection* obj, Reader* msg) override
                { return obj->error_response(m_errcode); }
 
        protected:
            const satcat5::coap::Code m_errcode;
        };
 
        class ResourceLog : public Resource {
        public:
            constexpr ResourceLog(const char* uri_path, s8 priority)
                : Resource(uri_path), m_priority(priority) {}
            ResourceLog(ResourceServer* server, const char* uri_path, s8 priority)
                : Resource(server, uri_path), m_priority(priority) {}
 
            bool request_post(Connection* obj, Reader* msg) override;
 
        protected:
            s8 m_priority; 
        };
 
        class ResourceNull : public Resource {
        public:
            explicit ResourceNull(const char* uri)
                : Resource(uri) {}
            ResourceNull(ResourceServer* server, const char* uri)
                : Resource(server, uri) {}
        };
 
        class ResourceServer : public satcat5::coap::EndpointUdp {
        public:
            explicit ResourceServer(satcat5::udp::Dispatch* udp,
                satcat5::udp::Port port = satcat5::udp::PORT_COAP)
                : satcat5::coap::EndpointUdp(udp, port), m_connection(this, udp) {}
 
            inline void add_resource(Resource* resource)
                { m_resources.add(resource); }
 
            inline void remove_resource(Resource* resource)
                { m_resources.remove(resource); }
 
        protected:
            // Member variables
            satcat5::util::List<Resource> m_resources; 
            satcat5::coap::ConnectionUdp m_connection; 
 
            void coap_request(Connection* obj, Reader* msg) override;
        };
    }
}