niklas/rcl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add note about allocator life time

Browse source
This commit is contained in:
William Woodall 2015-12-16 12:17:44 -08:00
parent 7b36a604d8
commit b205c360f5
1 changed files with 10 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

11
rcl/include/rcl/allocator.h
View file

@ -24,7 +24,16 @@ extern "C"
#include "rcl/visibility_control.h"
/// Encapsulation of an allocator.
/* To use malloc, free, and realloc use rcl_get_default_allocator(). */
/* To use malloc, free, and realloc use rcl_get_default_allocator().
*
* The allocator should be trivially copyable.
* Meaning that the struct should continue to work after being assignment
* copied into a new struct.
* Specifically the object pointed to by the state pointer should remain valid
* until all uses of the allocator have been made.
* Particular care should be taken when giving an allocator to rcl_init_* where
* it is stored within another object and used later.
*/
typedef struct rcl_allocator_t
{
/// Allocate memory, given a size and state structure.