rapidjson::MemoryPoolAllocator< BaseAllocator > Class Template Reference

Default memory allocator used by the parser and DOM. More...

#include <allocators.h>

Public Member Functions

 MemoryPoolAllocator (size_t chunkSize=kDefaultChunkCapacity, BaseAllocator *baseAllocator=0)
 Constructor with chunkSize. More...
 
 MemoryPoolAllocator (void *buffer, size_t size, size_t chunkSize=kDefaultChunkCapacity, BaseAllocator *baseAllocator=0)
 Constructor with user-supplied buffer. More...
 
 MemoryPoolAllocator (const MemoryPoolAllocator &rhs) RAPIDJSON_NOEXCEPT
 
MemoryPoolAllocatoroperator= (const MemoryPoolAllocator &rhs) RAPIDJSON_NOEXCEPT
 
 ~MemoryPoolAllocator () RAPIDJSON_NOEXCEPT
 Destructor. More...
 
void Clear () RAPIDJSON_NOEXCEPT
 Deallocates all memory chunks, excluding the first/user one.
 
size_t Capacity () const RAPIDJSON_NOEXCEPT
 Computes the total capacity of allocated memory chunks. More...
 
size_t Size () const RAPIDJSON_NOEXCEPT
 Computes the memory blocks allocated. More...
 
bool Shared () const RAPIDJSON_NOEXCEPT
 Whether the allocator is shared. More...
 
void * Malloc (size_t size)
 Allocates a memory block. (concept Allocator)
 
void * Realloc (void *originalPtr, size_t originalSize, size_t newSize)
 Resizes a memory block (concept Allocator)
 
bool operator== (const MemoryPoolAllocator &rhs) const RAPIDJSON_NOEXCEPT
 Compare (equality) with another MemoryPoolAllocator.
 
bool operator!= (const MemoryPoolAllocator &rhs) const RAPIDJSON_NOEXCEPT
 Compare (inequality) with another MemoryPoolAllocator.
 

Static Public Member Functions

static void Free (void *ptr) RAPIDJSON_NOEXCEPT
 Frees a memory block (concept Allocator)
 

Static Public Attributes

static const bool kNeedFree = false
 Tell users that no need to call Free() with this allocator. (concept Allocator)
 
static const bool kRefCounted = true
 Tell users that this allocator is reference counted on copy.
 

Detailed Description

template<typename BaseAllocator = CrtAllocator>
class rapidjson::MemoryPoolAllocator< BaseAllocator >

Default memory allocator used by the parser and DOM.

This allocator allocate memory blocks from pre-allocated memory chunks.

It does not free memory blocks. And Realloc() only allocate new memory.

The memory chunks are allocated by BaseAllocator, which is CrtAllocator by default.

User may also supply a buffer as the first chunk.

If the user-buffer is full then additional chunks are allocated by BaseAllocator.

The user-buffer is not deallocated by this allocator.

Template Parameters
BaseAllocatorthe allocator type for allocating memory chunks. Default is CrtAllocator.
Note
implements Allocator concept

Constructor & Destructor Documentation

◆ MemoryPoolAllocator() [1/2]

template<typename BaseAllocator = CrtAllocator>
rapidjson::MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( size_t  chunkSize = kDefaultChunkCapacity,
BaseAllocator *  baseAllocator = 0 
)
inlineexplicit

Constructor with chunkSize.

Parameters
chunkSizeThe size of memory chunk. The default is kDefaultChunkSize.
baseAllocatorThe allocator for allocating memory chunks.

◆ MemoryPoolAllocator() [2/2]

template<typename BaseAllocator = CrtAllocator>
rapidjson::MemoryPoolAllocator< BaseAllocator >::MemoryPoolAllocator ( void *  buffer,
size_t  size,
size_t  chunkSize = kDefaultChunkCapacity,
BaseAllocator *  baseAllocator = 0 
)
inline

Constructor with user-supplied buffer.

The user buffer will be used firstly. When it is full, memory pool allocates new chunk with chunk size.

The user buffer will not be deallocated when this allocator is destructed.

Parameters
bufferUser supplied buffer.
sizeSize of the buffer in bytes. It must at least larger than sizeof(ChunkHeader).
chunkSizeThe size of memory chunk. The default is kDefaultChunkSize.
baseAllocatorThe allocator for allocating memory chunks.

◆ ~MemoryPoolAllocator()

template<typename BaseAllocator = CrtAllocator>
rapidjson::MemoryPoolAllocator< BaseAllocator >::~MemoryPoolAllocator ( )
inline

Destructor.

This deallocates all memory chunks, excluding the user-supplied buffer.

Member Function Documentation

◆ Capacity()

template<typename BaseAllocator = CrtAllocator>
size_t rapidjson::MemoryPoolAllocator< BaseAllocator >::Capacity ( ) const
inline

Computes the total capacity of allocated memory chunks.

Returns
total capacity in bytes.

◆ Shared()

template<typename BaseAllocator = CrtAllocator>
bool rapidjson::MemoryPoolAllocator< BaseAllocator >::Shared ( ) const
inline

Whether the allocator is shared.

Returns
true or false.

◆ Size()

template<typename BaseAllocator = CrtAllocator>
size_t rapidjson::MemoryPoolAllocator< BaseAllocator >::Size ( ) const
inline

Computes the memory blocks allocated.

Returns
total used bytes.

The documentation for this class was generated from the following file: