mutex.hpp

Go to the documentation of this file.

/****************************************************************************
 *
 *  Copyright (c) 2017, Michael Becker (michael.f.becker@gmail.com)
 *
 *  This file is part of the FreeRTOS Add-ons project.
 *
 *  Source Code:
 *  https://github.com/michaelbecker/freertos-addons
 *
 *  Project Page:
 *  http://michaelbecker.github.io/freertos-addons/
 *
 *  On-line Documentation:
 *  http://michaelbecker.github.io/freertos-addons/docs/html/index.html
 *
 *  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.
 *  + Credit is appreciated, but not required, if you find this project
 *    useful enough to include in your application, product, device, etc.
 *
 *  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 MUTEX_HPP_
#define MUTEX_HPP_

#ifndef CPP_FREERTOS_NO_EXCEPTIONS
#include <exception>
#include <string>
#include <cstdio>
#ifdef CPP_FREERTOS_NO_CPP_STRINGS
#error "FreeRTOS-Addons require C++ Strings if you are using exceptions"
#endif
#endif
#include "FreeRTOS.h"
#include "semphr.h"

namespace cpp_freertos {


#ifndef CPP_FREERTOS_NO_EXCEPTIONS

class MutexCreateException : public std::exception {

    public:
        MutexCreateException()
        {
            sprintf(errorString, "Mutex Constructor Failed");
        }

        virtual const char *what() const throw()
        {
            return errorString;
        }

    private:
        char errorString[80];
};
#endif


class Mutex {

    //
    //  Public API
    //
    public:
        virtual bool Lock(TickType_t Timeout = portMAX_DELAY) = 0;

        virtual bool Unlock() = 0;

        virtual ~Mutex();

    //
    //  Protected API
    //  Not intended for use by application code.
    //
    protected:
        SemaphoreHandle_t handle;

        Mutex();
};


class MutexStandard : public Mutex {

    //
    //  Public API
    //
    public:
        MutexStandard();

        virtual bool Lock(TickType_t Timeout = portMAX_DELAY);

        virtual bool Unlock();
};


#if (configUSE_RECURSIVE_MUTEXES == 1)

class MutexRecursive : public Mutex {

    //
    //  Public API
    //
    public:
        MutexRecursive();

        virtual bool Lock(TickType_t Timeout = portMAX_DELAY);

        virtual bool Unlock();
};

#endif


class LockGuard {

    //
    //  Public API
    //
    public:
        explicit LockGuard(Mutex& m);

        ~LockGuard();

        //
        //  Private API
        //
    private:
        LockGuard(const LockGuard&);

        Mutex& mutex;
};


}
#endif