Qore Programming Language - C/C++ Library  0.8.13.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
QoreQueue.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreQueue.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2017 Qore Technologies, s.r.o.
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_QOREQUEUE_H
33 
34 #define _QORE_QOREQUEUE_H
35 
36 #include <qore/QoreThreadLock.h>
37 #include <qore/QoreCondition.h>
38 
39 class QoreQueueNode;
40 
41 class qore_queue_private;
42 
43 class QoreQueue {
44  friend class qore_queue_private;
45 protected:
46  // private implementation
47  qore_queue_private* priv;
48 
49 public:
51  DLLEXPORT QoreQueue(int n_max = -1);
52 
54  DLLEXPORT QoreQueue(const QoreQueue& orig);
55 
57 
59  DLLEXPORT ~QoreQueue();
60 
62  DLLEXPORT void pushAndTakeRef(AbstractQoreNode* n);
63 
65  DLLEXPORT void push(ExceptionSink* xsink, const AbstractQoreNode* n, int timeout_ms = 0, bool* to = 0);
66 
68  DLLEXPORT void insert(ExceptionSink* xsink, const AbstractQoreNode* n, int timeout_ms = 0, bool* to = 0);
69 
71  DLLEXPORT void push(ExceptionSink* xsink, AbstractQoreNode* n, int timeout_ms = 0, bool* to = 0);
72 
74  DLLEXPORT void insert(ExceptionSink* xsink, AbstractQoreNode* n, int timeout_ms = 0, bool* to = 0);
75 
77  DLLEXPORT AbstractQoreNode* shift(ExceptionSink* xsink, int timeout_ms = 0, bool* to = 0);
78 
80  DLLEXPORT AbstractQoreNode* pop(ExceptionSink* xsink, int timeout_ms = 0, bool* to = 0);
81 
83  DLLEXPORT bool empty() const;
84 
86 
88  DLLEXPORT int size() const;
89 
91  DLLEXPORT int getMax() const;
92 
94  DLLEXPORT unsigned getReadWaiting() const;
95 
97  DLLEXPORT unsigned getWriteWaiting() const;
98 
100  DLLEXPORT void clear(ExceptionSink* xsink);
101 
103 
107  DLLEXPORT void setError(const char* err, const QoreStringNode* desc, ExceptionSink* xsink);
108 
110 
113  DLLEXPORT void clearError();
114 };
115 
116 class Queue : public AbstractPrivateData, public QoreQueue {
117 protected:
118  DLLEXPORT virtual ~Queue();
119 
120 public:
121  DLLEXPORT Queue(int max = -1);
122 
123  DLLEXPORT Queue(const Queue& old);
124 
125  DLLEXPORT Queue* queueRefSelf() const;
126 
127  DLLEXPORT virtual void deref(ExceptionSink* xsink);
128 };
129 
130 #endif // _QORE_QOREQUEUE_H
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
The base class for all value and parse types in Qore expression trees.
Definition: AbstractQoreNode.h:54
Qore&#39;s string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
virtual DLLLOCAL void deref()
decrements the reference count of the object without the possibility of throwing a Qore-language exce...
Definition: AbstractPrivateData.h:67
container for holding Qore-language exception information and also for registering a &quot;thread_exit&quot; ca...
Definition: ExceptionSink.h:47