201 lines
12 KiB
HTML
201 lines
12 KiB
HTML
<!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 DOM3 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&type=2" border="0" alt="SourceForge.net Logo" /></a>
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main 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 class="tabs">
|
|
<ul>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="navpath"><a class="el" href="namespacexercesc.html">xercesc</a>::<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>xercesc::MemoryManager Class Reference</h1><!-- doxytag: class="xercesc::MemoryManager" -->
|
|
<p>Configurable memory manager.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="MemoryManager_8hpp_source.html">MemoryManager.hpp</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for xercesc::MemoryManager:</div>
|
|
<div class="dynsection">
|
|
<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="node3" href="classXPath2MemoryManager.html" title="XPath2MemoryManager" alt="" coords="13,83,195,112"/></map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
|
|
<p><a href="classxercesc_1_1MemoryManager-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a348edcfe431c8ca3efdd05db58a4674c">getExceptionMemoryManager</a> ()=0</td></tr>
|
|
<tr><td class="mdescLeft"> </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"></a><br/></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp22a8ec108d963f279c6a6a95aa960a57"></a> </p>
|
|
<br/><br/></div></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a1b429deba7d9333cac7a6ade9b45ca16">~MemoryManager</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <a href="#a1b429deba7d9333cac7a6ade9b45ca16"></a><br/></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp5e3e49119b678c7544a0c65c8ef812b6"></a> </p>
|
|
<br/><br/></div></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#ab6bbb5b604d2159e7ccc4532e4f422af">allocate</a> (XMLSize_t size)=0</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method allocates requested memory. <a href="#ab6bbb5b604d2159e7ccc4532e4f422af"></a><br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a4fd46b0b3634cf5540170ff3dcdfc414">deallocate</a> (void *p)=0</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">This method deallocates memory. <a href="#a4fd46b0b3634cf5540170ff3dcdfc414"></a><br/></td></tr>
|
|
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp678d0a4421b60dc59999ac02837496a6"></a> </p>
|
|
<br/><br/></div></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#ae4805ff1bfd80116c7321e3336b8613e">MemoryManager</a> ()</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Protected default constructor. <a href="#ae4805ff1bfd80116c7321e3336b8613e"></a><br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<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>
|
|
<hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a1b429deba7d9333cac7a6ade9b45ca16"></a><!-- doxytag: member="xercesc::MemoryManager::~MemoryManager" ref="a1b429deba7d9333cac7a6ade9b45ca16" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual xercesc::MemoryManager::~MemoryManager </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Default destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ae4805ff1bfd80116c7321e3336b8613e"></a><!-- doxytag: member="xercesc::MemoryManager::MemoryManager" ref="ae4805ff1bfd80116c7321e3336b8613e" args="()" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">xercesc::MemoryManager::MemoryManager </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td>
|
|
<td> ) </td>
|
|
<td><code> [inline, protected]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Protected default constructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="ab6bbb5b604d2159e7ccc4532e4f422af"></a><!-- doxytag: member="xercesc::MemoryManager::allocate" ref="ab6bbb5b604d2159e7ccc4532e4f422af" args="(XMLSize_t size)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void* xercesc::MemoryManager::allocate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XMLSize_t </td>
|
|
<td class="paramname"> <em>size</em></td>
|
|
<td> ) </td>
|
|
<td><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This method allocates requested memory. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The requested memory size</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="return"><dt><b>Returns:</b></dt><dd>A pointer to the allocated memory </dd></dl>
|
|
|
|
<p>Referenced by <a class="el" href="XPath2MemoryManager_8hpp_source.html#l00123">XQillaAllocator< _Tp >::allocate()</a>, and <a class="el" href="XPath2MemoryManager_8hpp_source.html#l00367">AutoDeallocate< TYPE >::AutoDeallocate()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4fd46b0b3634cf5540170ff3dcdfc414"></a><!-- doxytag: member="xercesc::MemoryManager::deallocate" ref="a4fd46b0b3634cf5540170ff3dcdfc414" args="(void *p)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void xercesc::MemoryManager::deallocate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"> <em>p</em></td>
|
|
<td> ) </td>
|
|
<td><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>This method deallocates memory. </p>
|
|
<dl><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>p</em> </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="XPath2MemoryManager_8hpp_source.html#l00136">XQillaAllocator< _Tp >::deallocate()</a>, <a class="el" href="XPath2MemoryManager_8hpp_source.html#l00407">AutoDeallocate< TYPE >::set()</a>, <a class="el" href="XPath2MemoryManager_8hpp_source.html#l00373">AutoDeallocate< TYPE >::~AutoDeallocate()</a>, and <a class="el" href="DOMException_8cpp_source.html#l00036">xercesc::DOMException::~DOMException()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a348edcfe431c8ca3efdd05db58a4674c"></a><!-- doxytag: member="xercesc::MemoryManager::getExceptionMemoryManager" ref="a348edcfe431c8ca3efdd05db58a4674c" args="()=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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><code> [pure virtual]</code></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="return"><dt><b>Returns:</b></dt><dd>A pointer to the memory manager </dd></dl>
|
|
|
|
<p>Referenced by <a class="el" href="DOMException_8cpp_source.html#l00050">xercesc::DOMException::DOMException()</a>.</p>
|
|
|
|
</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>
|
|
<hr size="1"/><address style="text-align: right;"><small>Generated on 18 May 2015 for XQilla DOM Level 3 API by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
|
|
</body>
|
|
</html>
|