54 lines
1.7 KiB
C++
54 lines
1.7 KiB
C++
#ifndef POOLMANAGER_H_
|
|
#define POOLMANAGER_H_
|
|
|
|
#include <framework/storagemanager/LocalPool.h>
|
|
#include <test/prototypes/StorageAccessor.h>
|
|
|
|
using AccessorPair = std::pair<ReturnValue_t, StorageAccessor>;
|
|
using ConstAccessorPair = std::pair<ReturnValue_t, ConstStorageAccessor>;
|
|
/**
|
|
* @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.
|
|
*/
|
|
template <uint8_t NUMBER_OF_POOLS>
|
|
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]);
|
|
|
|
//! @brief In the PoolManager's destructor all allocated memory is freed.
|
|
virtual ~PoolManager();
|
|
|
|
/**
|
|
* Documentation will follow
|
|
* @param storeAccessor
|
|
* @return
|
|
*/
|
|
AccessorPair modifyData(store_address_t storeId);
|
|
ConstAccessorPair getData(store_address_t storeId);
|
|
|
|
//! @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;
|
|
protected:
|
|
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"
|
|
|
|
#endif /* POOLMANAGER_H_ */
|