author | Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
Mon, 02 Jun 2008 10:30:24 -0700 | |
changeset 3190 | 51fe9001a679 |
parent 2946 | 14194a052b7d |
child 3392 | 775777e52833 |
permissions | -rw-r--r-- |
2775
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
1 |
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
2 |
/* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
3 |
* Copyright (c) 2007 Georgia Tech Research Corporation |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
4 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
5 |
* This program is free software; you can redistribute it and/or modify |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
6 |
* it under the terms of the GNU General Public License version 2 as |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
8 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
9 |
* This program is distributed in the hope that it will be useful, |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
10 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
11 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
12 |
* GNU General Public License for more details. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
13 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
14 |
* You should have received a copy of the GNU General Public License |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
15 |
* along with this program; if not, write to the Free Software |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
16 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
17 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
18 |
* Author: George Riley <riley@ece.gatech.edu> |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
19 |
* Adapted from original code in object.h by: |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
20 |
* Authors: Gustavo Carneiro <gjcarneiro@gmail.com>, |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
21 |
* Mathieu Lacage <mathieu.lacage@sophia.inria.fr> |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
22 |
*/ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
23 |
#ifndef __REF_COUNT_BASE_H__ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
24 |
#define __REF_COUNT_BASE_H__ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
25 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
26 |
#include <stdint.h> |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
27 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
28 |
namespace ns3 { |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
29 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
30 |
/** |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
31 |
* \brief a base class that provides implementations of reference counting |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
32 |
* operations. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
33 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
34 |
* A base class that provides implementations of reference counting |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
35 |
* operations, for classes that wish to use the templatized smart |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
36 |
* pointer for memory management but that do not wish to derive from |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
37 |
* class ns3::Object. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
38 |
* |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
39 |
*/ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
40 |
class RefCountBase |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
41 |
{ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
42 |
public: |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
43 |
RefCountBase(); |
2946
14194a052b7d
add copy constructor and assignment operator to ensure proper initialization of refcount.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2775
diff
changeset
|
44 |
RefCountBase (const RefCountBase &o); |
14194a052b7d
add copy constructor and assignment operator to ensure proper initialization of refcount.
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
2775
diff
changeset
|
45 |
RefCountBase &operator = (const RefCountBase &o); |
2775
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
46 |
virtual ~RefCountBase (); |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
47 |
/** |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
48 |
* Increment the reference count. This method should not be called |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
49 |
* by user code. RefCountBase instances are expected to be used in |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
50 |
* conjunction with the Ptr template which would make calling Ref |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
51 |
* unecessary and dangerous. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
52 |
*/ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
53 |
inline void Ref () const; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
54 |
/** |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
55 |
* Decrement the reference count. This method should not be called |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
56 |
* by user code. RefCountBase instances are expected to be used in |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
57 |
* conjunction with the Ptr template which would make calling Ref |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
58 |
* unecessary and dangerous. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
59 |
*/ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
60 |
inline void Unref () const; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
61 |
private: |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
62 |
// Note we make this mutable so that the const methods can still |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
63 |
// change it. |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
64 |
mutable uint32_t m_count; // Reference count |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
65 |
}; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
66 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
67 |
} // namespace ns3 |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
68 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
69 |
namespace ns3 { |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
70 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
71 |
// Implementation of the in-line methods |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
72 |
void |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
73 |
RefCountBase::Ref () const |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
74 |
{ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
75 |
m_count++; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
76 |
} |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
77 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
78 |
void |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
79 |
RefCountBase::Unref () const |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
80 |
{ |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
81 |
if (--m_count == 0) |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
82 |
{ // All references removed, ok to delete |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
83 |
delete this; |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
84 |
} |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
85 |
} |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
86 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
87 |
} // namespace ns3 |
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
88 |
|
03a23eb5f1e8
bug: 147. Add RefCountBase
George F. Riley<riley@ece.gatech.edu>
parents:
diff
changeset
|
89 |
#endif /* __REF_COUNT_BASE_H__*/ |