1 | // |
---|
2 | // RefCountedObject.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Foundation/include/Poco/RefCountedObject.h#2 $ |
---|
5 | // |
---|
6 | // Library: Foundation |
---|
7 | // Package: Core |
---|
8 | // Module: RefCountedObject |
---|
9 | // |
---|
10 | // Definition of the RefCountedObject class. |
---|
11 | // |
---|
12 | // Copyright (c) 2004-2009, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Foundation_RefCountedObject_INCLUDED |
---|
40 | #define Foundation_RefCountedObject_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Foundation.h" |
---|
44 | #include "Poco/AtomicCounter.h" |
---|
45 | |
---|
46 | |
---|
47 | namespace Poco { |
---|
48 | |
---|
49 | |
---|
50 | class Foundation_API RefCountedObject |
---|
51 | /// A base class for objects that employ |
---|
52 | /// reference counting based garbage collection. |
---|
53 | /// |
---|
54 | /// Reference-counted objects inhibit construction |
---|
55 | /// by copying and assignment. |
---|
56 | { |
---|
57 | public: |
---|
58 | RefCountedObject(); |
---|
59 | /// Creates the RefCountedObject. |
---|
60 | /// The initial reference count is one. |
---|
61 | |
---|
62 | void duplicate() const; |
---|
63 | /// Increments the object's reference count. |
---|
64 | |
---|
65 | void release() const; |
---|
66 | /// Decrements the object's reference count |
---|
67 | /// and deletes the object if the count |
---|
68 | /// reaches zero. |
---|
69 | |
---|
70 | int referenceCount() const; |
---|
71 | /// Returns the reference count. |
---|
72 | |
---|
73 | protected: |
---|
74 | virtual ~RefCountedObject(); |
---|
75 | /// Destroys the RefCountedObject. |
---|
76 | |
---|
77 | private: |
---|
78 | RefCountedObject(const RefCountedObject&); |
---|
79 | RefCountedObject& operator = (const RefCountedObject&); |
---|
80 | |
---|
81 | mutable AtomicCounter _counter; |
---|
82 | }; |
---|
83 | |
---|
84 | |
---|
85 | // |
---|
86 | // inlines |
---|
87 | // |
---|
88 | inline int RefCountedObject::referenceCount() const |
---|
89 | { |
---|
90 | return _counter.value(); |
---|
91 | } |
---|
92 | |
---|
93 | |
---|
94 | inline void RefCountedObject::duplicate() const |
---|
95 | { |
---|
96 | ++_counter; |
---|
97 | } |
---|
98 | |
---|
99 | |
---|
100 | inline void RefCountedObject::release() const |
---|
101 | { |
---|
102 | if (--_counter == 0) delete this; |
---|
103 | } |
---|
104 | |
---|
105 | |
---|
106 | } // namespace Poco |
---|
107 | |
---|
108 | |
---|
109 | #endif // Foundation_RefCountedObject_INCLUDED |
---|