Mutex.h

Go to the documentation of this file.

/*
 * Copyright (C) 2006-2011, SRI International (R)
 *
 * This program 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.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#ifndef __OpenKarto_Mutex_h__
#define __OpenKarto_Mutex_h__

#include <OpenKarto/Macros.h>

namespace karto
{




  struct MutexPrivate;
  struct ScopedLockPrivate;

  class KARTO_EXPORT Mutex
  {
  public:
    Mutex();

    ~Mutex();

  public:   
    class KARTO_EXPORT ScopedLock
    {   
    public:   
      ScopedLock();
      
      ScopedLock(Mutex& rMutex);
      ~ScopedLock();

    public:
      void Acquire(Mutex& rMutex);
      
      bool TryAcquire( Mutex& rMutex);
      
      void Release();

    private:
      ScopedLockPrivate* m_pScopedLockPrivate;
    };

  private:
    // restrict the following functions
    Mutex(const Mutex&);   
    void operator=(const Mutex&);   

  private:
    MutexPrivate* m_pMutexPrivate;
  };


}

#endif // __OpenKarto_Mutex_h__