1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::fnd::HeapBase</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/fnd/Overview.html">fnd</a>::HeapBase</CODE> Class</h1>
52<h2>Syntax</h2>
53    <div class="section">
54<pre class="definition">class HeapBase : public nn::fnd::IntrusiveLinkedList<HeapBase>::Item</pre>
55    </div>
56<h2>Description</h2>
57    <div class="section">
58<p>Base class for heaps.</p><p>This class cannot be instantiated.</p><!-- write here --></div>
59    <a name="function" id="function">
60<h2>Member Functions</h2>
61      <div class="section">
62        <table class="members">
63          <tr>
64            <td width="100">
65<span class="static_style" title="static">S</span> </td>
66            <th>
67<a href="../../../nn/fnd/HeapBase/SetFillValue.html"><CODE>SetFillValue</CODE></a>
68            </th>
69<td>Sets the type of fill and the value used to fill the heap.</td>
70          </tr>
71          <tr>
72            <td width="100">
73<span class="static_style" title="static">S</span> </td>
74            <th>
75<a href="../../../nn/fnd/HeapBase/GetFillValue.html"><CODE>GetFillValue</CODE></a>
76            </th>
77<td>Gets the type of fill used to fill the heap.</td>
78          </tr>
79          <tr>
80<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
81            </td>
82            <th>
83<a href="../../../nn/fnd/HeapBase/~HeapBase.html"><CODE>~HeapBase</CODE></a>
84            </th>
85<td>Destructor.</td>
86          </tr>
87          <tr>
88<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
89            </td>
90            <th>
91<a href="../../../nn/fnd/HeapBase/FreeV.html"><CODE>FreeV</CODE></a>
92            </th>
93<td>Frees memory blocks that have been allocated.</td>
94          </tr>
95          <tr>
96<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
97            </td>
98            <th>
99<a href="../../../nn/fnd/HeapBase/GetStartAddress.html"><CODE>GetStartAddress</CODE></a>
100            </th>
101<td>Returns the starting address of the memory region used by the calling heap.</td>
102          </tr>
103          <tr>
104<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
105            </td>
106            <th>
107<a href="../../../nn/fnd/HeapBase/GetTotalSize.html"><CODE>GetTotalSize</CODE></a>
108            </th>
109<td>Returns the size of the memory region used by the calling heap.</td>
110          </tr>
111          <tr>
112<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
113            </td>
114            <th>
115<a href="../../../nn/fnd/HeapBase/Dump.html"><CODE>Dump</CODE></a>
116            </th>
117<td>Dumps the content of the heap for debugging purposes.</td>
118          </tr>
119          <tr>
120<td width="100"> <span class="virtual_style" title="pure-virtual">PV</span>
121            </td>
122            <th>
123<a href="../../../nn/fnd/HeapBase/HasAddress.html"><CODE>HasAddress</CODE></a>
124            </th>
125<td>Determines whether the specified address is located within a heap.</td>
126          </tr>
127          <tr>
128            <td width="100">  </td>
129            <th>
130<a href="../../../nn/fnd/HeapBase/GetParent.html"><CODE>GetParent</CODE></a>
131            </th>
132<td>Gets the parent heap.</td>
133          </tr>
134          <tr>
135            <td width="100">  </td>
136            <th>
137<a href="../../../nn/fnd/HeapBase/GetRoot.html"><CODE>GetRoot</CODE></a>
138            </th>
139<td>Returns the root heap of the calling heap.</td>
140          </tr>
141          <tr>
142            <td width="100">  </td>
143            <th>
144<a href="../../../nn/fnd/HeapBase/FindHeap.html"><CODE>FindHeap</CODE></a>
145            </th>
146<td>Searches for the heap to which the specified address belongs.</td>
147          </tr>
148          <tr>
149            <td width="100">  </td>
150            <th>
151<a href="../../../nn/fnd/HeapBase/Destroy.html"><CODE>Destroy</CODE></a>
152            </th>
153<td>Destroys a heap that was created within a parent heap.</td>
154          </tr> </table>
155      </div>
156    </a>
157<h2>Class Hierarchy</h2>
158    <div class="section">
159<p class="hierarchy"><span>ADLFireWall::NonCopyable</span><br />&nbsp;&nbsp;<span>nn::fnd::IntrusiveLinkedList</span><br />&nbsp;&nbsp;&nbsp;&nbsp;<b>nn::fnd::HeapBase</b>
160      </p>
161    </div>
162<h2>Revision History</h2>
163    <div class="section">
164      <dl class="history">
165        <dt>2010/01/07</dt>
166<dd>Initial version.<br />
167        </dd>
168      </dl>
169    </div>
170  <hr><p>CONFIDENTIAL</p></body>
171</html>
172