← Back to branch summary

~ubuntu-branches/ubuntu/trusty/hugin/trusty-proposed

« back to all changes in this revision

Viewing changes to src/foreign/zthread/include/zthread/Lockable.h

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Metzler
  • Date: 2011-01-06 14:28:24 UTC
  • mfrom: (1.1.9 upstream) (0.1.21 experimental)
  • Revision ID: james.westby@ubuntu.com-20110106142824-zn9lxylg5z44dynn
* Drop Cyril Brulebois from Uploaders. Thank you very much for your work.
* Bump package version. (rc3 was re-released as 2010.4.0).

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/foreign/zthread/include/zthread/Lockable.h
 
1
/*
 
2
 * Copyright (c) 2005, Eric Crahen
 
3
 *
 
4
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 
5
 * of this software and associated documentation files (the "Software"), to deal
 
6
 * in the Software without restriction, including without limitation the rights
 
7
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
8
 * copies of the Software, and to permit persons to whom the Software is furnished
 
9
 * to do so, subject to the following conditions:
 
10
 *
 
11
 * The above copyright notice and this permission notice shall be included in all
 
12
 * copies or substantial portions of the Software.
 
13
 *
 
14
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
15
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
16
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
17
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 
18
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 
19
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
20
 *
 
21
 */
 
22
 
 
23
#ifndef __ZTLOCKABLE_H__
 
24
#define __ZTLOCKABLE_H__
 
25
 
 
26
#include "zthread/Exceptions.h"
 
27
 
 
28
namespace ZThread { 
 
29
 
 
30
  /**
 
31
   * @class Lockable
 
32
   * @author Eric Crahen <http://www.code-foo.com>
 
33
   * @date <2003-07-16T10:33:32-0400>
 
34
   * @version 2.3.0
 
35
   *
 
36
   * The Lockable interface defines a common method of adding general <i>acquire-release</i> 
 
37
   * semantics to an object. An <i>acquire-release</i> protocol does not necessarily imply 
 
38
   * exclusive access. 
 
39
   */
 
40
  class Lockable {
 
41
  public:  
 
42
  
 
43
    //! Destroy a Lockable object.
 
44
    virtual ~Lockable() {}
 
45
 
 
46
    /** 
 
47
     * Acquire the Lockable object. 
 
48
     *
 
49
     * This method may or may not block the caller for an indefinite amount
 
50
     * of time. Those details are defined by specializations of this class.
 
51
     *
 
52
     * @exception Interrupted_Exception thrown if the calling thread is interrupted before
 
53
     *            the operation completes.
 
54
     *
 
55
     * @post The Lockable is acquired only if no exception was thrown. 
 
56
     */
 
57
    virtual void acquire() = 0;
 
58
 
 
59
    /** 
 
60
     * Attempt to acquire the Lockable object. 
 
61
     *
 
62
     * This method may or may not block the caller for a definite amount
 
63
     * of time. Those details are defined by specializations of this class;
 
64
     * however, this method includes a timeout value that can be used to 
 
65
     * limit the maximum amount of time that a specialization <i>could</i> block. 
 
66
     *
 
67
     * @param timeout - maximum amount of time (milliseconds) this method could block
 
68
     *
 
69
     * @return 
 
70
     *   - <em>true</em>  if the operation completes and the Lockable is acquired before 
 
71
     *     the timeout expires. 
 
72
     *   - <em>false</em> if the operation times out before the Lockable can be acquired.
 
73
     * 
 
74
     * @exception Interrupted_Exception thrown if the calling thread is interrupted before
 
75
     *            the operation completes.
 
76
     *
 
77
     * @post The Lockable is acquired only if no exception was thrown. 
 
78
     */
 
79
    virtual bool tryAcquire(unsigned long timeout) = 0;
 
80
  
 
81
    /** 
 
82
     * Release the Lockable object.
 
83
     *
 
84
     * This method may or may not block the caller for an indefinite amount
 
85
     * of time. Those details are defined by specializations of this class.
 
86
     *
 
87
     * @post The Lockable is released only if no exception was thrown. 
 
88
     */    
 
89
    virtual void release() = 0;
 
90
 
 
91
  };
 
92
 
 
93
 
 
94
} // namespace ZThread
 
95
 
 
96
#endif // __ZTLOCKABLE_H__