synchronised.hpp

//
//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2010-2015 Joerg Henrichs
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
#ifndef HEADER_SYNCHRONISED_HPP
#define HEADER_SYNCHRONISED_HPP
 
#include <mutex>
 
template<typename TYPE>
class Synchronised
{
private:
    mutable std::mutex       m_mutex;
    TYPE                     m_data;
public:
    // ------------------------------------------------------------------------
    Synchronised() : m_data()
    {
    }   // Synchronised()
 
    // ------------------------------------------------------------------------
    Synchronised(const TYPE &v)
    {
        m_data = v;
    }   // Synchronised
 
    // ------------------------------------------------------------------------
    ~Synchronised()
    {
    }   // ~Synchronised
 
    // ------------------------------------------------------------------------
    void setAtomic(const TYPE &v)
    {
        std::lock_guard<std::mutex> lock(m_mutex);
        m_data = v;
    }   // set
 
    // ------------------------------------------------------------------------
    TYPE getAtomic() const
    {
        TYPE v;
        std::unique_lock<std::mutex> ul(m_mutex);
        v = m_data;
        ul.unlock();
        return v;
    }   // get
    // ------------------------------------------------------------------------
    TYPE &getData()
    {
        return m_data;
    }   // getData
    // ------------------------------------------------------------------------
    const TYPE &getData() const
    {
        return m_data;
    }   // getData
    // ------------------------------------------------------------------------
    void lock() const { m_mutex.lock(); }
    // ------------------------------------------------------------------------
    void unlock() const { m_mutex.unlock(); }
    // ------------------------------------------------------------------------
    std::unique_lock<std::mutex> acquireMutex() const
                              { return std::unique_lock<std::mutex>(m_mutex); }
private:
    // Make sure that no actual copying is taking place
    // ------------------------------------------------------------------------
    void operator=(const Synchronised<TYPE>& v) {}
};
 
#endif