001:
002:
003:
004:
005:
006:
007:
008:
009:
010:
011:
012:
013:
014:
015:
016:
017:
018:
019:
020:
021:
022:
023:
024:
025:
026:
027:
028:
029:
030:
031:
032:
033:
034:
035:
036:
037:
038:
039:
040:
041:
042:
043:
044:
045:
046:
047:
048:
049:
050:
051:
052:
053:
054:
055:
056:
057:
058:
059:
060:
061:
062:
063:
064:
065:
066:
067:
068:
069:
070:
071:
072:
073:
074:
075:
076:
077:
078:
079:
080:
081:
082:
083:
084:
085:
086:
087:
088:
089:
090:
091:
092:
093:
094:
095:
096:
097:
098:
099:
100:
101:
102:
103:
104:
105:
106:
107:
108:
109:
110:
111:
112:
113:
114:
115:
116:
117:
118:
119:
120:
121:
122:
123:
124:
125:
126:
127:
128:
129:
130:
131:
132:
133:
134:
135:
136:
137:
138:
139:
140:
141:
142:
143:
144:
145:
146:
147:
148:
149:
150:
151:
152:
153:
154:
155:
156:
157:
158:
159:
160:
161:
162:
163:
164:
165:
166:
167:
168:
169:
170:
171:
172:
173:
174:
175:
176:
177:
178:
179:
180:
181:
182:
183:
184:
185:
186:
187:
188:
189:
190:
191:
192:
193:
194:
195:
196:
197:
198:
/*
* Copyright (c), Zeriph Enterprises
* All rights reserved.
*
* Contributor(s):
* Zechariah Perez, omni (at) zeriph (dot) com
*
* THIS SOFTWARE IS PROVIDED BY ZERIPH AND CONTRIBUTORS "AS IS" AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ZERIPH AND CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#if !defined(OMNI_AUTO_LOCK_HPP)
#define OMNI_AUTO_LOCK_HPP 1
#include <omni/defs/global.hpp>
#include <omni/sync/lock.hpp>
namespace omni {
namespace sync {
template < typename T >
class auto_lock
{
public:
explicit auto_lock(T* l) : m_hndl(l)
{
if (this->m_hndl) { this->m_hndl->lock(); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception())
}
}
~auto_lock()
{
if (this->m_hndl) { this->m_hndl->unlock(); }
}
const T* handle() const
{
return this->m_hndl;
}
void lock()
{
if (this->m_hndl) { this->m_hndl->lock(); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
}
bool lock(uint32_t timeout_ms)
{
if (this->m_hndl) { return this->m_hndl->lock(timeout_ms); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
return false;
}
bool trylock()
{
if (this->m_hndl) { return this->m_hndl->trylock(); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
return false;
}
void unlock()
{
if (this->m_hndl) { this->m_hndl->unlock(); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
}
bool operator==(const auto_lock& o) const
{
return (this->m_hndl == o.m_hndl);
}
bool operator==(const T& o) const
{
return (this->m_hndl == &o);
}
bool operator!=(const auto_lock& o) const
{
return !(this->m_hndl == o.m_hndl);
}
bool operator!=(const T& o) const
{
return !(this->m_hndl == &o);
}
private:
auto_lock();
auto_lock(const auto_lock& cp);
auto_lock& operator=(const auto_lock& cp);
T* m_hndl;
};
template <>
class auto_lock <omni::sync::mutex_t>
{
public:
explicit auto_lock(omni::sync::mutex_t* m) : m_hndl(m)
{
if (this->m_hndl) { omni::sync::mutex_lock(*this->m_hndl); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
}
~auto_lock()
{
if (this->m_hndl) { omni::sync::mutex_unlock(*this->m_hndl); }
// don't error on destruction
}
const omni::sync::mutex_t* handle() const
{
return this->m_hndl;
}
void lock()
{
if (this->m_hndl) { omni::sync::mutex_lock(*this->m_hndl); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
}
bool lock(uint32_t timeout_ms)
{
if (this->m_hndl) { return omni::sync::mutex_lock(*this->m_hndl, timeout_ms); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
return false;
}
bool trylock()
{
if (this->m_hndl) { return omni::sync::mutex_trylock(*this->m_hndl); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
return false;
}
void unlock()
{
if (this->m_hndl) { omni::sync::mutex_unlock(*this->m_hndl); }
else {
OMNI_ERR_FW("invalid pointer", omni::exceptions::null_pointer_exception());
}
}
bool operator==(const auto_lock& o) const
{
return (this->m_hndl == o.m_hndl);
}
bool operator==(const omni::sync::mutex_t& o) const
{
return (this->m_hndl == &o);
}
bool operator!=(const auto_lock& o) const
{
return !(this->m_hndl == o.m_hndl);
}
bool operator!=(const omni::sync::mutex_t& o) const
{
return !(this->m_hndl == &o);
}
private:
auto_lock();
auto_lock(const auto_lock& cp);
auto_lock& operator=(const auto_lock& cp);
omni::sync::mutex_t* m_hndl;
};
}
}
#endif // OMNI_AUTO_LOCK_HPP