/usr/include/zthread/Lockable.h is in libzthread-dev 2.3.2-7ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 | /*
* Copyright (c) 2005, Eric Crahen
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is furnished
* to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*
*/
#ifndef __ZTLOCKABLE_H__
#define __ZTLOCKABLE_H__
#include "zthread/Exceptions.h"
namespace ZThread {
/**
* @class Lockable
* @author Eric Crahen <http://www.code-foo.com>
* @date <2003-07-16T10:33:32-0400>
* @version 2.3.0
*
* The Lockable interface defines a common method of adding general <i>acquire-release</i>
* semantics to an object. An <i>acquire-release</i> protocol does not necessarily imply
* exclusive access.
*/
class Lockable {
public:
//! Destroy a Lockable object.
virtual ~Lockable() {}
/**
* Acquire the Lockable object.
*
* This method may or may not block the caller for an indefinite amount
* of time. Those details are defined by specializations of this class.
*
* @exception Interrupted_Exception thrown if the calling thread is interrupted before
* the operation completes.
*
* @post The Lockable is acquired only if no exception was thrown.
*/
virtual void acquire() = 0;
/**
* Attempt to acquire the Lockable object.
*
* This method may or may not block the caller for a definite amount
* of time. Those details are defined by specializations of this class;
* however, this method includes a timeout value that can be used to
* limit the maximum amount of time that a specialization <i>could</i> block.
*
* @param timeout - maximum amount of time (milliseconds) this method could block
*
* @return
* - <em>true</em> if the operation completes and the Lockable is acquired before
* the timeout expires.
* - <em>false</em> if the operation times out before the Lockable can be acquired.
*
* @exception Interrupted_Exception thrown if the calling thread is interrupted before
* the operation completes.
*
* @post The Lockable is acquired only if no exception was thrown.
*/
virtual bool tryAcquire(unsigned long timeout) = 0;
/**
* Release the Lockable object.
*
* This method may or may not block the caller for an indefinite amount
* of time. Those details are defined by specializations of this class.
*
* @post The Lockable is released only if no exception was thrown.
*/
virtual void release() = 0;
};
} // namespace ZThread
#endif // __ZTLOCKABLE_H__
|