415096c3b2
Improved the docs for the 3 main Tactility projects. I also fixed some inaccuracies and bugs in certain APIs as I went through the code.
52 lines
1.1 KiB
C++
52 lines
1.1 KiB
C++
#pragma once
|
|
|
|
#include "Check.h"
|
|
#include "RtosCompat.h"
|
|
#include <memory>
|
|
|
|
namespace tt {
|
|
|
|
class ScopedLockableUsage;
|
|
|
|
/** Represents a lock/mutex */
|
|
class Lockable {
|
|
public:
|
|
virtual ~Lockable() = default;
|
|
|
|
virtual bool lock(TickType_t timeoutTicks) const = 0;
|
|
|
|
virtual bool unlock() const = 0;
|
|
|
|
std::unique_ptr<ScopedLockableUsage> scoped() const;
|
|
};
|
|
|
|
/**
|
|
* Represents a lockable instance that is scoped to a specific lifecycle.
|
|
* Once the ScopedLockableUsage is destroyed, unlock() is called automatically.
|
|
*
|
|
* In other words:
|
|
* You have to lock() this object manually, but unlock() happens automatically on destruction.
|
|
*/
|
|
class ScopedLockableUsage final : public Lockable {
|
|
|
|
const Lockable& lockable;
|
|
|
|
public:
|
|
|
|
explicit ScopedLockableUsage(const Lockable& lockable) : lockable(lockable) {}
|
|
|
|
~ScopedLockableUsage() final {
|
|
lockable.unlock(); // We don't care whether it succeeded or not
|
|
}
|
|
|
|
bool lock(TickType_t timeout) const override {
|
|
return lockable.lock(timeout);
|
|
}
|
|
|
|
bool unlock() const override {
|
|
return lockable.unlock();
|
|
}
|
|
};
|
|
|
|
}
|