water::SingleThreadedReferenceCountedObject Class Reference

#include <ReferenceCountedObject.h>

Public Member Functions
void	incReferenceCount () noexcept
void	decReferenceCount () noexcept
bool	decReferenceCountWithoutDeleting () noexcept
int	getReferenceCount () const noexcept

Protected Member Functions
	SingleThreadedReferenceCountedObject ()
virtual	~SingleThreadedReferenceCountedObject ()

Private Attributes
int	refCount

Detailed Description

Adds reference-counting to an object.

This is effectively a version of the ReferenceCountedObject class, but which uses a non-atomic counter, and so is not thread-safe (but which will be more efficient). For more details on how to use it, see the ReferenceCountedObject class notes.

See also

ReferenceCountedObject, ReferenceCountedObjectPtr, ReferenceCountedArray

Constructor & Destructor Documentation

SingleThreadedReferenceCountedObject()

water::SingleThreadedReferenceCountedObject::SingleThreadedReferenceCountedObject ( )

inlineprotected

Creates the reference-counted object (with an initial ref count of zero).

~SingleThreadedReferenceCountedObject()

virtual water::SingleThreadedReferenceCountedObject::~SingleThreadedReferenceCountedObject ( )

inlineprotectedvirtual

Destructor.

Member Function Documentation

decReferenceCount()

void water::SingleThreadedReferenceCountedObject::decReferenceCount ( )

inlinenoexcept

Decreases the object's reference count. If the count gets to zero, the object will be deleted.

decReferenceCountWithoutDeleting()

bool water::SingleThreadedReferenceCountedObject::decReferenceCountWithoutDeleting ( )

inlinenoexcept

Decreases the object's reference count. If the count gets to zero, the object will not be deleted, but this method will return true, allowing the caller to take care of deletion.

getReferenceCount()

int water::SingleThreadedReferenceCountedObject::getReferenceCount ( ) const

inlinenoexcept

Returns the object's current reference count.

incReferenceCount()

void water::SingleThreadedReferenceCountedObject::incReferenceCount ( )

inlinenoexcept

Increments the object's reference count.

This is done automatically by the smart pointer, but is public just in case it's needed for nefarious purposes.

Member Data Documentation

refCount

int water::SingleThreadedReferenceCountedObject::refCount

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/memory/ReferenceCountedObject.h