aboutsummaryrefslogtreecommitdiff
path: root/doc/oscl_html/classOsclMemBasicAllocator.html
blob: eae0b0d2ec760282d222d1bedff4caab46d39f0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>oscl: OsclMemBasicAllocator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>OsclMemBasicAllocator Class Reference<br/>
<small>
[<a class="el" href="group__osclmemory.html">OSCL Memory</a>]</small>
</h1><!-- doxytag: class="OsclMemBasicAllocator" --><!-- doxytag: inherits="Oscl_DefAlloc" -->
<p><code>#include &lt;<a class="el" href="oscl__mem_8h_source.html">oscl_mem.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for OsclMemBasicAllocator:</div>
<div class="dynsection">
 <div class="center">
  <img src="classOsclMemBasicAllocator.png" usemap="#OsclMemBasicAllocator_map" alt=""/>
  <map id="OsclMemBasicAllocator_map" name="OsclMemBasicAllocator_map">
<area href="classOscl__DefAlloc.html" alt="Oscl_DefAlloc" shape="rect" coords="78,56,225,80"/>
<area href="classOscl__Alloc.html" alt="Oscl_Alloc" shape="rect" coords="0,0,147,24"/>
<area href="classOscl__Dealloc.html" alt="Oscl_Dealloc" shape="rect" coords="157,0,304,24"/>
</map>
 </div>
</div>
<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"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemBasicAllocator.html#acca11a39ad1075f73d702d3a02e4c5a5">allocate</a> (const uint32 n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOsclMemBasicAllocator.html#a013b743aaf17acd40e08f720530048cb">deallocate</a> (<a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *p)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A simple allocator class that does not use the memory management.</p>
<p>Note: this allocator is for internal use by Oscl only. Higher level code should use <a class="el" href="classOsclMemAllocator.html">OsclMemAllocator</a>. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acca11a39ad1075f73d702d3a02e4c5a5"></a><!-- doxytag: member="OsclMemBasicAllocator::allocate" ref="acca11a39ad1075f73d702d3a02e4c5a5" args="(const uint32 n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a>* OsclMemBasicAllocator::allocate </td>
          <td>(</td>
          <td class="paramtype">const uint32&nbsp;</td>
          <td class="paramname"> <em>n</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>This API throws an exception when malloc returns NULL. n must be greater than 0.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>pointer (or Leave with OsclErrNoMemory ) </dd></dl>

<p>Implements <a class="el" href="classOscl__DefAlloc.html#a9ce71dcd2aa11b34e7d30a175fef42e0">Oscl_DefAlloc</a>.</p>

<p>References <a class="el" href="group__osclmemory.html#gac26198ea976235d69f4140bcc63246a0">_oscl_malloc()</a>, <a class="el" href="classOsclError.html#aca9829cfcc11ff580338353602c38e0d">OsclError::LeaveIfNull()</a>, and <a class="el" href="group__osclmemory.html#ga93ce8ea351e601f7d68094199190178b">oscl_memset()</a>.</p>

<p>Referenced by <a class="el" href="oscl__mem_8h_source.html#l00847">OsclMemBasicAllocDestructDealloc&lt; T &gt;::allocate()</a>.</p>

</div>
</div>
<a class="anchor" id="a013b743aaf17acd40e08f720530048cb"></a><!-- doxytag: member="OsclMemBasicAllocator::deallocate" ref="a013b743aaf17acd40e08f720530048cb" args="(OsclAny *p)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OsclMemBasicAllocator::deallocate </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__osclbase.html#ga3bac54662348f5e6c08b97ca97066b89">OsclAny</a> *&nbsp;</td>
          <td class="paramname"> <em>p</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implements <a class="el" href="classOscl__DefAlloc.html#a517d6b431b966f79a745e73d1a0a438f">Oscl_DefAlloc</a>.</p>

<p>References <a class="el" href="group__osclmemory.html#ga952e5011acf2fddbf25c0791f54963cb">_oscl_free()</a>.</p>

<p>Referenced by <a class="el" href="oscl__mem_8h_source.html#l00855">OsclMemBasicAllocDestructDealloc&lt; T &gt;::deallocate()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="oscl__mem_8h_source.html">oscl_mem.h</a></li>
</ul>
</div>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small>
<address style="align: left;"><small>Posting Version: CORE_9.004.1.1 </small>
</small></address>
</body>
</html>