Yate
Public Member Functions | Static Public Member Functions | Protected Member Functions
RefObject Class Reference

#include <yateclass.h>

Inheritance diagram for RefObject:
GenObject AnalogLine Array CallEndpoint ChanAssist ClientAccount ClientContact ClientResource DataEndpoint DataNode DurationUpdate IAXFrame IAXInfoElement IAXMetaTrunkFrame IAXTransaction ISDNFrame JBEvent JBStream JBStreamSetList JGSession JGSessionContent MGCPEndpoint MGCPMessage MGCPTransaction SccpLocalSubsystem SccpRemote SccpSubsystem ScriptCode ScriptContext SignallingCall SignallingCircuit SignallingComponent SignallingMessage SIPMessage SIPParty SIPTransaction SS7Route SubsystemStatusTest XmlElementOut

List of all members.

Public Member Functions

 RefObject ()
virtual ~RefObject ()
virtual void * getObject (const String &name) const
virtual bool alive () const
bool ref ()
bool deref ()
int refcount () const
virtual void destruct ()

Static Public Member Functions

static bool efficientIncDec ()

Protected Member Functions

virtual void zeroRefs ()
bool resurrect ()
virtual void destroyed ()

Detailed Description

A reference counted object. Whenever using multiple inheritance you should inherit this class virtually.


Constructor & Destructor Documentation

RefObject ( )

The constructor initializes the reference counter to 1! Use deref() to destruct the object when safe

virtual ~RefObject ( ) [virtual]

Destructor.


Member Function Documentation

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.

Returns:
True if the object is referenced and safe to access

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;
 
Returns:
True if the object may have been deleted, false if it still exists and is safe to access
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 ISDNQ931Monitor, ISDNQ931, ISDNQ921Passive, ISDNQ921, SS7SCCP, SS7ISUP, SS7MTP3, SS7MTP2, SS7Router, SS7Layer4, TCAPUser, SCCPUser, GTT, DurationUpdate, MucRoom, ClientContact, ClientAccount, AnalogLineGroup, AnalogLine, JBStreamSetList, SignallingCircuitGroup, ClientChannel, IAXTransaction, JBServerStream, JBClientStream, JGSession, IAXFullFrame, CallEndpoint, JBStream, DataEndpoint, SIPTransaction, SignallingComponent, ThreadedSource, DataSource, DataConsumer, and MGCPTransaction.

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.

static bool efficientIncDec ( ) [static]

Check if reference counter manipulations are efficient on this platform. If platform does not support atomic operations a mutex pool is used.

Returns:
True if refcount uses atomic integer operations
virtual void* getObject ( const String name) const [virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName of the class we are asking for
Returns:
Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from GenObject.

Reimplemented in ISDNQ931CallMonitor, ISDNQ931Call, ISDNQ931Message, SS7ISUPCall, Channel, Array, CallEndpoint, ScriptContext, DataEndpoint, JBStream, DataTranslator, DataSource, and DataConsumer.

bool ref ( )

Increments the reference counter if not already zero

Returns:
True if the object was successfully referenced and is safe to access

Referenced by AnalogLineEvent::AnalogLineEvent().

int refcount ( ) const [inline]

Get the current value of the reference counter

Returns:
The value of the reference counter
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

Returns:
True if the object was resurrected - its name may be Lazarus ;-)
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.


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