2022-08-09 15:46:42 +02:00
|
|
|
#ifndef FSFW_CFDP_USERBASE_H
|
|
|
|
#define FSFW_CFDP_USERBASE_H
|
|
|
|
|
2022-08-09 21:03:56 +02:00
|
|
|
#include <optional>
|
|
|
|
#include <utility>
|
2022-08-10 09:39:57 +02:00
|
|
|
#include <vector>
|
2022-08-09 21:03:56 +02:00
|
|
|
|
|
|
|
#include "StatusReportIF.h"
|
2022-08-09 18:51:44 +02:00
|
|
|
#include "fsfw/cfdp/VarLenFields.h"
|
2022-08-09 21:03:56 +02:00
|
|
|
#include "fsfw/cfdp/tlv/FilestoreResponseTlv.h"
|
|
|
|
#include "fsfw/cfdp/tlv/MessageToUserTlv.h"
|
2022-08-09 16:36:35 +02:00
|
|
|
#include "fsfw/filesystem/HasFileSystemIF.h"
|
2022-08-09 15:46:42 +02:00
|
|
|
|
|
|
|
namespace cfdp {
|
|
|
|
|
2022-08-10 09:39:57 +02:00
|
|
|
void testFunc();
|
|
|
|
|
2022-08-09 21:03:56 +02:00
|
|
|
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::pair<uint8_t, FilestoreResponseTlv**> fsResponses;
|
|
|
|
StatusReportIF* statusReport = nullptr;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct MetadataRecvParams {
|
|
|
|
TransactionId id;
|
|
|
|
EntityId sourceId;
|
|
|
|
size_t fileSize;
|
|
|
|
const char* sourceFileName;
|
|
|
|
const char* destFileName;
|
2022-08-10 09:39:57 +02:00
|
|
|
std::vector<MessageToUserTlv*> msgsToUser;
|
|
|
|
// std::pair<uint8_t, MessageToUserTlv**> msgsToUser;
|
2022-08-09 21:03:56 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct FileSegmentRecvdParams {
|
|
|
|
TransactionId id;
|
|
|
|
size_t offset;
|
|
|
|
size_t length;
|
|
|
|
std::optional<RecordContinuationState> recContState = std::nullopt;
|
|
|
|
std::pair<const uint8_t*, size_t> segmentMetadata;
|
|
|
|
};
|
|
|
|
|
2022-08-09 15:46:42 +02:00
|
|
|
class UserBase {
|
|
|
|
public:
|
2022-08-09 15:51:01 +02:00
|
|
|
/**
|
2022-08-09 16:18:45 +02:00
|
|
|
* @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
|
2022-08-09 15:51:01 +02:00
|
|
|
* handlers so the filestore operations can be mapped to the underlying filestore.
|
2022-08-09 16:18:45 +02:00
|
|
|
*
|
|
|
|
* 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.
|
2022-08-09 15:51:01 +02:00
|
|
|
* @param vfs Virtual Filestore Object. Will be used for all file operations
|
|
|
|
*/
|
2022-08-09 15:46:42 +02:00
|
|
|
explicit UserBase(HasFileSystemIF& vfs);
|
|
|
|
|
2022-08-09 18:51:44 +02:00
|
|
|
virtual void transactionIndication(TransactionId id) = 0;
|
|
|
|
virtual void eofSentIndication(TransactionId id) = 0;
|
|
|
|
|
|
|
|
virtual void abandonedIndication(TransactionId id, ConditionCode code, uint64_t progress) = 0;
|
|
|
|
virtual void eofRecvIndication(TransactionId id) = 0;
|
|
|
|
|
|
|
|
// TODO: Parameters
|
2022-08-09 21:03:56 +02:00
|
|
|
virtual void transactionFinishedIndication(TransactionFinishedParams params) = 0;
|
|
|
|
virtual void metadataRecvdIndication(MetadataRecvParams params) = 0;
|
|
|
|
virtual void fileSegmentRecvdIndication(FileSegmentRecvdParams params) = 0;
|
2022-08-09 18:51:44 +02:00
|
|
|
virtual void reportIndication() = 0;
|
|
|
|
virtual void suspendedIndication() = 0;
|
|
|
|
virtual void resumedIndication() = 0;
|
|
|
|
|
2022-08-09 15:46:42 +02:00
|
|
|
private:
|
|
|
|
HasFileSystemIF& vfs;
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace cfdp
|
|
|
|
|
|
|
|
#endif // FSFW_CFDP_USERBASE_H
|