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

Description

VuoHeap interface.

Macros

#define vuoRegister(heapPointer, deallocate)   vuoRegisterF(heapPointer, deallocate, __FILE__, __LINE__, __func__);
 Registers heapPointer to be reference-counted and stores its deallocate function (unless heapPointer is null or is already being reference-counted).
 

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 vuoRegisterF (const void *heapPointer, DeallocateFunctionType deallocate, const char *file, unsigned int line, const char *func)
 Instead of this function, you probably want to use vuoRegister.
 
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).
 

Macro Definition Documentation

#define vuoRegister (   heapPointer,
  deallocate 
)    vuoRegisterF(heapPointer, deallocate, __FILE__, __LINE__, __func__);

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.

Function Documentation

void finalizeReferenceCounts ( void  )

Cleans up the reference-counting system.

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

int vuoRegisterF ( const void *  heapPointer,
DeallocateFunctionType  deallocate,
const char *  file,
unsigned int  line,
const char *  func 
)

Instead of this function, you probably want to use vuoRegister.

This function is used to implement the vuoRegister macro.

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.
fileThe name of the file in which vuoRegister is called.
lineThe line in the file in which vuoRegister is called.
funcThe function in which vuoRegister is called.
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.