fsfw/storagemanager/PoolManager.h

57 lines
1.6 KiB
C
Raw Normal View History

2020-09-29 14:42:48 +02:00
#ifndef FSFW_STORAGEMANAGER_POOLMANAGER_H_
#define FSFW_STORAGEMANAGER_POOLMANAGER_H_
2020-08-13 20:53:35 +02:00
#include "LocalPool.h"
2020-09-29 14:42:48 +02:00
#include "StorageAccessor.h"
2020-08-13 20:53:35 +02:00
#include "../ipc/MutexHelper.h"
/**
* @brief The PoolManager class provides an intermediate data storage with
* a fixed pool size policy for inter-process communication.
* @details Uses local pool calls but is thread safe by protecting the call
* with a lock.
2020-05-29 16:48:53 +02:00
* @author Bastian Baetz
*/
template <uint8_t NUMBER_OF_POOLS = 5>
class PoolManager : public LocalPool<NUMBER_OF_POOLS> {
public:
PoolManager(object_id_t setObjectId,
const uint16_t element_sizes[NUMBER_OF_POOLS],
const uint16_t n_elements[NUMBER_OF_POOLS]);
2020-09-29 14:42:48 +02:00
/**
* @brief In the PoolManager's destructor all allocated memory
* is freed.
*/
virtual ~PoolManager();
2020-09-29 14:42:48 +02:00
/**
* @brief LocalPool overrides for thread-safety. Decorator function
* which wraps LocalPool calls with a mutex protection.
*/
ReturnValue_t deleteData(store_address_t) override;
ReturnValue_t deleteData(uint8_t* buffer, size_t size,
store_address_t* storeId = nullptr) override;
2020-06-04 15:03:29 +02:00
2020-09-29 14:50:16 +02:00
void setMutexTimeout(uint32_t mutexTimeoutMs);
protected:
2020-06-23 11:06:54 +02:00
//! Default mutex timeout value to prevent permanent blocking.
2020-09-29 14:50:16 +02:00
uint32_t mutexTimeoutMs = 20;
2020-06-23 11:06:54 +02:00
ReturnValue_t reserveSpace(const uint32_t size, store_address_t* address,
bool ignoreFault) override;
/**
* @brief The mutex is created in the constructor and makes
* access mutual exclusive.
* @details Locking and unlocking is done during searching for free slots
* and deleting existing slots.
*/
MutexIF* mutex;
};
#include "PoolManager.tpp"
2020-09-29 14:42:48 +02:00
#endif /* FSFW_STORAGEMANAGER_POOLMANAGER_H_ */