davide carboni / Mbed 2 deprecated pymite_http_get

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

heap.h File Reference

heap.h File Reference

VM Heap. More...

Go to the source code of this file.

Functions

PmReturn_t heap_init (void)
 Initializes the heap for use.
PmReturn_t heap_getChunk (uint16_t requestedsize, uint8_t **r_pchunk)
 Returns a free chunk from the heap.
PmReturn_t heap_freeChunk (pPmObj_t ptr)
 Places the chunk back in the heap.
uint32_t uint16_t heap_getAvail (void)
PmReturn_t heap_gcRun (void)
 Runs the mark-sweep garbage collector.
PmReturn_t heap_gcSetAuto (uint8_t auto_gc)
 Enables (if true) or disables automatic garbage collection.

Detailed Description

VM Heap.

VM heap header.

Definition in file heap.h.


Function Documentation

PmReturn_t heap_freeChunk ( pPmObj_t  ptr )

Places the chunk back in the heap.

Parameters:
ptrPointer to object to free.

Definition at line 501 of file heap.c.

PmReturn_t heap_gcRun ( void   )

Runs the mark-sweep garbage collector.

Returns:
Return code

Definition at line 1055 of file heap.c.

PmReturn_t heap_gcSetAuto ( uint8_t  auto_gc )

Enables (if true) or disables automatic garbage collection.

Parameters:
boolValue to enable or disable auto GC
Returns:
Return code

Definition at line 1073 of file heap.c.

uint32_t uint16_t heap_getAvail ( void   )
Returns:
Return number of bytes available in the heap

Definition at line 530 of file heap.c.

PmReturn_t heap_getChunk ( uint16_t  requestedsize,
uint8_t **  r_pchunk 
)

Returns a free chunk from the heap.

The chunk will be at least the requested size. The actual size can be found in the return chunk's od.od_size.

Parameters:
requestedsizeRequested size of the chunk in bytes.
r_pchunkAddr of ptr to chunk (return).
Returns:
Return code

Definition at line 450 of file heap.c.

PmReturn_t heap_init ( void   )

Initializes the heap for use.

Returns:
nothing.

Definition at line 310 of file heap.c.