Public_API_foonathan_memory.md

External Dependency Public API foonathan_memory

This document lists the foonathan_memory API that eprosima Fast DDS uses. This document will be updated if new features are included and used in eprosima Fast DDS.

Allocators

1. Typedef foonathan::memory::default_allocator
2. Typedef foonathan::memory::heap_allocator
3. Typedef foonathan::memory::new_allocator

Allocator implementations

1. Class foonathan::memory::memory_pool
2. Struct foonathan::memory::node_pool

Adapters and Wrappers

1. Class foonathan::memory::binary_segregator

Alias Templates

1. Class foonathan::memory::unordered_map
2. Class foonathan::memory::map
3. Class foonathan::memory::set

Node sizes

1. Struct foonathan::memory::map_node_size
2. Struct foonathan::memory::set_node_size
3. Struct foonathan::memory::unordered_map_node_size

Internal methods

When the library allocates memory blocks, some of this memory is reserved by foonathan_memory for internal uses and, consequently, is not available to the user. The following methods provide information about the internal needs of foonathan_memory.

1. foonathan::memory::detail::debug_fence_size
2. foonathan::memory::detail::max_alignment
3. foonathan::memory::detail::memory_block_stack::implementation_offset