Started documentation overhaul in doc/www
[barry/pauldeden.git] / src / scoped_lock.h
blobbdf0860ac5c1be7c6ffd734fe3f94c159ca0cb94
1 ///
2 /// \file scoped_lock.h
3 /// Simple scope class for dealing with pthread mutex locking.
4 ///
6 /*
7 Copyright (C) 2008, Net Direct Inc. (http://www.netdirect.ca/)
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
18 See the GNU General Public License in the COPYING file at the
19 root directory of this project for more details.
22 #ifndef __BARRY_SCOPED_LOCK_H__
23 #define __BARRY_SCOPED_LOCK_H__
25 #include <pthread.h>
27 namespace Barry {
29 class scoped_lock
31 pthread_mutex_t *m_mutex;
33 public:
34 scoped_lock(pthread_mutex_t &mutex)
35 : m_mutex(&mutex)
37 while( pthread_mutex_lock(m_mutex) != 0 )
41 ~scoped_lock()
43 unlock();
46 void unlock()
48 if( m_mutex ) {
49 pthread_mutex_unlock(m_mutex);
50 m_mutex = 0;
55 } // namespace Barry
57 #endif