Chat-O-Matic/libs/libgloox/mutexguard.h

/*
  Copyright (c) 2007-2015 by Jakob Schröter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox

  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.

  This software is distributed without any warranty.
*/


#ifndef MUTEXGUARD_H__
#define MUTEXGUARD_H__

#include "mutex.h"

namespace gloox
{

  namespace util
  {

    /**
     * @brief A simple implementation of a mutex guard.
     *
     * @author Jakob Schröter <js@camaya.net>
     * @since 0.9
     */
    class GLOOX_API MutexGuard
    {
      public:
        /**
         * Contructs a new simple mutex guard and locks the supplied Mutex.
         * @param mutex The Mutex to guard.
         */
        MutexGuard( Mutex* mutex ) : m_mutex( *mutex ) { if( mutex ) m_mutex.lock(); }

        /**
         * Contructs a new simple mutex guard and locks the supplied Mutex.
         * @param mutex The Mutex to guard.
         */
        MutexGuard( Mutex& mutex ) : m_mutex( mutex ) { m_mutex.lock(); }

        /**
         * Destructor. Releases the guarded Mutex.
         */
        ~MutexGuard() { m_mutex.unlock(); }

      private:
        MutexGuard& operator=( const MutexGuard& );
        Mutex& m_mutex;

  };

  }

}

#endif // MUTEXGUARD_H__