XQuilla/docs/dom3-api/classxercesc_1_1MemoryManager.html

218 lines
11 KiB
HTML
Raw Normal View History

2020-02-17 21:05:20 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
2020-02-17 21:11:31 +00:00
<title>XQilla DOM3 API Documentation</title>
2020-02-17 21:05:20 +00:00
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
2020-02-17 21:11:31 +00:00
<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>
2020-02-17 21:19:08 +00:00
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>xercesc::MemoryManager Class Reference</h1>Configurable memory manager.
2020-02-17 21:05:20 +00:00
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="MemoryManager_8hpp-source.html">MemoryManager.hpp</a>&gt;</code>
2020-02-17 21:17:06 +00:00
<p>
2020-02-17 21:19:08 +00:00
Inheritance diagram for xercesc::MemoryManager:<p><center><img src="classxercesc_1_1MemoryManager__inherit__graph.png" border="0" usemap="#xercesc_1_1MemoryManager__inherit__map" alt="Inheritance graph"></center>
2020-02-17 21:17:06 +00:00
<map name="xercesc_1_1MemoryManager__inherit__map">
2020-02-17 21:19:08 +00:00
<area href="classXPath2MemoryManager.html" shape="rect" coords="9,81,175,105" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classxercesc_1_1MemoryManager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
2020-02-17 21:05:20 +00:00
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
2020-02-17 21:19:08 +00:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#a0">getExceptionMemoryManager</a> ()=0</td></tr>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</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="#a0"></a><br></td></tr>
2020-02-17 21:17:06 +00:00
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
2020-02-17 21:19:08 +00:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#z21_0">~MemoryManager</a> ()</td></tr>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor. <a href="#z21_0"></a><br></td></tr>
2020-02-17 21:05:20 +00:00
<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
2020-02-17 21:19:08 +00:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#z23_0">allocate</a> (XMLSize_t size)=0</td></tr>
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method allocates requested memory. <a href="#z23_0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#z23_1">deallocate</a> (void *p)=0</td></tr>
2020-02-17 21:05:20 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method deallocates memory. <a href="#z23_1"></a><br></td></tr>
2020-02-17 21:17:06 +00:00
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
2020-02-17 21:19:08 +00:00
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classxercesc_1_1MemoryManager.html#z25_0">MemoryManager</a> ()</td></tr>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected default constructor. <a href="#z25_0"></a><br></td></tr>
2020-02-17 21:05:20 +00:00
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Configurable memory manager.
<p>
2020-02-17 21:19:08 +00:00
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 &amp; Destructor Documentation</h2>
<a class="anchor" name="z21_0" doxytag="xercesc::MemoryManager::~MemoryManager"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">virtual xercesc::MemoryManager::~<a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a> </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:05:20 +00:00
<p>
Default destructor.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<a class="anchor" name="z25_0" doxytag="xercesc::MemoryManager::MemoryManager"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">xercesc::MemoryManager::MemoryManager </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [inline, protected]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:05:20 +00:00
<p>
Protected default constructor.
<p>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
2020-02-17 21:17:06 +00:00
<hr><h2>Member Function Documentation</h2>
2020-02-17 21:19:08 +00:00
<a class="anchor" name="z23_0" doxytag="xercesc::MemoryManager::allocate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">virtual void* xercesc::MemoryManager::allocate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">XMLSize_t&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>size</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:05:20 +00:00
<p>
This method allocates requested memory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>The requested memory size</td></tr>
</table>
</dl>
2020-02-17 21:19:08 +00:00
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the allocated memory </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="z23_1" doxytag="xercesc::MemoryManager::deallocate"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
2020-02-17 21:05:20 +00:00
<tr>
2020-02-17 21:19:08 +00:00
<td class="md" nowrap valign="top">virtual void xercesc::MemoryManager::deallocate </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top">void *&nbsp;</td>
<td class="mdname1" valign="top" nowrap> <em>p</em> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
2020-02-17 21:05:20 +00:00
</tr>
</table>
2020-02-17 21:19:08 +00:00
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:05:20 +00:00
<p>
This method deallocates memory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>p</em>&nbsp;</td><td>The pointer to the allocated memory to be deleted </td></tr>
</table>
</dl>
2020-02-17 21:10:06 +00:00
2020-02-17 21:19:08 +00:00
<p>
Implemented in <a class="el" href="classXPath2MemoryManager.html#a6">XPath2MemoryManager</a>. </td>
</tr>
</table>
<a class="anchor" name="a0" doxytag="xercesc::MemoryManager::getExceptionMemoryManager"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual <a class="el" href="classxercesc_1_1MemoryManager.html">MemoryManager</a>* xercesc::MemoryManager::getExceptionMemoryManager </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">&nbsp;)&nbsp;</td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
2020-02-17 21:17:06 +00:00
2020-02-17 21:19:08 +00:00
<p>
This method is called to obtain the memory manager that should be used to allocate memory used in exceptions.
<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#z27_4">XMLPlatformUtils::fgMemoryManager</a>.<p>
<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the memory manager </dd></dl>
</td>
</tr>
</table>
2020-02-17 21:05:20 +00:00
<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></ul>
2020-02-17 21:19:08 +00:00
<hr size="1"><address style="align: right;"><small>Generated on Fri Sep 25 06:55:54 2009 for XQilla DOM Level 3 API by&nbsp;
2020-02-17 21:05:20 +00:00
<a href="http://www.doxygen.org/index.html">
2020-02-17 21:19:08 +00:00
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address>
2020-02-17 21:05:20 +00:00
</body>
</html>