Qore Programming Language Reference Manual  1.0.8
QC_Queue.dox.h
1 namespace Qore {
4 namespace Thread {
6 
22 class Queue {
23 
24 public:
26 
31 nothing clear();
32 
33 public:
35 
43  clearError();
44 
45 public:
47 
60  constructor(int max = -1);
61 
62 public:
64 /***/
65  copy();
66 
67 public:
69 
74  destructor();
75 
76 public:
78 
90 bool empty();
91 
92 public:
94 
112 auto get(timeout timeout_ms = 0);
113 
114 public:
116 
130 int getReadWaiting();
131 
132 public:
134 
146 int getWaiting();
147 
148 public:
150 
162 int getWriteWaiting();
163 
164 public:
166 
178 nothing insert(auto arg, timeout timeout_ms = 0);
179 
180 public:
182 
192 int max();
193 
194 public:
196 
214 auto pop(timeout timeout_ms = 0);
215 
216 public:
218 
237 nothing push(auto arg, timeout timeout_ms = 0);
238 
239 public:
241 
256  setError(string err, string desc);
257 
258 public:
260 
270 int size();
271 };
272 }
273 }
nothing clear()
Clears the Queue of all data.
clearError()
clears the error setting from the Queue; if error information is set, then after this call...
nothing push(auto arg, timeout timeout_ms=0)
Pushes a value on the end of the queue.
int size()
Returns the number of elements in the Queue.
nothing insert(auto arg, timeout timeout_ms=0)
Inserts a value at the beginning of the queue.
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...
int max()
Returns the upper limit of the number of elements in the Queue.
bool empty()
Returns True if the Queue is empty, False if not.
constructor(int max=-1)
Creates the Queue object.
int getReadWaiting()
Returns the number of threads currently blocked on this queue for reading.
setError(string err, string desc)
sets an error status on the Queue and clears the Queue; while a Queue object has an error status...
Queue objects provide a blocking, thread-safe message-passing object to Qore programs ...
Definition: QC_Queue.dox.h:22
destructor()
Destroys the Queue object.
int getWriteWaiting()
Returns the number of threads currently blocked on this queue for writing.
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
copy()
Creates a new Queue object with the same elements and maximum size as the original.
int getWaiting()
Returns the number of threads currently blocked on this queue for reading.