Mercurial > hg > orthanc

annotate OrthancFramework/Sources/MultiThreading/Semaphore.h @ 4106:50cb0fb99e34

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added license headers
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 06 Jul 2020 19:24:22 +0200
parents d5c09b5f882f
children bf7b9edf6b81
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 995
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3483
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
23 *
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 #pragma once
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
36 #include "../OrthancFramework.h"
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
37
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include <boost/noncopyable.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include <boost/thread.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
43 class ORTHANC_PUBLIC Semaphore : public boost::noncopyable
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 {
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 private:
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
46 unsigned int availableResources_;
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 boost::mutex mutex_;
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 boost::condition_variable condition_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
49
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
50 void Release(unsigned int resourceCount = 1);
2794
f790999a250a Semaphore removed from graveyard, SystemToolbox::GetHardwareConcurrency()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2611
diff changeset
51
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
52 void Acquire(unsigned int resourceCount = 1);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
54 bool TryAcquire(unsigned int resourceCount = 1);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 public:
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
56 explicit Semaphore(unsigned int availableResources);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57
3483
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
58 unsigned int GetAvailableResourcesCount() const
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
59 {
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
60 return availableResources_;
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
61 }
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
62
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
63
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
64 class Locker : public boost::noncopyable
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
65 {
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
66 private:
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
67 Semaphore& that_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
68 unsigned int resourceCount_;
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
69
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
70 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
71 explicit Locker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
72 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
73 resourceCount_(resourceCount)
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
74 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
75 that_.Acquire(resourceCount_);
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
76 }
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
77
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
78 ~Locker()
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
79 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
80 that_.Release(resourceCount_);
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
81 }
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
82 };
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
83
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
84 class TryLocker : public boost::noncopyable
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
85 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
86 private:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
87 Semaphore& that_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
88 unsigned int resourceCount_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
89 bool isAcquired_;
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
90
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
91 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
92 explicit TryLocker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
93 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
94 resourceCount_(resourceCount)
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
95 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
96 isAcquired_ = that_.TryAcquire(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
97 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
98
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
99 ~TryLocker()
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
100 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
101 if (isAcquired_)
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
102 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
103 that_.Release(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
104 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
105 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
106
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
107 bool IsAcquired() const
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
108 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
109 return isAcquired_;
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
110 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
111 };
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
112
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 };
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
114 }