Vuo  0.4.1
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Typedefs | Functions
VuoHeap.h File Reference

Description

VuoHeap interface.

Typedefs

typedef void(* DeallocateFunctionType )(void *)
 A type for destructor functions, such as free(void *), which are used to deallocate reference-counted memory when it's no longer in use.
 

Functions

void finalizeReferenceCounts (void)
 Cleans up the reference-counting system.
 
int vuoRegister (const void *heapPointer, DeallocateFunctionType deallocate)
 Registers heapPointer to be reference-counted and stores its deallocate function (unless heapPointer is null or is already being reference-counted).
 
int vuoRetain (const void *heapPointer)
 Increments the reference count for heapPointer (unless heapPointer is not being reference-counted).
 
int vuoRelease (const void *heapPointer)
 Decrements the reference count for heapPointer (unless heapPointer is not being reference-counted).
 

Function Documentation

void finalizeReferenceCounts ( void  )

Cleans up the reference-counting system.

To be called once, after all other reference-counting function calls.

int vuoRegister ( const void *  heapPointer,
DeallocateFunctionType  deallocate 
)

Registers heapPointer to be reference-counted and stores its deallocate function (unless heapPointer is null or is already being reference-counted).

Parameters
heapPointerA pointer to allocated memory on the heap.
deallocateThe function to be used to deallocate the memory when the reference count gets back to its original value of 0.
Returns
The updated reference count of heapPointer. This is 0 if heapPointer is not already being reference-counted, greater than 0 if it is, or -1 if heapPointer is null.
int vuoRelease ( const void *  heapPointer)

Decrements the reference count for heapPointer (unless heapPointer is not being reference-counted).

If the reference count becomes 0, heapPointer is deallocated and is no longer reference-counted.

Parameters
heapPointerA pointer to allocated memory on the heap.
Returns
The updated reference count of heapPointer, or -1 if heapPointer is not being reference-counted, has never been retained, or is null.
int vuoRetain ( const void *  heapPointer)

Increments the reference count for heapPointer (unless heapPointer is not being reference-counted).

Parameters
heapPointerA pointer to allocated memory on the heap.
Returns
The updated reference count of heapPointer, or -1 if heapPointer is not being reference-counted or is null.