← 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/PriorityInheritanceMutex.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/PriorityInheritanceMutex.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 __ZTPRIORITYINHERITANCEMUTEX_H__
 
24
#define __ZTPRIORITYINHERITANCEMUTEX_H__
 
25
 
 
26
#include "zthread/Lockable.h"
 
27
#include "zthread/NonCopyable.h"
 
28
 
 
29
namespace ZThread { 
 
30
  
 
31
  class PriorityInheritanceMutexImpl;
 
32
 
 
33
  /**
 
34
   * @class PriorityInheritanceMutex
 
35
   *
 
36
   * @author Eric Crahen <http://www.code-foo.com>
 
37
   * @date <2003-07-16T19:37:36-0400>
 
38
   * @version 2.2.1
 
39
   *
 
40
   * A PriorityInheritanceMutex is similar to a PriorityMutex, it is a non-reentrant, 
 
41
   * priority sensitive MUTual EXclusion Lockable object. It differs only in its 
 
42
   * scheduling policy.
 
43
   *
 
44
   * @see PriorityMutex
 
45
   *
 
46
   * <b>Scheduling</b>
 
47
   *
 
48
   * Threads competing to acquire() a PriorityInheritanceMutex are granted access in 
 
49
   * order of priority. Threads with a higher priority will be given access first.
 
50
   *
 
51
   * When a higher priority thread tries to acquire() a PriorityInheritanceMutex and is 
 
52
   * about to be blocked by a lower priority thread that has already acquire()d it, the
 
53
   * lower priority thread will temporarily have its effective priority raised to that 
 
54
   * of the higher priority thread until it release()s the mutex; at which point its 
 
55
   * previous priority will be restored. 
 
56
   */
 
57
  class ZTHREAD_API PriorityInheritanceMutex : public Lockable, private NonCopyable {
 
58
  
 
59
    PriorityInheritanceMutexImpl* _impl;
 
60
  
 
61
  public:
 
62
 
 
63
    /**
 
64
     * @see Mutex::Mutex()
 
65
     */
 
66
    PriorityInheritanceMutex();
 
67
 
 
68
    /**
 
69
     * @see Mutex::~Mutex()
 
70
     */
 
71
    virtual ~PriorityInheritanceMutex();
 
72
  
 
73
    /**
 
74
     * @see Mutex::acquire()
 
75
     */
 
76
    virtual void acquire(); 
 
77
 
 
78
    /**
 
79
     * @see Mutex::tryAcquire(unsigned long timeout)
 
80
     */
 
81
    virtual bool tryAcquire(unsigned long timeout); 
 
82
  
 
83
    /**
 
84
     * @see Mutex::release()
 
85
     */
 
86
    virtual void release();
 
87
  
 
88
  }; 
 
89
 
 
90
 
 
91
} // namespace ZThread
 
92
 
 
93
#endif // __ZTPRIORITYINHERITANCEMUTEX_H__