LibreOffice
LibreOffice 5.3 SDK C/C++ API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
salhelper::SimpleReferenceObject Class Reference

A simple base implementation for reference-counted objects. More...

#include <simplereferenceobject.hxx>

Inheritance diagram for salhelper::SimpleReferenceObject:
salhelper::Thread salhelper::Timer

Public Member Functions

 SimpleReferenceObject ()
 
void acquire ()
 
void release ()
 

Static Public Member Functions

static void * operator new (std::size_t nSize)
 see general class documentation More...
 
static void * operator new (std::size_t nSize, std::nothrow_t const &rNothrow)
 see general class documentation More...
 
static void operator delete (void *pPtr)
 see general class documentation More...
 
static void operator delete (void *pPtr, std::nothrow_t const &rNothrow)
 see general class documentation More...
 

Protected Member Functions

virtual ~SimpleReferenceObject ()
 

Detailed Description

A simple base implementation for reference-counted objects.

Classes that want to implement a reference-counting mechanism based on the acquire()/release() interface should derive from this class.

The reason to have class local operators new and delete here is technical. Imagine a class D derived from SimpleReferenceObject, but implemented in another shared library that happens to use different global operators new and delete from those used in this shared library (which, sadly, seems to be possible with shared libraries). Now, without the class local operators new and delete here, a code sequence like "new D" would use the global operator new as found in the other shared library, while the code sequence "delete this" in release() would use the global operator delete as found in this shared library—and these two operators would not be guaranteed to match.

There are no overloaded operators new and delete for placement new here, because it is felt that the concept of placement new does not work well with the concept of reference-counted objects; so it seems best to simply leave those operators out.

The same problem as with operators new and delete would also be there with operators new[] and delete[]. But since arrays of reference-counted objects are of no use, anyway, it seems best to simply declare and not define (private) operators new[] and delete[].

Constructor & Destructor Documentation

salhelper::SimpleReferenceObject::SimpleReferenceObject ( )
inline
virtual salhelper::SimpleReferenceObject::~SimpleReferenceObject ( )
protectedvirtual

Member Function Documentation

void salhelper::SimpleReferenceObject::acquire ( )
inline
Attention
The results are undefined if, for any individual instance of SimpleReferenceObject, the total number of calls to acquire() exceeds the total number of calls to release() by a platform dependent amount (which, hopefully, is quite large).
static void salhelper::SimpleReferenceObject::operator delete ( void *  pPtr)
static

see general class documentation

static void salhelper::SimpleReferenceObject::operator delete ( void *  pPtr,
std::nothrow_t const &  rNothrow 
)
static

see general class documentation

static void* salhelper::SimpleReferenceObject::operator new ( std::size_t  nSize)
static

see general class documentation

static void* salhelper::SimpleReferenceObject::operator new ( std::size_t  nSize,
std::nothrow_t const &  rNothrow 
)
static

see general class documentation

void salhelper::SimpleReferenceObject::release ( )
inline

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