Qore Programming Language Reference Manual  0.9.4.3
QC_Queue.dox.h
1 namespace Qore {
4 namespace Thread {
6 
17 class Queue {
18 
19 public:
21 
26 nothing clear();
27 
28 public:
30 
38  clearError();
39 
40 public:
42 
53  constructor(int max = -1);
54 
55 public:
57 /***/
58  copy();
59 
60 public:
62 
66  destructor();
67 
68 public:
70 
82 bool empty();
83 
84 public:
86 
98 auto get(timeout timeout_ms = 0);
99 
100 public:
102 
116 int getReadWaiting();
117 
118 public:
120 
132 int getWaiting();
133 
134 public:
136 
148 int getWriteWaiting();
149 
150 public:
152 
163 nothing insert(auto arg, timeout timeout_ms = 0);
164 
165 public:
167 
177 int max();
178 
179 public:
181 
193 auto pop(timeout timeout_ms = 0);
194 
195 public:
197 
208 nothing push(auto arg, timeout timeout_ms = 0);
209 
210 public:
212 
227  setError(string err, string desc);
228 
229 public:
231 
241 int size();
242 };
243 }
244 }
Qore::Thread::Queue::push
nothing push(auto arg, timeout timeout_ms=0)
Pushes a value on the end of the queue.
Qore::Thread::Queue::getWaiting
int getWaiting()
Returns the number of threads currently blocked on this queue for reading.
Qore::Thread::Queue::insert
nothing insert(auto arg, timeout timeout_ms=0)
Inserts a value at the beginning of the queue.
Qore::Thread::Queue::size
int size()
Returns the number of elements in the Queue.
Qore::Thread::Queue::max
int max()
Returns the upper limit of the number of elements in the Queue.
Qore::Thread::Queue
Queue objects provide a blocking, thread-safe message-passing object to Qore programs
Definition: QC_Queue.dox.h:17
Qore::Thread::Queue::pop
auto pop(timeout timeout_ms=0)
Blocks until at least one entry is available on the queue, then returns the last entry in the queue....
Qore::Thread::Queue::getWriteWaiting
int getWriteWaiting()
Returns the number of threads currently blocked on this queue for writing.
Qore::Thread::Queue::copy
copy()
Creates a new Queue object with the same elements and maximum size as the original.
Qore::Thread::Queue::destructor
destructor()
Destroys the Queue object.
Qore::Thread::Queue::empty
bool empty()
Returns True if the Queue is empty, False if not.
Qore::Thread::Queue::getReadWaiting
int getReadWaiting()
Returns the number of threads currently blocked on this queue for reading.
Qore::Thread::Queue::constructor
constructor(int max=-1)
Creates the Queue object.
Qore::Thread::Queue::clear
nothing clear()
Clears the Queue of all data.
Qore::Thread::Queue::get
auto get(timeout timeout_ms=0)
Blocks until at least one entry is available on the queue, then returns the first entry in the queue....
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::Thread::Queue::clearError
clearError()
clears the error setting from the Queue; if error information is set, then after this call,...
Qore::Thread::Queue::setError
setError(string err, string desc)
sets an error status on the Queue and clears the Queue; while a Queue object has an error status,...