jens/xerces-c-3.0.0
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
master
xerces-c-3.0.0/doc/html/apiDocs-3/classMemoryManager.html
T
jens adea0d681b Initial import 
git-svn-id: http://moon:8086/svn/software/trunk/libsrc/xerces-c-3.0.0@1 b431acfa-c32f-4a4a-93f1-934dc6c82436
2014-07-19 07:44:42 +00:00

184 lines
9.1 KiB
HTML
Executable File
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=UTF-8">
<title>Xerces-C++: MemoryManager Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.4 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
<li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
<h1>MemoryManager Class Reference</h1><!-- doxytag: class="MemoryManager" -->Configurable memory manager.
<a href="#_details">More...</a>
<p>
<p>
<a href="classMemoryManager-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classMemoryManager.html">MemoryManager</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#6587b83bc36e193c35b33d8f45836a54">getExceptionMemoryManager</a> ()=0</td></tr>
<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="#6587b83bc36e193c35b33d8f45836a54"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Destructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#069aa716f72688713e925ddcfd712b83">~MemoryManager</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor. <a href="#069aa716f72688713e925ddcfd712b83"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">The pure virtual methods in this interface.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#4955a5c169b701c6106c1541bbb96f17">allocate</a> (<a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a> size)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method allocates requested memory. <a href="#4955a5c169b701c6106c1541bbb96f17"></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="classMemoryManager.html#f7dce9eab3a2a41e5b887ba735180e67">deallocate</a> (void *p)=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This method deallocates memory. <a href="#f7dce9eab3a2a41e5b887ba735180e67"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Constructor</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMemoryManager.html#e925e8ad4d8fe6f0565e9d5729f59593">MemoryManager</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Protected default constructor. <a href="#e925e8ad4d8fe6f0565e9d5729f59593"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Configurable memory manager.
<p>
This interface allows outside applications to plug in their own memory manager to be used by Xerces for memory allocation/deallocation. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="069aa716f72688713e925ddcfd712b83"></a><!-- doxytag: member="MemoryManager::~MemoryManager" ref="069aa716f72688713e925ddcfd712b83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual MemoryManager::~MemoryManager </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default destructor.
<p>
</div>
</div><p>
<a class="anchor" name="e925e8ad4d8fe6f0565e9d5729f59593"></a><!-- doxytag: member="MemoryManager::MemoryManager" ref="e925e8ad4d8fe6f0565e9d5729f59593" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MemoryManager::MemoryManager </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Protected default constructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="6587b83bc36e193c35b33d8f45836a54"></a><!-- doxytag: member="MemoryManager::getExceptionMemoryManager" ref="6587b83bc36e193c35b33d8f45836a54" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classMemoryManager.html">MemoryManager</a>* MemoryManager::getExceptionMemoryManager </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><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>
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="classXMLPlatformUtils.html#97eff0d9fff3567bea3acd3ca4d95252" title="The configurable memory manager.">XMLPlatformUtils::fgMemoryManager</a>.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the memory manager </dd></dl>
</div>
</div><p>
<a class="anchor" name="4955a5c169b701c6106c1541bbb96f17"></a><!-- doxytag: member="MemoryManager::allocate" ref="4955a5c169b701c6106c1541bbb96f17" args="(XMLSize_t size)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void* MemoryManager::allocate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="Xerces__autoconf__config_8msvc_8hpp.html#c0f7e36996cd03eb43bcee10321f77cd">XMLSize_t</a>&nbsp;</td>
<td class="paramname"> <em>size</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A pointer to the allocated memory </dd></dl>
</div>
</div><p>
<a class="anchor" name="f7dce9eab3a2a41e5b887ba735180e67"></a><!-- doxytag: member="MemoryManager::deallocate" ref="f7dce9eab3a2a41e5b887ba735180e67" args="(void *p)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void MemoryManager::deallocate </td>
<td>(</td>
<td class="paramtype">void *&nbsp;</td>
<td class="paramname"> <em>p</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
</div>
</div><p>
<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>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 24 16:36:34 2008 for Xerces-C++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4 </small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink