torque Torque Game Engine Documentation
TGE Version 1.5.2

DataChunker Class Reference

#include <dataChunker.h>

Inheritance diagram for DataChunker:

Inheritance graph
[legend]

Detailed Description

Implements a chunked data allocater.

Calling new/malloc all the time is a time consuming operation. Therefore, we provide the DataChunker, which allocates memory in blockss of chunkSize (by default 16k, see ChunkSize, though it can be set in the constructor), then doles it out as requested, in chunks of up to chunkSize in size.

It will assert if you try to get more than ChunkSize bytes at a time, and it deals with the logic of allocating new blocks and giving out word-aligned chunks.

Note that new/free/realloc WILL NOT WORK on memory gotten from the DataChunker. This also only grows (you can call freeBlocks to deallocate and reset things).


Public Types

enum  { ChunkSize = 16376 }

Public Member Functions

voidalloc (S32 size)
 Return a pointer to a chunk of memory from a pre-allocated block.
void freeBlocks ()
 Free all allocated memory blocks.
 DataChunker (S32 size=ChunkSize)
 Initialize using blocks of a given size.
 ~DataChunker ()

Private Attributes

DataBlockcurBlock
S32 chunkSize

Data Structures

struct  DataBlock
 Block of allocated memory. More...


Member Enumeration Documentation

anonymous enum

Enumerator:
ChunkSize  Default size for chunks.


Constructor & Destructor Documentation

DataChunker::DataChunker ( S32  size = ChunkSize  ) 

Initialize using blocks of a given size.

One new block is allocated at constructor-time.

Parameters:
size Size in bytes of the space to allocate for each block.

DataChunker::~DataChunker (  ) 


Member Function Documentation

void* DataChunker::alloc ( S32  size  ) 

Return a pointer to a chunk of memory from a pre-allocated block.

This memory goes away when you call freeBlocks.

This memory is word-aligned.

Parameters:
size Size of chunk to return. This must be less than chunkSize or else an assertion will occur.

void DataChunker::freeBlocks (  ) 

Free all allocated memory blocks.

This invalidates all pointers returned from alloc().

Reimplemented in FreeListChunker< T >, FreeListChunker< BufInf >, and FreeListChunker< NetEventNote >.


Field Documentation




All Rights Reserved GarageGames.com, Inc. 1999-2005
Auto-magically Generated with Doxygen