Arman Habibi / mbed-libxively-6eca970

test

Fork of mbed-libxively-6eca970 by Xively Official

src/libxively/xi_allocator.h@0:82702e998d3f, 2013-06-26 (annotated)

Committer:
xively
Date:
Wed Jun 26 10:40:43 2013 +0000
Revision:
0:82702e998d3f
libxively v0.1.1-rc0 (34c8b32)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
xively 0:82702e998d3f 1 // Copyright (c) 2003-2013, LogMeIn, Inc. All rights reserved.
xively 0:82702e998d3f 2 // This is part of Xively C library, it is under the BSD 3-Clause license.
xively 0:82702e998d3f 3
xively 0:82702e998d3f 4 /**
xively 0:82702e998d3f 5 * \file xi_allocator.h
xively 0:82702e998d3f 6 * \author Olgierd Humenczuk
xively 0:82702e998d3f 7 * \brief Our custom `alloc()` and `free()`
xively 0:82702e998d3f 8 *
xively 0:82702e998d3f 9 * This is a faced built for future use when limitation of certain embedded
xively 0:82702e998d3f 10 * devices require custom memory management, e.g. pooling and leak detection.
xively 0:82702e998d3f 11 */
xively 0:82702e998d3f 12
xively 0:82702e998d3f 13 #ifndef __XI_ALLOCATOR_H__
xively 0:82702e998d3f 14 #define __XI_ALLOCATOR_H__
xively 0:82702e998d3f 15
xively 0:82702e998d3f 16 #ifdef __cplusplus
xively 0:82702e998d3f 17 extern "C" {
xively 0:82702e998d3f 18 #endif
xively 0:82702e998d3f 19
xively 0:82702e998d3f 20 /**
xively 0:82702e998d3f 21 * \brief Behaves like usual `malloc()`, which is supposed to allocate a chunk
xively 0:82702e998d3f 22 * of memory and return the pointer to it.
xively 0:82702e998d3f 23 *
xively 0:82702e998d3f 24 * \return Pointer to allocated memory or null in case of any error.
xively 0:82702e998d3f 25 */
xively 0:82702e998d3f 26 void* xi_alloc( size_t bytes );
xively 0:82702e998d3f 27
xively 0:82702e998d3f 28 /**
xively 0:82702e998d3f 29 * \brief Behaves like usual `free()`, it frees previously allocated chunk of
xively 0:82702e998d3f 30 * of memory.
xively 0:82702e998d3f 31 */
xively 0:82702e998d3f 32 void xi_free( void* pointer );
xively 0:82702e998d3f 33
xively 0:82702e998d3f 34 #ifdef __cplusplus
xively 0:82702e998d3f 35 }
xively 0:82702e998d3f 36 #endif
xively 0:82702e998d3f 37
xively 0:82702e998d3f 38 #endif