Xively Official / mbed-libxively-5d6fdd4

Dependents:   xively-jumpstart-demo

This is Xively C library, the code lives on GitHub.

See our example program and the tutorial, documentation can bee found here.

src/libxively/xi_allocator.h@0:53753690a8bf, 2013-05-13 (annotated)

Committer:
xively
Date:
Mon May 13 19:28:22 2013 +0000
Revision:
0:53753690a8bf
libxively v0.1.1-rc0

Who changed what in which revision?

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