QoreQueue.h
/* -*- mode: c++; indent-tabs-mode: nil -*- */
/*
QoreQueue.h
Qore Programming Language
Copyright (C) 2003 - 2021 Qore Technologies, s.r.o.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Note that the Qore library is released under a choice of three open-source
licenses: MIT (as above), LGPL 2+, or GPL 2+; see README-LICENSE for more
information.
*/
#ifndef _QORE_QOREQUEUE_H
#define _QORE_QOREQUEUE_H
#include <qore/QoreThreadLock.h>
#include <qore/QoreCondition.h>
class QoreQueueNode;
class qore_queue_private;
class QoreQueue {
friend class qore_queue_private;
protected:
// private implementation
qore_queue_private* priv;
public:
DLLEXPORT QoreQueue(int n_max = -1);
DLLEXPORT QoreQueue(const QoreQueue& orig);
DLLEXPORT ~QoreQueue();
DLLEXPORT void pushAndTakeRef(QoreValue n);
DLLEXPORT void push(ExceptionSink* xsink, QoreValue n, int timeout_ms = 0, bool* to = 0);
DLLEXPORT void insert(ExceptionSink* xsink, QoreValue n, int timeout_ms = 0, bool* to = 0);
DLLEXPORT void push(ExceptionSink* xsink, QoreObject* self, QoreValue n, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT void insert(ExceptionSink* xsink, QoreObject* self, QoreValue n, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT QoreValue shift(ExceptionSink* xsink, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT QoreValue pop(ExceptionSink* xsink, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT QoreValue shift(ExceptionSink* xsink, QoreObject* self, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT QoreValue pop(ExceptionSink* xsink, QoreObject* self, int timeout_ms = 0, bool* to = nullptr);
DLLEXPORT bool empty() const;
DLLEXPORT size_t size() const;
DLLEXPORT ptrdiff_t getMax() const;
DLLEXPORT size_t getReadWaiting() const;
DLLEXPORT size_t getWriteWaiting() const;
DLLEXPORT void clear(ExceptionSink* xsink);
DLLEXPORT void clear(ExceptionSink* xsink, QoreObject* self);
DLLEXPORT void setError(const char* err, const QoreStringNode* desc, ExceptionSink* xsink);
DLLEXPORT void setError(const char* err, const QoreStringNode* desc, QoreObject* self, ExceptionSink* xsink);
DLLEXPORT void clearError();
};
class Queue : public AbstractPrivateData, public QoreQueue {
protected:
DLLEXPORT virtual ~Queue();
public:
DLLEXPORT Queue(int max = -1);
DLLEXPORT Queue(const Queue& old);
DLLEXPORT Queue* queueRefSelf() const;
DLLEXPORT virtual void deref(ExceptionSink* xsink);
};
#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