#ifndef FSFW_CFDP_USERBASE_H #define FSFW_CFDP_USERBASE_H #include #include #include #include "StatusReportIF.h" #include "fsfw/cfdp/VarLenFields.h" #include "fsfw/cfdp/tlv/FilestoreResponseTlv.h" #include "fsfw/cfdp/tlv/MessageToUserTlv.h" #include "fsfw/filesystem/HasFileSystemIF.h" namespace cfdp { struct TransactionFinishedParams { TransactionFinishedParams(TransactionId id, ConditionCode code, FileDeliveryStatus status, FileDeliveryCode delivCode) : id(std::move(id)), condCode(code), status(status), deliveryCode(delivCode) {} TransactionId id; ConditionCode condCode; FileDeliveryStatus status; FileDeliveryCode deliveryCode; std::vector fsResponses; StatusReportIF* statusReport = nullptr; }; struct MetadataRecvdParams { TransactionId id; EntityId sourceId; size_t fileSize; const char* sourceFileName; const char* destFileName; std::vector msgsToUser; }; struct FileSegmentRecvdParams { TransactionId id; size_t offset; size_t length; std::optional recContState = std::nullopt; std::pair segmentMetadata; }; class UserBase { public: /** * @brief Base class which provides a user interface to interact with CFDP handlers. * * @details * This class is also used to pass the Virtual Filestore (VFS) Implementation to the CFDP * handlers so the filestore operations can be mapped to the underlying filestore. * * It is used by implementing it in a child class and then passing it to the CFDP * handler objects. The base class provides default implementation for the user indication * primitives specified in the CFDP standard. The user can override these implementations * to provide custom indication handlers. * @param vfs Virtual Filestore Object. Will be used for all file operations */ explicit UserBase(HasFileSystemIF& vfs); virtual void transactionIndication(TransactionId id) = 0; virtual void eofSentIndication(TransactionId id) = 0; virtual void transactionFinishedIndication(TransactionFinishedParams params) = 0; virtual void metadataRecvdIndication(MetadataRecvdParams params) = 0; virtual void fileSegmentRecvdIndication(FileSegmentRecvdParams params) = 0; virtual void reportIndication(TransactionId id, StatusReportIF& report) = 0; virtual void suspendedIndication(TransactionId id, ConditionCode code) = 0; virtual void resumedIndication(TransactionId id, size_t progress) = 0; virtual void faultIndication(TransactionId id, ConditionCode code, size_t progress) = 0; virtual void abandonedIndication(TransactionId id, ConditionCode code, size_t progress) = 0; virtual void eofRecvIndication(TransactionId id) = 0; private: HasFileSystemIF& vfs; }; } // namespace cfdp #endif // FSFW_CFDP_USERBASE_H