mirror of
https://github.com/esp8266/Arduino.git
synced 2025-04-22 21:23:07 +03:00
40e1f02ffb
- Improve mutex handling. - Move verifyEncryptionRequestHmac function from JsonTranslator to EspnowEncryptionBroker. - Remove UtilityMethods.cpp.
84 lines
2.9 KiB
C++
84 lines
2.9 KiB
C++
/*
|
|
* Copyright (C) 2019 Anders Löfgren
|
|
*
|
|
* License (MIT license):
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef __MUTEXTRACKER_H__
|
|
#define __MUTEXTRACKER_H__
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
|
|
/**
|
|
* A SLIM (Scope LImited Manager)/Scope-Bound Resource Management/RAII class to manage the state of a mutex.
|
|
*/
|
|
class MutexTracker
|
|
{
|
|
public:
|
|
|
|
/**
|
|
* Attempts to capture the mutex. Use the mutexCaptured() method to check success.
|
|
*/
|
|
MutexTracker(const std::shared_ptr<bool> &mutexToCapture);
|
|
|
|
/**
|
|
* Attempts to capture the mutex. Use the mutexCaptured() method to check success.
|
|
*
|
|
* @param destructorHook A function to hook into the MutexTracker destructor. Will be called when the MutexTracker instance is being destroyed, after the mutex has been released.
|
|
*/
|
|
MutexTracker(const std::shared_ptr<bool> &mutexToCapture, const std::function<void()> destructorHook);
|
|
|
|
~MutexTracker();
|
|
|
|
/*
|
|
* If captureBan is active, trying to capture a mutex will always fail.
|
|
* Inactive by default.
|
|
* captureBan can be managed by MutexTracker like any other mutex.
|
|
*/
|
|
static MutexTracker captureBan();
|
|
static MutexTracker captureBan(const std::function<void()> destructorHook);
|
|
|
|
bool mutexCaptured() const;
|
|
|
|
/**
|
|
* Set the mutex free to roam the binary plains, giving new MutexTrackers a chance to capture it.
|
|
*/
|
|
void releaseMutex();
|
|
|
|
private:
|
|
|
|
std::shared_ptr<bool> _capturedMutex;
|
|
std::function<void()> _destructorHook = [](){ };
|
|
|
|
static bool mutexFree(const std::shared_ptr<bool> &mutex);
|
|
static bool mutexCaptured(const std::shared_ptr<bool> &mutex);
|
|
|
|
/**
|
|
* Attempt to capture the mutex.
|
|
*
|
|
* @return True if mutex was caught (meaning it exists and no other instance is holding the mutex). False otherwise.
|
|
*/
|
|
bool attemptMutexCapture(const std::shared_ptr<bool> &mutexToCapture);
|
|
};
|
|
|
|
#endif
|