RWTCountingBody< Mutex > Class Template Reference
[Smart Pointers]

Base class for classes that must maintain a reference count. More...

#include <rw/pointer/RWTCountingBody.h>

Inheritance diagram for RWTCountingBody< Mutex >:

List of all members.

Public Member Functions
	~RWTCountingBody (void)
unsigned	references (void) const
unsigned	addReference (void)
unsigned	removeReference (void)
Protected Types
typedef RWTLockGuard < RWTMonitor< Mutex > >	LockGuard
typedef RWTUnlockGuard < RWTMonitor< Mutex > >	UnlockGuard
typedef RWTTryLockGuard < RWTMonitor< Mutex > >	TryLockGuard
Protected Member Functions
	RWTCountingBody (unsigned initCount=0)
	RWTCountingBody (RWStaticCtor)
	RWTCountingBody (const RWTCountingBody< Mutex > &second)
RWTCountingBody< Mutex > &	operator= (const RWTCountingBody< Mutex > &second)

---

Detailed Description

template<class Mutex>
class RWTCountingBody< Mutex >

RWTCountingBody<Mutex> is a base class for classes that must maintain a reference count. It can be safely used in a multithreaded environment.

Examples

 #include <rw/pointer/RWTCountedPointer.h>
 #include <rw/pointer/RWTCountingBody.h>
 #include <rw/sync/RWMutexLock.h>
 #include <iostream>

 class Foo : public RWTCountingBody<RWMutexLock>
 {
 public:
     void bar(void)
     {
       std::cout << "I'm a foo example" << std::endl;
     }
 };
 
 typedef RWTCountedPointer<Foo> FooPointer;
 
 int main(void)
 {
     try
     {
       FooPointer p1(new Foo);
       p1->bar();
     }
     catch(const RWxmsg& msg)
     {
       std::cout << msg.why() << std::endl;
     }
     return 0;
 }

---

Member Typedef Documentation

template<class Mutex>

typedef RWTLockGuard< RWTMonitor<Mutex> > RWTCountingBody< Mutex >::LockGuard [protected]

Predefined type for compatible guard.

Reimplemented from RWTMonitor< Mutex >.

template<class Mutex>

typedef RWTTryLockGuard< RWTMonitor<Mutex> > RWTCountingBody< Mutex >::TryLockGuard [protected]

Predefined type for compatible guard.

Reimplemented from RWTMonitor< Mutex >.

template<class Mutex>

typedef RWTUnlockGuard< RWTMonitor<Mutex> > RWTCountingBody< Mutex >::UnlockGuard [protected]

Predefined type for compatible guard.

Reimplemented from RWTMonitor< Mutex >.

---

Constructor & Destructor Documentation

template<class Mutex >

RWTCountingBody< Mutex >::~RWTCountingBody

(

void

)

[inline]

Destructor.

template<class Mutex >

RWTCountingBody< Mutex >::RWTCountingBody

(

unsigned

initCount = 0

)

[inline, protected]

Constructs a default instance (initializes the reference count). Throws no exceptions.

template<class Mutex >

RWTCountingBody< Mutex >::RWTCountingBody

(

RWStaticCtor

)

[inline, protected]

Constructs a static instance (does not initialize the reference count). Throws no exceptions.

template<class Mutex>

RWTCountingBody< Mutex >::RWTCountingBody

(

const RWTCountingBody< Mutex > &

second

)

[inline, protected]

Defines a copy constructor that creates a new instance and initializes the reference count. This constructor does not actually create a copy, but allows derived classes to provide a meaningful copy constructor. Throws no exceptions.

---

Member Function Documentation

template<class Mutex>

unsigned RWTCountingBody< Mutex >::addReference

(

void

)

Increments the reference count and then returns the previous value minus one.

Reimplemented in RWBodyBase.

template<class Mutex>

RWTCountingBody< Mutex > & RWTCountingBody< Mutex >::operator=

(

const RWTCountingBody< Mutex > &

second

)

[inline, protected]

Defines an assignment operator, allowing derived classes to do assignments. Don't assign the reference count. Throws no exceptions.

template<class Mutex>

unsigned RWTCountingBody< Mutex >::references

(

void

)

const

Queries the current reference count. Throws no exceptions.

Reimplemented in RWBodyBase.

template<class Mutex>

unsigned RWTCountingBody< Mutex >::removeReference

(

void

)

Decrements the reference count and then returns the previous value minus one.

Reimplemented in RWBodyBase.