ost_refpointer(3) [debian man page]

ost::RefPointer(3)					     Library Functions Manual						ost::RefPointer(3)

NAME

       ost::RefPointer -

       Pointer to reference counted objects.

SYNOPSIS

       #include <object.h>

   Public Member Functions
       RefPointer ()
	   Create an unattached pointer.
       RefPointer (RefObject *obj)
	   Create a pointer attached to a reference counted object.
       RefPointer (const RefPointer &ptr)
	   A copy constructor.
       virtual ~RefPointer ()
       RefPointer & operator= (const RefObject &ref)
       void * operator* () const
       void * operator-> () const
       void * getObject (void) const
       bool operator! () const

   Protected Member Functions
       void detach (void)
	   Detach current object, for example, when changing pointer.
       virtual void enterLock (void)
	   Patch point for mutex in derived class.
       virtual void leaveLock (void)
	   Patch point for a mutex in derived class.

   Protected Attributes
       RefObject * ref

Detailed Description
       Pointer to reference counted objects.

       This is a non-template form of a reference count smart pointer, and so uses common code. This can be subclassed to return explicit object
       types.

       Author:
	   David Sugar dyfet@gnutelephony.org Pointer to reference count managed objects.

Constructor &; Destructor Documentation
   ost::RefPointer::RefPointer () [inline]
       Create an unattached pointer.

   ost::RefPointer::RefPointer (RefObject *obj)
       Create a pointer attached to a reference counted object. Object being referenced.

   ost::RefPointer::RefPointer (const RefPointer &ptr)
       A copy constructor. Pointer being copied.

   virtual ost::RefPointer::~RefPointer () [virtual]
Member Function Documentation
   void ost::RefPointer::detach (void) [protected]
       Detach current object, for example, when changing pointer.

   virtual void ost::RefPointer::enterLock (void) [protected],	[virtual]
       Patch point for mutex in derived class. This may often be a single static mutex shared by a managed type.

   void* ost::RefPointer::getObject (void) const
   virtual void ost::RefPointer::leaveLock (void) [protected],	[virtual]
       Patch point for a mutex in derived class. This may often be a single static mutex shared by a managed type.

   bool ost::RefPointer::operator! () const
   void* ost::RefPointer::operator* () const [inline]
   void* ost::RefPointer::operator-> () const [inline]
   RefPointer& ost::RefPointer::operator= (const RefObject &ref)
Member Data Documentation
   RefObject* ost::RefPointer::ref [protected]
Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012						ost::RefPointer(3)

ost::LinkedSingle(3)					     Library Functions Manual					      ost::LinkedSingle(3)

NAME

       ost::LinkedSingle -

       Self managed single linked list object chain.

SYNOPSIS

       #include <object.h>

   Public Member Functions
       virtual LinkedSingle * getFirst (void)
	   Get first linked object in list.
       virtual LinkedSingle * getLast (void)
	   Gets the last object in the list.
       LinkedSingle * getNext (void)
	   Get next object, for convenience.
       virtual void insert (LinkedSingle &obj)
	   Insert object into chain.
       LinkedSingle & operator+= (LinkedSingle &obj)

   Protected Member Functions
       LinkedSingle ()
       virtual ~LinkedSingle ()

   Protected Attributes
       LinkedSingle * nextObject

Detailed Description
       Self managed single linked list object chain.

       This is used for accumulating lists by using as a base class for a derived subclass.

       Author:
	   David Sugar dyfet@gnutelephony.org Accumulating single linked list.

Constructor &; Destructor Documentation
   ost::LinkedSingle::LinkedSingle () [inline],  [protected]
   virtual ost::LinkedSingle::~LinkedSingle () [protected],  [virtual]
Member Function Documentation
   virtual LinkedSingle* ost::LinkedSingle::getFirst (void) [virtual]
       Get first linked object in list. This may be dynamically recast, and may refer to a master static bookmark pointer in a derived class.
       Otherwise it simply returns the current object. In a 'free' list, this may not only return the first object, but also set the first to
       next.

       Returns:
	   pointer to first object in list.

   virtual LinkedSingle* ost::LinkedSingle::getLast (void) [virtual]
       Gets the last object in the list. This normally follows the links to the end. This is a virtual because derived class may include a static
       member bookmark for the current end.

       Returns:
	   pointer to last object in list.

   LinkedSingle* ost::LinkedSingle::getNext (void) [inline]
       Get next object, for convenience. Derived class may use this with a dynamic cast.

       Returns:
	   next object in list.

   virtual void ost::LinkedSingle::insert (LinkedSingle &obj) [virtual]
       Insert object into chain. This is a virtual because derived class may choose instead to perform an insert at head or tail, may manage
       bookmarks, and may add mutex lock.

       Parameters:
	   object being inserted.

   LinkedSingle& ost::LinkedSingle::operator+= (LinkedSingle &obj)
Member Data Documentation
   LinkedSingle* ost::LinkedSingle::nextObject [protected]
Author
       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++							  Sat Jun 23 2012					      ost::LinkedSingle(3)