KShared Class Reference

Reference counting for shared objects. More...

#include <ksharedptr.h>

Inheritance diagram for KShared:

[legend]

List of all members.

Public Member Functions
int	_KShared_count () const
void	_KShared_ref () const
void	_KShared_unref () const
	KShared (const KShared &)
	KShared ()
KShared &	operator= (const KShared &)
Protected Member Functions
virtual	~KShared ()

---

Detailed Description

Reference counting for shared objects.

If you derive your object from this class, then you may use it in conjunction with KSharedPtr to control the lifetime of your object.

Specifically, all classes that derive from KShared have an internal counter keeping track of how many other objects have a reference to their object. If used with KSharedPtr, then your object will not be deleted until all references to the object have been released.

You should probably not ever use any of the methods in this class directly -- let the KSharedPtr take care of that. Just derive your class from KShared and forget about it.

Author:

Waldo Bastian <bastian@kde.org>

Definition at line 40 of file ksharedptr.h.

---

Constructor & Destructor Documentation

KShared::KShared

(

)

[inline]

Standard constructor.

This will initialize the reference count on this object to 0.

Definition at line 46 of file ksharedptr.h.

KShared::KShared

(

const KShared &

)

[inline]

Copy constructor.

This will not actually copy the objects but it will initialize the reference count on this object to 0.

Definition at line 52 of file ksharedptr.h.

virtual KShared::~KShared

(

)

[inline, protected, virtual]

Definition at line 78 of file ksharedptr.h.

---

Member Function Documentation

int KShared::_KShared_count

(

)

const [inline]

Return the current number of references held.

Returns:

Number of references

Definition at line 75 of file ksharedptr.h.

void KShared::_KShared_ref

(

)

const [inline]

Increases the reference count by one.

Definition at line 62 of file ksharedptr.h.

void KShared::_KShared_unref

(

)

const [inline]

Releases a reference (decreases the reference count by one).

If the count goes to 0, this object will delete itself.

Definition at line 68 of file ksharedptr.h.

KShared& KShared::operator=

(

const KShared &

)

[inline]

Overloaded assignment operator.

Definition at line 57 of file ksharedptr.h.

---

The documentation for this class was generated from the following file:

• ksharedptr.h