file_aeroftp.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 <hal_posix/file_io.h>
#include <satcat5/net_aeroftp.h>
#include <cstdio>
#include <map>
#include <string>
#include <vector>
 
namespace satcat5 {
    namespace net {
        class AeroFtpFile {
        public:
            AeroFtpFile(
                const char* work_folder,
                u32 file_id, u32 file_len,
                bool resume);
            ~AeroFtpFile();
 
            void frame_rcvd(
                u32 file_id, u32 file_len, u32 offset, u32 rxlen,
                satcat5::io::LimitedRead& data);
 
            satcat5::io::Readable* missing_blocks();
 
            inline bool done() const    { return m_pcount == 0; }
            inline bool error() const   { return m_pcount == UINT_MAX; }
 
        protected:
            void cleanup();                 // Close open file handles
            void log(s8 level, const char* msg);
 
            const std::string m_name_data;  // Filenames (see top)
            const std::string m_name_meta;
            const std::string m_name_part;
            const u32 m_file_id;            // Numeric File-ID
            const u32 m_file_len;           // Length of file (words)
            const u32 m_bcount;             // Total block count
            unsigned m_pcount;              // Number of pending blocks
            FILE* m_data;                   // In-progress file-data
            FILE* m_meta;                   // In-progress meta-data
            u8* m_pending;                  // Flag each pending block
            satcat5::io::ArrayRead m_status;
        };
 
        class AeroFtpServer : public satcat5::net::Protocol {
        public:
            satcat5::io::Readable* missing_blocks(u32 file_id);
 
            bool done(u32 file_id) const;
 
            inline void resume(bool allow) {m_resume = allow;}
 
        protected:
            AeroFtpServer(
                const char* work_folder,
                satcat5::net::Dispatch* iface,
                const satcat5::net::Type& typ);
            ~AeroFtpServer();
 
            void frame_rcvd(satcat5::io::LimitedRead& src) override;
 
            // Internal state.
            const std::string m_work_folder;
            satcat5::net::Dispatch* const m_iface;
            bool m_resume;
            std::map<u32, satcat5::net::AeroFtpFile*> m_files;
        };
    }
 
    // Thin wrappers for commonly used protocols:
    namespace eth {
        class AeroFtpServer final : public satcat5::net::AeroFtpServer {
        public:
            AeroFtpServer(
                const char* work_folder,
                satcat5::eth::Dispatch* eth,
                const satcat5::eth::MacType& type = satcat5::eth::ETYPE_AEROFTP);
        };
    }
 
    namespace udp {
        class AeroFtpServer final : public satcat5::net::AeroFtpServer {
        public:
            AeroFtpServer(
                const char* work_folder,
                satcat5::udp::Dispatch* udp,
                const satcat5::udp::Port& port = satcat5::udp::PORT_AEROFTP);
        };
    }
}