File: MutexGuard.h

package info (click to toggle)
kwave 0.7.2-5
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 9,048 kB
  • ctags: 4,906
  • sloc: cpp: 31,275; ansic: 13,111; sh: 9,511; perl: 2,724; makefile: 786; asm: 145
file content (58 lines) | stat: -rw-r--r-- 2,008 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
/***************************************************************************
    mt/MutexGuard.h  -  Guard class for Synchronization by Mutal Exclusion
                             -------------------
    begin                : Tue Oct 3 2000
    copyright            : (C) 2000 by Thomas Eschenbacher
    email                : Thomas.Eschenbacher@gmx.de
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef _MUTEX_GUARD_H_
#define _MUTEX_GUARD_H_

#include "config.h"
#include "mt/TSS_Object.h"

class Mutex;

/**
 * @class MutexGuard
 * Implements an easy-to-use guard class for a simple mutal
 * exclusive locking for multithreaded applications. This should be used
 * prior to directly using a Mutex because it also supports asynchronous
 * thread exits through the TSS_Object class.
 *
 * @author Thomas Eschenbacher <Thomas.Eschenbacher@gmx.de>
 * @date 2000-10-03
 */
class MutexGuard: public TSS_Object
{

public:
    /**
     * Constructor, takes a Mutex object and automatically locks it
     * @param lock the mutex to be locked
     */
    MutexGuard(Mutex &lock);

    /**
     * Destructor, automatically releases (unlocks) the lock.
     */
    virtual ~MutexGuard();

private:
    /** the mutex to be locked */
    Mutex &m_lock;
};

#endif // _MUTEX_GUARD_H_

//***************************************************************************