Mutex.h

Go to the documentation of this file.

/*********************************************************\
 *  File: Mutex.h                                        *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_MUTEX_H__
#define __PLCORE_MUTEX_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/PLCore.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLCore {


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
class MutexImpl;


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Mutex (Mutual Exclusion, binary semaphore) class
*
*  @note
*    - Implementation of the bridge design pattern, this class is the abstraction
*    - The mutex is non-recursive, meaning that you have to be careful to avoid creating a "self-deadlock" by calling the lock method
*      multiple times directly or indirectly by other method calls
*    - It's a good idea to lock/unlock a mutex by using the MutexGuard helper class on the runtime stack so there's always an unlock for each lock!
*/
class Mutex {


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @note
        *    - A new constructed mutex is unlocked by default
        */
        PLCORE_API Mutex();

        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] bCriticalSection
        *    If supported by the platform: 'true' to use "Critical Section" (lock/unlock only inside the same process) instead of "Mutex" (lock/unlock across multiple processes) implementation, else 'false'
        *
        *  @remarks
        *    Platforms handle mutual exclusion implementations differently. POSIX only offers "Mutex", while MS Windows
        *    makes a difference between "Mutex" (lock/unlock across multiple processes) and "Critical Section"
        *    (lock/unlock only inside the same process).
        *
        *  @note
        *    - A new constructed mutex is unlocked by default
        */
        PLCORE_API Mutex(bool bCriticalSection);

        /**
        *  @brief
        *    Destructor
        */
        PLCORE_API ~Mutex();

        /**
        *  @brief
        *    Locks the mutex
        *
        *  @return
        *    'true' if successful, 'false' on error
        *
        *  @note
        *    - Blocking if already locked
        *    - Use the lock method with a timeout to avoid potential deadlocks
        *    - In the literature, this operation is also known as "acquire"
        */
        inline bool Lock();

        /**
        *  @brief
        *    Locks the mutex, but only wait until timeout
        *
        *  @param[in] nTimeout
        *    Timeout in milliseconds
        *
        *  @return
        *    'true' if successful, 'false' on error
        *
        *  @note
        *    - 'nTimeout = 0' means: Return immediately if already locked
        *
        *  @see
        *    - Lock()
        */
        inline bool TryLock(uint64 nTimeout);

        /**
        *  @brief
        *    Unlocks the mutex
        *
        *  @return
        *    'true' if successful, 'false' on error
        *
        *  @note
        *    - In the literature, this operation is also known as "release"
        */
        inline bool Unlock();


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Copy constructor
        *
        *  @param[in] cSource
        *    Source to copy from
        */
        Mutex(const Mutex &cSource);

        /**
        *  @brief
        *    Copy operator
        *
        *  @param[in] cSource
        *    Source to copy from
        *
        *  @return
        *    Reference to this instance
        */
        Mutex &operator =(const Mutex &cSource);


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        MutexImpl *m_pMutexImpl;    /**< Pointer to the system specific implementation (assumed to be never a null pointer!) */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLCore


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLCore/System/Mutex.inl"


#endif // __PLCORE_MUTEX_H__