Qore Programming Language  1.7.0
QoreReferenceCounter.h
1 /* -*- mode: c++; indent-tabs-mode: nil -*- */
2 /*
3  QoreReferenceCounter.h
4 
5  Qore Programming Language
6 
7  Copyright (C) 2003 - 2022 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_QOREREFERENCECOUNTER_H
33 
34 #define _QORE_QOREREFERENCECOUNTER_H
35 
36 #include <qore/common.h>
37 #include <qore/macros.h>
38 
39 #include <atomic>
40 
41 class QoreThreadLock;
42 
45 protected:
46  mutable std::atomic_int references;
47 
48 public:
50  DLLEXPORT QoreReferenceCounter();
51 
53 
56 
58  DLLEXPORT ~QoreReferenceCounter();
59 
61 
64  DLLEXPORT int reference_count() const;
65 
67 
70  DLLEXPORT bool is_unique() const;
71 
73  DLLEXPORT void ROreference() const;
74 
76 
80  DLLEXPORT bool ROdereference() const;
81 };
82 
83 #endif // _QORE_QOREREFERENCECOUNTER_H
provides atomic reference counting to Qore objects
Definition: QoreReferenceCounter.h:44
DLLEXPORT void ROreference() const
atomically increments the reference count
DLLEXPORT int reference_count() const
gets the reference count
DLLEXPORT bool ROdereference() const
atomically decrements the reference count
DLLEXPORT bool is_unique() const
returns true if the reference count is 1
DLLEXPORT ~QoreReferenceCounter()
destroys the reference counter object
DLLEXPORT QoreReferenceCounter()
creates the reference counter object
provides a mutually-exclusive thread lock
Definition: QoreThreadLock.h:49