Qore Programming Language  0.9.1
QoreCondition.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreCondition.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2005 - 2015 David Nichols
8 
9  Permission is hereby granted, free of charge, to any person obtaining a
10  copy of this software and associated documentation files (the "Software"),
11  to deal in the Software without restriction, including without limitation
12  the rights to use, copy, modify, merge, publish, distribute, sublicense,
13  and/or sell copies of the Software, and to permit persons to whom the
14  Software is furnished to do so, subject to the following conditions:
15 
16  The above copyright notice and this permission notice shall be included in
17  all copies or substantial portions of the Software.
18 
19  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
24  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25  DEALINGS IN THE SOFTWARE.
26 
27  Note that the Qore library is released under a choice of three open-source
28  licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
29  information.
30 */
31 
32 #ifndef _QORE_QORECONDITION_H
33 
34 #define _QORE_QORECONDITION_H
35 
36 #include <pthread.h>
37 #include <sys/time.h>
38 
39 #include <qore/QoreThreadLock.h>
40 
42 
46 private:
48  pthread_cond_t c;
49 
51  DLLLOCAL QoreCondition(const QoreCondition&);
52 
54  DLLLOCAL QoreCondition& operator=(const QoreCondition&);
55 
56 public:
58  DLLEXPORT QoreCondition();
59 
61  DLLEXPORT ~QoreCondition();
62 
64  DLLEXPORT int signal();
65 
67  DLLEXPORT int broadcast();
68 
70 
74  DLLEXPORT int wait(pthread_mutex_t *m);
75 
77 
84  DLLEXPORT int wait(pthread_mutex_t *m, int timeout_ms);
85 
87 
92  DLLEXPORT int wait2(pthread_mutex_t *m, int64 timeout_ms);
93 
95 
99  DLLLOCAL int wait(QoreThreadLock *l) {
100  return wait(&l->ptm_lock);
101  }
102 
104 
111  DLLLOCAL int wait(QoreThreadLock *l, int timeout_ms) {
112  return wait(&l->ptm_lock, timeout_ms);
113  }
114 
116 
121  DLLLOCAL int wait2(QoreThreadLock *l, int64 timeout_ms) {
122  return wait2(&l->ptm_lock, timeout_ms);
123  }
124 
126 
130  DLLLOCAL int wait(QoreThreadLock &l) {
131  return wait(&l);
132  }
133 
135 
142  DLLLOCAL int wait(QoreThreadLock &l, int timeout_ms) {
143  return wait(&l, timeout_ms);
144  }
145 
147 
152  DLLLOCAL int wait2(QoreThreadLock &l, int64 timeout_ms) {
153  return wait2(&l, timeout_ms);
154  }
155 };
156 
157 #endif // QORE_CONDITION
DLLEXPORT int signal()
signals a single waiting thread to wake up
a thread condition class implementing a wrapper for pthread_cond_t
Definition: QoreCondition.h:45
DLLEXPORT int broadcast()
singles all threads blocked on this condition to wake up
DLLEXPORT ~QoreCondition()
destroys the condition object
long long int64
64bit integer type, cannot use int64_t here since it breaks the API on some 64-bit systems due to equ...
Definition: common.h:260
provides a mutually-exclusive thread lock
Definition: QoreThreadLock.h:47
DLLEXPORT QoreCondition()
creates the condition object
DLLEXPORT int wait2(pthread_mutex_t *m, int64 timeout_ms)
blocks a thread on a mutex for a certain number of milliseconds until the condition is signaled ...
DLLEXPORT int wait(pthread_mutex_t *m)
blocks a thread on a mutex until the condition is signaled