File: Guard.hh

package info (click to toggle)
3dwm 0.3.1-8
  • links: PTS
  • area: main
  • in suites: woody
  • size: 3,368 kB
  • ctags: 2,547
  • sloc: cpp: 11,981; sh: 7,850; ansic: 851; makefile: 287; yacc: 135; lex: 92
file content (73 lines) | stat: -rw-r--r-- 2,244 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/* ------------------------------------------------------------------------
 * $Id: Guard.hh,v 1.3 2001/06/29 15:00:38 elm Exp $
 *
 * This file is part of 3Dwm: The Three-Dimensional User Environment.
 *
 * 3Dwm: The Three-Dimensional User Environment:
 *	<http://www.3dwm.org>
 *
 * Chalmers Medialab
 * 	<http://www.medialab.chalmers.se>
 * 
 * ------------------------------------------------------------------------
 * File created 2001-04-29 by Niklas Elmqvist.
 *
 * Copyright (c) 2001 Niklas Elmqvist <elm@3dwm.org>.
 * ------------------------------------------------------------------------
 * This library 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 2.1 of the License, or (at your option) any later version.
 * 
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 * ------------------------------------------------------------------------
 */

#ifndef _Guard_hh_
#define _Guard_hh_

// -- Class Declarations

/**
 * Guard template class used for enforcing mutual exclusion of
 * critical areas in a code segment. This class is designed to use any
 * class that supports the lock()/unlock() methods to effect mutual
 * exclusion in the scope of the Guard object. 
 **/
template <class T>
class Guard {
public:
    
    /**
     * Constructor. This will lock the passed mutex or semaphore.
     * 
     * @param t entity to use to protect the section.
     **/
    Guard(T &t) : _t(t) {
	_t.lock();
    }
    
    /**
     * Destructor. This will unlock the mutual exclusion entity (from
     * before).
     **/
    ~Guard() {
	_t.unlock();
    }

private:
    Guard(const Guard<T> &s);
    Guard &operator = (const Guard &);
    
    T &_t;
};

#endif /* Guard.hh */