| Qore Programming Language - C/C++ Library 1.0.8

QoreQueue.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3 QoreQueue.h
4
5 Qore Programming Language
6
7 Copyright (C) 2003 - 2021 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(QoreValue n);
63
65 DLLEXPORT void push(ExceptionSink* xsink, QoreValue n, int timeout_ms = 0, bool* to = 0);
66
68 DLLEXPORT void insert(ExceptionSink* xsink, QoreValue n, int timeout_ms = 0, bool* to = 0);
69
71
74 DLLEXPORT void push(ExceptionSink* xsink, QoreObject* self, QoreValue n, int timeout_ms = 0, bool* to = nullptr);
75
77
80 DLLEXPORT void insert(ExceptionSink* xsink, QoreObject* self, QoreValue n, int timeout_ms = 0, bool* to = nullptr);
81
83 DLLEXPORT QoreValue shift(ExceptionSink* xsink, int timeout_ms = 0, bool* to = nullptr);
84
86 DLLEXPORT QoreValue pop(ExceptionSink* xsink, int timeout_ms = 0, bool* to = nullptr);
87
89
92 DLLEXPORT QoreValue shift(ExceptionSink* xsink, QoreObject* self, int timeout_ms = 0, bool* to = nullptr);
93
95
98 DLLEXPORT QoreValue pop(ExceptionSink* xsink, QoreObject* self, int timeout_ms = 0, bool* to = nullptr);
99
101 DLLEXPORT bool empty() const;
102
104 DLLEXPORT size_t size() const;
105
107 DLLEXPORT ptrdiff_t getMax() const;
108
110 DLLEXPORT size_t getReadWaiting() const;
111
113 DLLEXPORT size_t getWriteWaiting() const;
114
116 DLLEXPORT void clear(ExceptionSink* xsink);
117
119
122 DLLEXPORT void clear(ExceptionSink* xsink, QoreObject* self);
123
125
129 DLLEXPORT void setError(const char* err, const QoreStringNode* desc, ExceptionSink* xsink);
130
132
136 DLLEXPORT void setError(const char* err, const QoreStringNode* desc, QoreObject* self, ExceptionSink* xsink);
137
139
142 DLLEXPORT void clearError();
143 };
144
145 class Queue : public AbstractPrivateData, public QoreQueue {
146 protected:
147 DLLEXPORT virtual ~Queue();
148
149 public:
150 DLLEXPORT Queue(int max = -1);
151
152 DLLEXPORT Queue(const Queue& old);
153
154 DLLEXPORT Queue* queueRefSelf() const;
155
156 DLLEXPORT virtual void deref(ExceptionSink* xsink);
157 };
158
159 #endif // _QORE_QOREQUEUE_H
AbstractPrivateData
the base class for all data to be used as private data of Qore objects
Definition: AbstractPrivateData.h:44
QoreStringNode
Qore&#39;s string value type, reference counted, dynamically-allocated only.
Definition: QoreStringNode.h:50
AbstractPrivateData::deref
virtual DLLLOCAL void deref()
decrements the reference count of the object without the possibility of throwing a Qore-language exce...
Definition: AbstractPrivateData.h:65
QoreValue
The main value class in Qore, designed to be passed by value.
Definition: QoreValue.h:267
QoreObject
the implementation of Qore&#39;s object data type, reference counted, dynamically-allocated only ...
Definition: QoreObject.h:60
ExceptionSink
container for holding Qore-language exception information and also for registering a "thread_exit" ca...
Definition: ExceptionSink.h:48