Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 6638b94175a3360b5332bc3542a98d59c6ac47f0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/*******************************************************************************
 * Copyright (c) 2012 protos software gmbh (http://www.protos.de).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * CONTRIBUTORS:
 * 		Henrik Rentz-Reichert (initial contribution)
 *
 *******************************************************************************/

/**
 * \file etMemory_FixedSize.h
 *
 * a simple memory management that uses equal sized chunks. The free chunks are maintained in
 * a \ref etQueue
 *
 * \author Thomas Schuetz, Henrik Rentz-Reichert
 */
#ifndef _ETMEMORY_FIXED_SIZE_H_
#define _ETMEMORY_FIXED_SIZE_H_

#include "base/etMemory.h"
#include "base/etQueue.h"

/**
 * initializes the heap with a simple block management
 *
 * \param heap pointer to the heap to be managed
 * \param size the size in bytes of the heap
 * \param blockSize the size of the (equal sized) blocks
 *
 * \return the pointer to the initialized etMemory struct
 */
etMemory* etMemory_FixedSize_init(void* heap, etUInt32 size, etUInt16 blockSize);

/**
 * determines and returns the free memory of the heap
 *
 * \param mem pointer to the heap to be managed
 *
 * \return the free memory of the heap
 */
etUInt32 etMemory_FixedSize_getFreeHeapMem(etMemory* mem);

#endif /* _ETMEMORY_FIXED_SIZE_H_ */

Back to the top