OSAPI Heap

Macros
#define	OSAPI_ALIGNMENT_DEFAULT   (-1)
	The default alignment.

Typedefs
typedef RTI_INT32	OSAPI_Alignment_T
	The alignment type.

Functions
void	OSAPI_Heap_allocate_buffer (char **buffer, RTI_SIZE_T size, OSAPI_Alignment_T alignment)
	Allocate a block of memory of the provided size from the heap.

---

Detailed Description

---

Macro Definition Documentation

#define OSAPI_ALIGNMENT_DEFAULT   (-1)

The default alignment.

---

Typedef Documentation

typedef RTI_INT32 OSAPI_Alignment_T

The alignment type.

Certain methods allow a default alignment. This should be an alignment that follows the "malloc" alignment of the architecture (aligned sufficiently to store any C-structure efficiently).

RTI Connext Micro Allocates all memory with OSAPI_ALIGNMENT_DEFAULT.

---

Function Documentation

void OSAPI_Heap_allocate_buffer	(	char **	buffer,
		RTI_SIZE_T	size,
		OSAPI_Alignment_T	alignment
	)

Allocate a block of memory of the provided size from the heap.

Parameters:

buffer	<<out>> Cannot be NULL.
size	<<in>> Must be > 0.
alignment	<<in>> Power of 2 and >0 or OSAPI_ALIGNMENT_DEFAULT.

If the alignment is OSAPI_ALIGNMENT_DEFAULT, the returned pointer must have "default alignment" (meaning that any C-structure can start at the beginning of the buffer).