#include <yateclass.h>
Public Member Functions | |
RefObject () | |
virtual | ~RefObject () |
virtual bool | alive () const |
bool | ref () |
bool | deref () |
int | refcount () const |
virtual void | destruct () |
Static Public Member Functions | |
static Mutex & | refMutex () |
Protected Member Functions | |
virtual void | zeroRefs () |
virtual bool | zeroRefsTest () |
bool | refInternal () |
bool | resurrect () |
virtual void | destroyed () |
RefObject | ( | ) | [inline] |
The constructor initializes the reference counter to 1! Use deref() to destruct the object when safe
virtual ~RefObject | ( | ) | [virtual] |
Destructor.
virtual bool alive | ( | ) | const [virtual] |
Check if the object is still referenced and safe to access. Note that you should not trust this result unless the object is locked by other means.
Reimplemented from GenObject.
bool deref | ( | ) |
Decrements the reference counter, destroys the object if it reaches zero
// Deref this object, return quickly if the object was deleted if (deref()) return;
virtual void destroyed | ( | ) | [protected, virtual] |
Pre-destruction notification, called just before the object is deleted. Unlike in the destructor it is safe to call virtual methods here. Reimplementing this method allows to perform any object cleanups.
Reimplemented in DataConsumer, DataSource, ThreadedSource, DataEndpoint, CallEndpoint, ClientChannel, ClientAccount, ClientContact, DurationUpdate, JBStream, JGSession, MGCPTransaction, and AnalogLine.
Referenced by DurationUpdate::destroyed().
virtual void destruct | ( | ) | [virtual] |
Refcounted objects should just have the counter decremented. That will destroy them only when the refcount reaches zero.
Reimplemented from GenObject.
bool ref | ( | ) |
Increments the reference counter if not already zero
Referenced by AnalogLineEvent::AnalogLineEvent().
int refcount | ( | ) | const [inline] |
Get the current value of the reference counter
bool refInternal | ( | ) | [protected] |
Increments the reference counter if not already zero without locking the mutex. The caller must make sure to hold the refMutex() locked.
static Mutex& refMutex | ( | ) | [static] |
bool resurrect | ( | ) | [protected] |
Bring the object back alive by setting the reference counter to one. Note that it works only if the counter was zero previously
virtual void zeroRefs | ( | ) | [protected, virtual] |
This method is called when the reference count reaches zero after unlocking the mutex if the call to zeroRefsTest() returned true. The default behaviour is to delete the object.
Reimplemented in Channel.
virtual bool zeroRefsTest | ( | ) | [protected, virtual] |
This method is called when the reference count reaches zero just before calling zeroRefs() with the non-recursive mutex still locked. Extra care must be taken to prevent deadlocks, normally the code should only change some variables and return. The default implementation just returns true.
Reimplemented in ThreadedSource.