Robin Mueller
5907f8ee9d
This PR adds the packet stack for the CCSDS File Delivery Protocol. It also refactors the existing TMTC infastructure to allow sending of CFDP packets to the CCSDS handlers. This includes the whole PDU (Protocol Data Unit) stack: - File Data PDUs and all file directive PDUs - ACK PDU - NAK PDU - Metadata PDU - Finished PDU - Prompt PDU - Keep Alive PDU - EOF PDU The PR includes a full set of unittests for the packet stack with a coverage of 90+ %. The refactoring of the existing TMTC infastructure includes non-ideal solutions like diamond inheritance. Avoiding this solution would require refactoring the packet stack. This would be a good idea anyway because the existing stack is tightly coupled to the FSFW, making reuse more difficult if only the stack is planned to be used without the store functionalities etc. The PDU implementation provided here is only weakly coupled to the FSFW, only using components like returnvalues or the Serialization modules. There are dedicated serializers and deserializers, which also helps in creating small focused modules which are easy to test. Some of the modules here were provied by Matthias Tompert.
79 lines
2.6 KiB
C++
79 lines
2.6 KiB
C++
#ifndef SERIALBUFFERADAPTER_H_
|
|
#define SERIALBUFFERADAPTER_H_
|
|
|
|
#include "fsfw/serialize/SerializeIF.h"
|
|
#include "fsfw/serialize/SerializeAdapter.h"
|
|
|
|
/**
|
|
* This adapter provides an interface for SerializeIF to serialize or deserialize
|
|
* buffers with no length header but a known size.
|
|
*
|
|
* Additionally, the buffer length can be serialized too and will be put in
|
|
* front of the serialized buffer.
|
|
*
|
|
* Can be used with SerialLinkedListAdapter by declaring a SerializeElement with
|
|
* SerialElement<SerialBufferAdapter<bufferLengthType(will be uint8_t mostly)>>.
|
|
* Right now, the SerialBufferAdapter must always
|
|
* be initialized with the buffer and size !
|
|
*
|
|
* \ingroup serialize
|
|
*/
|
|
template<typename count_t>
|
|
class SerialBufferAdapter: public SerializeIF {
|
|
public:
|
|
|
|
/**
|
|
* Constructor for constant uint8_t buffer. Length field can be serialized optionally.
|
|
* Type of length can be supplied as template type.
|
|
* @param buffer
|
|
* @param bufferLength
|
|
* @param serializeLength
|
|
*/
|
|
SerialBufferAdapter(const uint8_t* buffer, count_t bufferLength,
|
|
bool serializeLength = false);
|
|
|
|
/**
|
|
* Constructor for non-constant uint8_t buffer.
|
|
* Length field can be serialized optionally.
|
|
* Type of length can be supplied as template type.
|
|
* @param buffer
|
|
* @param bufferLength
|
|
* @param serializeLength Length field will be serialized with size count_t
|
|
*/
|
|
SerialBufferAdapter(uint8_t* buffer, count_t bufferLength,
|
|
bool serializeLength = false);
|
|
|
|
virtual ~SerialBufferAdapter();
|
|
|
|
virtual ReturnValue_t serialize(uint8_t** buffer, size_t* size,
|
|
size_t maxSize, Endianness streamEndianness) const override;
|
|
|
|
virtual size_t getSerializedSize() const override;
|
|
|
|
/**
|
|
* @brief This function deserializes a buffer into the member buffer.
|
|
* @details
|
|
* If a length field is present, it is ignored, as the size should have
|
|
* been set in the constructor. If the size is not known beforehand,
|
|
* consider using SerialFixedArrayListAdapter instead.
|
|
* @param buffer [out] Resulting buffer
|
|
* @param size remaining size to deserialize, should be larger than buffer
|
|
* + size field size
|
|
* @param bigEndian
|
|
* @return
|
|
*/
|
|
virtual ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
|
|
Endianness streamEndianness) override;
|
|
|
|
uint8_t * getBuffer();
|
|
const uint8_t * getConstBuffer() const;
|
|
void setBuffer(uint8_t* buffer, count_t bufferLength);
|
|
private:
|
|
bool serializeLength = false;
|
|
const uint8_t *constBuffer = nullptr;
|
|
uint8_t *buffer = nullptr;
|
|
count_t bufferLength = 0;
|
|
};
|
|
|
|
#endif /* SERIALBUFFERADAPTER_H_ */
|