fsfw/ipc/MutexGuard.h

63 lines
2.0 KiB
C
Raw Normal View History

2018-07-13 18:28:26 +02:00
#ifndef FRAMEWORK_IPC_MUTEXHELPER_H_
#define FRAMEWORK_IPC_MUTEXHELPER_H_
2020-08-13 20:53:35 +02:00
#include "MutexFactory.h"
2021-02-23 14:40:08 +01:00
#include "../serviceinterface/ServiceInterface.h"
2018-07-13 18:28:26 +02:00
2021-03-09 11:25:13 +01:00
class MutexGuard {
2018-07-13 18:28:26 +02:00
public:
2021-03-09 11:25:13 +01:00
MutexGuard(MutexIF* mutex, MutexIF::TimeoutType timeoutType =
2021-02-23 14:40:08 +01:00
MutexIF::TimeoutType::BLOCKING, uint32_t timeoutMs = 0):
internalMutex(mutex) {
if(mutex == nullptr) {
#if FSFW_VERBOSE_LEVEL >= 1
2021-01-03 14:16:52 +01:00
#if FSFW_CPP_OSTREAM_ENABLED == 1
2021-02-23 14:40:08 +01:00
sif::error << "MutexHelper: Passed mutex is invalid!" << std::endl;
#else
sif::printError("MutexHelper: Passed mutex is invalid!\n");
#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
#endif /* FSFW_VERBOSE_LEVEL >= 1 */
return;
}
2021-03-09 11:25:13 +01:00
result = mutex->lockMutex(timeoutType,
2021-02-23 14:40:08 +01:00
timeoutMs);
#if FSFW_VERBOSE_LEVEL >= 1
2021-03-09 11:25:13 +01:00
if(result == MutexIF::MUTEX_TIMEOUT) {
2021-01-03 14:16:52 +01:00
#if FSFW_CPP_OSTREAM_ENABLED == 1
2021-02-23 14:40:08 +01:00
sif::error << "MutexHelper: Lock of mutex failed with timeout of "
<< timeoutMs << " milliseconds!" << std::endl;
#else
sif::printError("MutexHelper: Lock of mutex failed with timeout of %lu milliseconds\n",
timeoutMs);
#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
2018-07-13 18:28:26 +02:00
2021-02-23 14:40:08 +01:00
}
2021-03-09 11:25:13 +01:00
else if(result != HasReturnvaluesIF::RETURN_OK) {
2021-02-23 14:40:08 +01:00
#if FSFW_CPP_OSTREAM_ENABLED == 1
2021-03-09 11:25:13 +01:00
sif::error << "MutexHelper: Lock of Mutex failed with code " << result << std::endl;
2021-02-23 14:40:08 +01:00
#else
sif::printError("MutexHelper: Lock of Mutex failed with code %d\n", status);
#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
}
2021-03-04 20:43:08 +01:00
#else
/* To avoid unused variable warning */
static_cast<void>(status);
2021-02-23 14:40:08 +01:00
#endif /* FSFW_VERBOSE_LEVEL >= 1 */
}
2021-03-09 11:25:13 +01:00
ReturnValue_t getLockResult() const {
return result;
}
~MutexGuard() {
2021-02-23 14:40:08 +01:00
if(internalMutex != nullptr) {
internalMutex->unlockMutex();
}
}
2018-07-13 18:28:26 +02:00
private:
2021-02-23 14:40:08 +01:00
MutexIF* internalMutex;
2021-03-09 11:25:13 +01:00
ReturnValue_t result = HasReturnvaluesIF::RETURN_FAILED;
2018-07-13 18:28:26 +02:00
};
2021-02-23 14:40:08 +01:00
2018-07-13 18:28:26 +02:00
#endif /* FRAMEWORK_IPC_MUTEXHELPER_H_ */