annotate OrthancFramework/Sources/MultiThreading/Semaphore.h @ 4119:bf7b9edf6b81 framework-lgpl

re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
author Sebastien Jodogne <s.jodogne@gmail.com>
date Tue, 07 Jul 2020 19:17:56 +0200
parents d5c09b5f882f
children b30a8de92ad9
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
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
10 * the License, or (at your option) any later version.
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
11 *
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * 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
13 * 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
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
15 * Lesser General Public License for more details.
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4104
diff changeset
19 * <http://www.gnu.org/licenses/>.
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
25 #include "../OrthancFramework.h"
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
26
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 #include <boost/noncopyable.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 #include <boost/thread.hpp>
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 namespace Orthanc
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 {
4104
d5c09b5f882f publishing Orthanc::Semaphore in shared library
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4068
diff changeset
32 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
33 {
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 private:
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
35 unsigned int availableResources_;
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 boost::mutex mutex_;
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37 boost::condition_variable condition_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
38
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
39 void Release(unsigned int resourceCount = 1);
2794
f790999a250a Semaphore removed from graveyard, SystemToolbox::GetHardwareConcurrency()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2611
diff changeset
40
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
41 void Acquire(unsigned int resourceCount = 1);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
43 bool TryAcquire(unsigned int resourceCount = 1);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 public:
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
45 explicit Semaphore(unsigned int availableResources);
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46
3483
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
47 unsigned int GetAvailableResourcesCount() const
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
48 {
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
49 return availableResources_;
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
50 }
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
51
4d26261fd05a get semaphore count for debug purpose
Alain Mazy <alain@mazy.be>
parents: 3480
diff changeset
52
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
53 class Locker : public boost::noncopyable
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
54 {
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
55 private:
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
56 Semaphore& that_;
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
57 unsigned int resourceCount_;
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
58
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
59 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
60 explicit Locker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
61 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
62 resourceCount_(resourceCount)
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
63 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
64 that_.Acquire(resourceCount_);
2108
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
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
67 ~Locker()
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
68 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
69 that_.Release(resourceCount_);
2108
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
70 }
68510b1c2433 Semaphore::Locker
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
71 };
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
72
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
73 class TryLocker : public boost::noncopyable
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
74 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
75 private:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
76 Semaphore& that_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
77 unsigned int resourceCount_;
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
78 bool isAcquired_;
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
79
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
80 public:
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
81 explicit TryLocker(Semaphore& that, unsigned int resourceCount = 1) :
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
82 that_(that),
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
83 resourceCount_(resourceCount)
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
84 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
85 isAcquired_ = that_.TryAcquire(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
86 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
87
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
88 ~TryLocker()
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
89 {
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
90 if (isAcquired_)
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
91 {
4064
7176ebf08765 Semaphore: allow acquiring/releasing multiple resources
Alain Mazy
parents: 3640
diff changeset
92 that_.Release(resourceCount_);
3480
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
93 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
94 }
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
95
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
96 bool IsAcquired() const
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 return isAcquired_;
10fd1b9ae044 fix Semaphore + added TryAcquire & TryLocker
Alain Mazy <alain@mazy.be>
parents: 3060
diff changeset
99 }
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
995
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 };
8c67382f44a7 limit number of jobs in the scheduler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 }