src/common/Mutex.h

/***************************************************************************
 *                                                                         *
 *   LinuxSampler - modular, streaming capable sampler                     *
 *                                                                         *
 *   Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck   *
 *   Copyright (C) 2005, 2006 Christian Schoenebeck                        *
 *                                                                         *
 *   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 2 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 __MUTEX_H__
#define __MUTEX_H__

#if defined(WIN32)
#include <windows.h>
#else
#include <pthread.h>
#endif

#include "global_private.h"

namespace LinuxSampler {

/** @brief Mutual exclusive objects
 *
 * This class provides the classical thread / process synchronisation
 * technique called Mutex. It is used to protect critical sections, that is
 * resources (typically data structures) from being used at the same time by
 * different threads or processes which otherwise might turn into undefined
 * and of course undesired behavior.
 *
 * Note: as this technique might block the calling thread and also implies
 * a system call, this should not be used directly in realtime sensitive
 * threads!
 */
class Mutex {
    public:
        /**
         * Constructor
         */    
        Mutex();

        /**
         * Destructor
         */
        virtual ~Mutex();

        /** @brief Lock this Mutex.
         *
         * If this Mutex object is currently be locked by another thread,
         * then the calling thread will be blocked until the other thread
         * unlocks this Mutex object. The calling thread though can safely
         * call this method several times without danger to be blocked
         * himself.
         *
         * The calling thread should call Unlock() as soon as the critical
         * section was left.
         */      
        void Lock();

        /** @brief Try to lock this Mutex.
         *
         * Same as Lock() except that this method won't block the calling
         * thread in case this Mutex object is currently locked by another
         * thread. So this call will always immediately return and the
         * return value has to be checked if the locking request was
         * successful or not.
         *
         * @returns  true if the Mutex object could be locked, false if the
         *           Mutex is currently locked by another thread
         */
        bool Trylock();

        /** @brief Unlock this Mutex.
         *
         * If other threads are currently blocked and waiting due to a
         * Lock() call, one of them will be awaken.
         */
        void Unlock();
        
    protected:
    #if defined(WIN32)
    HANDLE hMutex;
    #else
        pthread_mutex_t     __posix_mutex;
        pthread_mutexattr_t __posix_mutexattr;
    #endif
};

} // namespace LinuxSampler

#endif // __MUTEX_H__
1	schoenebeck	53	/***************************************************************************
2			* *
3			* LinuxSampler - modular, streaming capable sampler *
4			* *
5	schoenebeck	56	* Copyright (C) 2003, 2004 by Benno Senoner and Christian Schoenebeck *
6	schoenebeck	880	* Copyright (C) 2005, 2006 Christian Schoenebeck *
7	schoenebeck	53	* *
8			* This program is free software; you can redistribute it and/or modify *
9			* it under the terms of the GNU General Public License as published by *
10			* the Free Software Foundation; either version 2 of the License, or *
11			* (at your option) any later version. *
12			* *
13			* This program is distributed in the hope that it will be useful, *
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of *
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
16			* GNU General Public License for more details. *
17			* *
18			* You should have received a copy of the GNU General Public License *
19			* along with this program; if not, write to the Free Software *
20			* Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21			* MA 02111-1307 USA *
22			***************************************************************************/
23
24			#ifndef __MUTEX_H__
25			#define __MUTEX_H__
26
27	senoner	1481	#if defined(WIN32)
28			#include <windows.h>
29			#else
30	schoenebeck	53	#include <pthread.h>
31	senoner	1481	#endif
32	schoenebeck	53
33	nagata	1649	#include "global_private.h"
34
35	schoenebeck	880	namespace LinuxSampler {
36
37	schoenebeck	550	/** @brief Mutual exclusive objects
38			*
39			* This class provides the classical thread / process synchronisation
40			* technique called Mutex. It is used to protect critical sections, that is
41			* resources (typically data structures) from being used at the same time by
42			* different threads or processes which otherwise might turn into undefined
43			* and of course undesired behavior.
44			*
45			* Note: as this technique might block the calling thread and also implies
46			* a system call, this should not be used directly in realtime sensitive
47			* threads!
48			*/
49	schoenebeck	53	class Mutex {
50			public:
51	schoenebeck	550	/**
52			* Constructor
53			*/
54	schoenebeck	53	Mutex();
55	schoenebeck	550
56			/**
57			* Destructor
58			*/
59			virtual ~Mutex();
60
61			/** @brief Lock this Mutex.
62			*
63			* If this Mutex object is currently be locked by another thread,
64			* then the calling thread will be blocked until the other thread
65			* unlocks this Mutex object. The calling thread though can safely
66			* call this method several times without danger to be blocked
67			* himself.
68			*
69			* The calling thread should call Unlock() as soon as the critical
70			* section was left.
71			*/
72	schoenebeck	53	void Lock();
73	schoenebeck	550
74			/** @brief Try to lock this Mutex.
75			*
76			* Same as Lock() except that this method won't block the calling
77			* thread in case this Mutex object is currently locked by another
78			* thread. So this call will always immediately return and the
79			* return value has to be checked if the locking request was
80			* successful or not.
81			*
82			* @returns true if the Mutex object could be locked, false if the
83			* Mutex is currently locked by another thread
84			*/
85	senkov	165	bool Trylock();
86	schoenebeck	550
87			/** @brief Unlock this Mutex.
88			*
89			* If other threads are currently blocked and waiting due to a
90			* Lock() call, one of them will be awaken.
91			*/
92	schoenebeck	53	void Unlock();
93	schoenebeck	550
94	schoenebeck	53	protected:
95	senoner	1481	#if defined(WIN32)
96			HANDLE hMutex;
97			#else
98	schoenebeck	53	pthread_mutex_t __posix_mutex;
99			pthread_mutexattr_t __posix_mutexattr;
100	senoner	1481	#endif
101	schoenebeck	53	};
102
103	schoenebeck	880	} // namespace LinuxSampler
104
105	schoenebeck	53	#endif // __MUTEX_H__