mirror/XQuilla
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
XQuilla/docs/simple-api/classxercesc_1_1MemoryManager.html
King_DuckZ 3552e76c6c v2.3.4
2020-02-17 22:24:47 +01:00

240 lines
13 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>XQilla Simple API Documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<a style="float:right;" href="http://sourceforge.net/projects/xqilla"><img src="http://sflogo.sourceforge.net/sflogo.php?group_id=152021&amp;type=2" border="0" alt="SourceForge.net Logo" /></a>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacexercesc.html">xercesc</a></li><li class="navelem"><a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classxercesc_1_1MemoryManager-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">xercesc::MemoryManager Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Configurable memory manager.
<a href="classxercesc_1_1MemoryManager.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="MemoryManager_8hpp_source.html">MemoryManager.hpp</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for xercesc::MemoryManager:</div>
<div class="dyncontent">
<div class="center"><img src="classxercesc_1_1MemoryManager__inherit__graph.png" border="0" usemap="#xercesc_1_1MemoryManager_inherit__map" alt="Inheritance graph"/></div>
<map name="xercesc_1_1MemoryManager_inherit__map" id="xercesc_1_1MemoryManager_inherit__map">
<area shape="rect" id="node2" href="classXPath2MemoryManager.html" title="XPath2MemoryManager" alt="" coords="11,80,173,107"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a348edcfe431c8ca3efdd05db58a4674c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a348edcfe431c8ca3efdd05db58a4674c">getExceptionMemoryManager</a> ()=0</td></tr>
<tr class="memdesc:a348edcfe431c8ca3efdd05db58a4674c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called to obtain the memory manager that should be used to allocate memory used in exceptions. <a href="#a348edcfe431c8ca3efdd05db58a4674c">More...</a><br/></td></tr>
<tr class="separator:a348edcfe431c8ca3efdd05db58a4674c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr class="memitem:a1b429deba7d9333cac7a6ade9b45ca16"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a1b429deba7d9333cac7a6ade9b45ca16">~MemoryManager</a> ()</td></tr>
<tr class="memdesc:a1b429deba7d9333cac7a6ade9b45ca16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default destructor. <a href="#a1b429deba7d9333cac7a6ade9b45ca16">More...</a><br/></td></tr>
<tr class="separator:a1b429deba7d9333cac7a6ade9b45ca16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
<tr class="memitem:ab6bbb5b604d2159e7ccc4532e4f422af"><td class="memItemLeft" align="right" valign="top">virtual void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#ab6bbb5b604d2159e7ccc4532e4f422af">allocate</a> (XMLSize_t size)=0</td></tr>
<tr class="memdesc:ab6bbb5b604d2159e7ccc4532e4f422af"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method allocates requested memory. <a href="#ab6bbb5b604d2159e7ccc4532e4f422af">More...</a><br/></td></tr>
<tr class="separator:ab6bbb5b604d2159e7ccc4532e4f422af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fd46b0b3634cf5540170ff3dcdfc414"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a4fd46b0b3634cf5540170ff3dcdfc414">deallocate</a> (void *p)=0</td></tr>
<tr class="memdesc:a4fd46b0b3634cf5540170ff3dcdfc414"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method deallocates memory. <a href="#a4fd46b0b3634cf5540170ff3dcdfc414">More...</a><br/></td></tr>
<tr class="separator:a4fd46b0b3634cf5540170ff3dcdfc414"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
<tr class="memitem:ae4805ff1bfd80116c7321e3336b8613e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#ae4805ff1bfd80116c7321e3336b8613e">MemoryManager</a> ()</td></tr>
<tr class="memdesc:ae4805ff1bfd80116c7321e3336b8613e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Protected default constructor. <a href="#ae4805ff1bfd80116c7321e3336b8613e">More...</a><br/></td></tr>
<tr class="separator:ae4805ff1bfd80116c7321e3336b8613e"><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>Configurable memory manager. </p>
<p>This interface allows outside applications to plug in their own memory manager to be used by Xerces for memory allocation/deallocation.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1b429deba7d9333cac7a6ade9b45ca16"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual xercesc::MemoryManager::~MemoryManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Default destructor. </p>
</div>
</div>
<a class="anchor" id="ae4805ff1bfd80116c7321e3336b8613e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">xercesc::MemoryManager::MemoryManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Protected default constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ab6bbb5b604d2159e7ccc4532e4f422af"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void* xercesc::MemoryManager::allocate </td>
<td>(</td>
<td class="paramtype">XMLSize_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method allocates requested memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>The requested memory size</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the allocated memory </dd></dl>
<p>Referenced by <a class="el" href="classXQillaAllocator.html#af70c2dfdd0ad6102bd10dbdc34e302aa">XQillaAllocator&lt; _Tp &gt;::allocate()</a>, <a class="el" href="classAutoDeallocate.html#a850a7ee172acd4bd465fd4aa1343df6a">AutoDeallocate&lt; TYPE &gt;::mmgr_()</a>, and <a class="el" href="XPath2MemoryManager_8hpp.html#a167311a5bb3ed59f0f906d097e3a3363">operator new()</a>.</p>
</div>
</div>
<a class="anchor" id="a4fd46b0b3634cf5540170ff3dcdfc414"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void xercesc::MemoryManager::deallocate </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method deallocates memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The pointer to the allocated memory to be deleted </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="classXPath2MemoryManager.html#aef477327c5b541f370ec190f921a418b">XPath2MemoryManager</a>.</p>
<p>Referenced by <a class="el" href="classXQillaAllocator.html#a7dd8460bfe7d0cb32ddaeae25285cc6e">XQillaAllocator&lt; _Tp &gt;::deallocate()</a>, <a class="el" href="classAutoDeallocate.html#ac11b517f7786a4c2066415dbd30b001d">AutoDeallocate&lt; TYPE &gt;::set()</a>, and <a class="el" href="classAutoDeallocate.html#af244dab4381f4490b00a4f6bbdaf9d73">AutoDeallocate&lt; TYPE &gt;::~AutoDeallocate()</a>.</p>
</div>
</div>
<a class="anchor" id="a348edcfe431c8ca3efdd05db58a4674c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a>* xercesc::MemoryManager::getExceptionMemoryManager </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method is called to obtain the memory manager that should be used to allocate memory used in exceptions. </p>
<p>If the same memory manager can be used, simply return 'this' from this function. Note, however, that if there is a possibility that an exception thrown can outlive the memory manager (for example, because the memory manager object is allocated on the stack or is managed by a stack-bound object), it is recommended that you return <a class="el" href="classxercesc_1_1XMLPlatformUtils.html#a2521473ea52894e9313573d330a264b4" title="The configurable memory manager. ">XMLPlatformUtils::fgMemoryManager</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the memory manager </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MemoryManager_8hpp_source.html">MemoryManager.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink