xref: /haiku/src/apps/cortex/support/SimpleLockable.h (revision ed24eb5ff12640d052171c6a7feba37fab8a75d1)
1 /*
2  * Copyright (c) 1999-2000, Eric Moon.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions, and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions, and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * 3. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21  * OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
27  * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 
32 // SimpleLockable.h
33 // * PURPOSE
34 //   Basic BLocker implementation of ILockable.
35 //
36 // * HISTORY
37 //   e.moon		7jul99		Cortex rework.
38 //   e.moon		13apr99		Begun (beDub)
39 
40 #ifndef __SimpleLockable_H__
41 #define __SimpleLockable_H__
42 
43 #include "ILockable.h"
44 #include <Locker.h>
45 
46 #include "cortex_defs.h"
47 __BEGIN_CORTEX_NAMESPACE
48 
49 class SimpleLockable :
50 	public ILockable {
51 
52 public:						// *** ctor
53 	virtual ~SimpleLockable() {}
54 	SimpleLockable() {}
55 	SimpleLockable(const char* name) : m_lock(name) {}
56 
57 public:						// *** ILockable impl.
58 	virtual bool lock(
59 		lock_t type=WRITE,
60 		bigtime_t timeout=B_INFINITE_TIMEOUT) {
61 
62 		return m_lock.LockWithTimeout(timeout) == B_OK;
63 	}
64 
65 	virtual bool unlock(
66 		lock_t type=WRITE) {
67 		m_lock.Unlock();
68 		return true;
69 	}
70 
71 	virtual bool isLocked(
72 		lock_t type=WRITE) const {
73 		return m_lock.IsLocked();
74 	}
75 
76 protected:					// members
77 	mutable BLocker		m_lock;
78 };
79 
80 __END_CORTEX_NAMESPACE
81 #endif /*__SimpleLockable_H__*/
82