TorqueEngine
/
Torque2D
mirrorاز https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: DataChunker Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="class_data_chunker-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">DataChunker Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;dataChunker.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for DataChunker:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_data_chunker.png" usemap="#DataChunker_map" alt=""/>
  <map id="DataChunker_map" name="DataChunker_map">
<area href="class_free_list_chunker.html" alt="FreeListChunker&lt; NetEventNote &gt;" shape="rect" coords="0,56,207,80"/>
<area href="class_chunker.html" alt="Chunker&lt; T &gt;" shape="rect" coords="217,56,424,80"/>
<area href="class_free_list_chunker.html" alt="FreeListChunker&lt; T &gt;" shape="rect" coords="434,56,641,80"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a80155586fa275b28773c9b203f52caba" id="r_a80155586fa275b28773c9b203f52caba"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="class_data_chunker.html#a80155586fa275b28773c9b203f52cabaa17e1ab25153a0fabd539711c47c597d8">ChunkSize</a> = 16376
 }</td></tr>
<tr class="separator:a80155586fa275b28773c9b203f52caba"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a99e47e550f3480716bd55ed1a753d122" id="r_a99e47e550f3480716bd55ed1a753d122"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_chunker.html#a99e47e550f3480716bd55ed1a753d122">alloc</a> (S32 size)</td></tr>
<tr class="separator:a99e47e550f3480716bd55ed1a753d122"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a989f98a1855675d2eba4f0dbb22a83ec" id="r_a989f98a1855675d2eba4f0dbb22a83ec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_chunker.html#a989f98a1855675d2eba4f0dbb22a83ec">freeBlocks</a> ()</td></tr>
<tr class="separator:a989f98a1855675d2eba4f0dbb22a83ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad387eebcb0aa7a6286a5c0058c57ed47" id="r_ad387eebcb0aa7a6286a5c0058c57ed47"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_chunker.html#ad387eebcb0aa7a6286a5c0058c57ed47">DataChunker</a> (S32 size=<a class="el" href="class_data_chunker.html#a80155586fa275b28773c9b203f52cabaa17e1ab25153a0fabd539711c47c597d8">ChunkSize</a>)</td></tr>
<tr class="separator:ad387eebcb0aa7a6286a5c0058c57ed47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7520d8bae2ccbcc5243bb3cbde2b7ef2" id="r_a7520d8bae2ccbcc5243bb3cbde2b7ef2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_data_chunker.html#a7520d8bae2ccbcc5243bb3cbde2b7ef2">~DataChunker</a> ()</td></tr>
<tr class="separator:a7520d8bae2ccbcc5243bb3cbde2b7ef2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements a chunked data allocater.</p>
<p>Calling new/malloc all the time is a time consuming operation. Therefore, we provide the <a class="el" href="class_data_chunker.html">DataChunker</a>, 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.</p>
<p>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.</p>
<p>Note that new/free/realloc WILL NOT WORK on memory gotten from the <a class="el" href="class_data_chunker.html">DataChunker</a>. This also only grows (you can call freeBlocks to deallocate and reset things). </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a80155586fa275b28773c9b203f52caba" name="a80155586fa275b28773c9b203f52caba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80155586fa275b28773c9b203f52caba">&#9670;&#160;</a></span>anonymous enum</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a80155586fa275b28773c9b203f52cabaa17e1ab25153a0fabd539711c47c597d8" name="a80155586fa275b28773c9b203f52cabaa17e1ab25153a0fabd539711c47c597d8"></a>ChunkSize&#160;</td><td class="fielddoc"><p>Default size for chunks. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad387eebcb0aa7a6286a5c0058c57ed47" name="ad387eebcb0aa7a6286a5c0058c57ed47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad387eebcb0aa7a6286a5c0058c57ed47">&#9670;&#160;</a></span>DataChunker()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_data_chunker.html">DataChunker</a> </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>size</em> = <code><a class="el" href="class_data_chunker.html#a80155586fa275b28773c9b203f52cabaa17e1ab25153a0fabd539711c47c597d8">ChunkSize</a></code></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Initialize using blocks of a given size.</p>
<p>One new block is allocated at constructor-time.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>Size in bytes of the space to allocate for each block. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a7520d8bae2ccbcc5243bb3cbde2b7ef2" name="a7520d8bae2ccbcc5243bb3cbde2b7ef2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7520d8bae2ccbcc5243bb3cbde2b7ef2">&#9670;&#160;</a></span>~DataChunker()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="class_data_chunker.html">DataChunker</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a99e47e550f3480716bd55ed1a753d122" name="a99e47e550f3480716bd55ed1a753d122"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99e47e550f3480716bd55ed1a753d122">&#9670;&#160;</a></span>alloc()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * alloc </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>size</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Return a pointer to a chunk of memory from a pre-allocated block.</p>
<p>This memory goes away when you call freeBlocks.</p>
<p>This memory is word-aligned. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>Size of chunk to return. This must be less than chunkSize or else an assertion will occur. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a989f98a1855675d2eba4f0dbb22a83ec" name="a989f98a1855675d2eba4f0dbb22a83ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a989f98a1855675d2eba4f0dbb22a83ec">&#9670;&#160;</a></span>freeBlocks()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void freeBlocks </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Free all allocated memory blocks.</p>
<p>This invalidates all pointers returned from <a class="el" href="class_data_chunker.html#a99e47e550f3480716bd55ed1a753d122">alloc()</a>. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>memory/<b>dataChunker.h</b></li>
<li>memory/<b>dataChunker.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>