This file is indexed.

/usr/share/doc/libucommon-dev/a00078.html is in libucommon-doc 3.2.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
<!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>UCommon: ucc::MappedMemory 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="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</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 class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00078.html">MappedMemory</a>
  </div>
</div>
<div class="contents">
<h1>ucc::MappedMemory Class Reference</h1><!-- doxytag: class="ucc::MappedMemory" -->
<p>Construct or access a named section of memory.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00196_source.html">mapped.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ucc::MappedMemory:</div>
<div class="dynsection">
<div class="center"><img src="a00435.png" border="0" usemap="#ucc_1_1_mapped_memory_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1_mapped_memory_inherit__map" id="ucc_1_1_mapped_memory_inherit__map">
<area shape="rect" id="node3" href="a00075.html" title="Template class to map typed vector into shared memory." alt="" coords="5,83,187,112"/><area shape="rect" id="node5" href="a00077.html" title="Class to access a named mapped segment published from another process." alt="" coords="211,83,387,112"/><area shape="rect" id="node7" href="a00079.html" title="Map a reusable allocator over a named shared memory segment." alt="" coords="411,83,552,112"/><area shape="rect" id="node9" href="a00076.html" title="Template class to map typed resusble objects into shared memory heap." alt="" coords="389,160,573,189"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></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">caddr_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a7d017a8edb1ad0909ecc1f521e185006">getStart</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get starting address of mapped segment.  <a href="#a7d017a8edb1ad0909ecc1f521e185006"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a1750c47e0aff47bfd3e68bc550e1409f">len</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get size of mapped segment.  <a href="#a1750c47e0aff47bfd3e68bc550e1409f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a3fbbb797bfdb751878a5b27876483c6d">MappedMemory</a> (const char *name)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Provide read-only mapped access to an existing named shared memory segment.  <a href="#a3fbbb797bfdb751878a5b27876483c6d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a51fa1984557ea74e963b97aa8cf2e38f">MappedMemory</a> (const char *name, size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct a read/write access mapped shared segment of memory of a known size.  <a href="#a51fa1984557ea74e963b97aa8cf2e38f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a46af8e434926308daf1c3e08f7d5ad60">offset</a> (size_t offset) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get memory from a specific offset within the mapped memory segment.  <a href="#a46af8e434926308daf1c3e08f7d5ad60"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a75f74b77dbe138bef90e253a339328ef">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if map active.  <a href="#a75f74b77dbe138bef90e253a339328ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a27b3986e3831ff3c9c1672f6c3299349">operator!</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Test if map is inactive.  <a href="#a27b3986e3831ff3c9c1672f6c3299349"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adfa52fb2c08ea8f87d4a948159f09730"></a><!-- doxytag: member="ucc::MappedMemory::release" ref="adfa52fb2c08ea8f87d4a948159f09730" args="(void)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#adfa52fb2c08ea8f87d4a948159f09730">release</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unmap memory segment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#aff5d59ddecd57c87ab38ab6a0b6dd62c">sbrk</a> (size_t size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Extend size of managed heap on shared memory segment.  <a href="#aff5d59ddecd57c87ab38ab6a0b6dd62c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac73aaae80b12708009248df2a0423c0d"></a><!-- doxytag: member="ucc::MappedMemory::~MappedMemory" ref="ac73aaae80b12708009248df2a0423c0d" args="()" -->
virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ac73aaae80b12708009248df2a0423c0d">~MappedMemory</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unmap memory segment. <br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#aadcccf7f466ff564729d6611a3f15a68">disable</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An API that allows "disabling" of publishing shared memory maps.  <a href="#aadcccf7f466ff564729d6611a3f15a68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#af32b948b3ca50a8bb439ea9bef4b8930">remove</a> (const char *name)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a previously existing memory segment under the specified name.  <a href="#af32b948b3ca50a8bb439ea9bef4b8930"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#a6d853e3912451fd0217547f72fd5a244">create</a> (const char *name, size_t size=(size_t) 0)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Supporting function to construct a new or access an existing shared memory segment.  <a href="#a6d853e3912451fd0217547f72fd5a244"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad95c3b9526fdcf6f8ba4aa8de0d2d7d8"></a><!-- doxytag: member="ucc::MappedMemory::fault" ref="ad95c3b9526fdcf6f8ba4aa8de0d2d7d8" args="(void) const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00078.html#ad95c3b9526fdcf6f8ba4aa8de0d2d7d8">fault</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Handler to invoke in derived class when accessing outside the shared memory segment boundry. <br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3c30daa3727b8d2a1b6fcc0fe5757274"></a><!-- doxytag: member="ucc::MappedMemory::erase" ref="a3c30daa3727b8d2a1b6fcc0fe5757274" args="" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>erase</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af05cdcf98138f9a0ff55e6c44bdb6678"></a><!-- doxytag: member="ucc::MappedMemory::idname" ref="af05cdcf98138f9a0ff55e6c44bdb6678" args="[65]" -->
char&nbsp;</td><td class="memItemRight" valign="bottom"><b>idname</b> [65]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adaaceecde71470903008de5f8a4d02d1"></a><!-- doxytag: member="ucc::MappedMemory::size" ref="adaaceecde71470903008de5f8a4d02d1" args="" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af17a282619fb11c797e3789e65ab2fd8"></a><!-- doxytag: member="ucc::MappedMemory::used" ref="af17a282619fb11c797e3789e65ab2fd8" args="" -->
size_t&nbsp;</td><td class="memItemRight" valign="bottom"><b>used</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Construct or access a named section of memory. </p>
<p>A logical name is used which might map to something that is invoked from a call like shm_open or a named w32 mapped swap segment. This is meant to support mapping a vector onto shared memory and is often used as a supporting class for our shared memory access templates. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00196_source.html#l00058">58</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a51fa1984557ea74e963b97aa8cf2e38f"></a><!-- doxytag: member="ucc::MappedMemory::MappedMemory" ref="a51fa1984557ea74e963b97aa8cf2e38f" args="(const char *name, size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::MappedMemory::MappedMemory </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Construct a read/write access mapped shared segment of memory of a known size. </p>
<p>This constructs a new memory segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of segment. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of segment. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a3fbbb797bfdb751878a5b27876483c6d"></a><!-- doxytag: member="ucc::MappedMemory::MappedMemory" ref="a3fbbb797bfdb751878a5b27876483c6d" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::MappedMemory::MappedMemory </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Provide read-only mapped access to an existing named shared memory segment. </p>
<p>The size of the map is found by the size of the already existing segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of existing segment. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a6d853e3912451fd0217547f72fd5a244"></a><!-- doxytag: member="ucc::MappedMemory::create" ref="a6d853e3912451fd0217547f72fd5a244" args="(const char *name, size_t size=(size_t) 0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ucc::MappedMemory::create </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em> = <code>(size_t)&nbsp;0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Supporting function to construct a new or access an existing shared memory segment. </p>
<p>Used by primary constructors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of segment to create or access. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of segment if creating new. Use 0 for read-only access. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aadcccf7f466ff564729d6611a3f15a68"></a><!-- doxytag: member="ucc::MappedMemory::disable" ref="aadcccf7f466ff564729d6611a3f15a68" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void ucc::MappedMemory::disable </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>An API that allows "disabling" of publishing shared memory maps. </p>
<p>This may be useful when an app doesn't want to use shared memory as a runtime or build option, but does not want to have to be "recoded" exclicity for non-shared memory either. Basically it substitutes a dummy map running on the local heap. </p>

</div>
</div>
<a class="anchor" id="a7d017a8edb1ad0909ecc1f521e185006"></a><!-- doxytag: member="ucc::MappedMemory::getStart" ref="a7d017a8edb1ad0909ecc1f521e185006" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">caddr_t ucc::MappedMemory::getStart </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get starting address of mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>starting address of mapped segment. </dd></dl>

<p>Definition at line <a class="el" href="a00196_source.html#l00162">162</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1750c47e0aff47bfd3e68bc550e1409f"></a><!-- doxytag: member="ucc::MappedMemory::len" ref="a1750c47e0aff47bfd3e68bc550e1409f" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t ucc::MappedMemory::len </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get size of mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of mapped segment. </dd></dl>

<p>Definition at line <a class="el" href="a00196_source.html#l00155">155</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>

</div>
</div>
<a class="anchor" id="a46af8e434926308daf1c3e08f7d5ad60"></a><!-- doxytag: member="ucc::MappedMemory::offset" ref="a46af8e434926308daf1c3e08f7d5ad60" args="(size_t offset) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* ucc::MappedMemory::offset </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>offset</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get memory from a specific offset within the mapped memory segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>offset</em>&nbsp;</td><td>from start of segment. Will fault if past end. </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>address of offset. </dd></dl>

</div>
</div>
<a class="anchor" id="a75f74b77dbe138bef90e253a339328ef"></a><!-- doxytag: member="ucc::MappedMemory::operator bool" ref="a75f74b77dbe138bef90e253a339328ef" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ucc::MappedMemory::operator bool </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Test if map active. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if active map. </dd></dl>

<p>Reimplemented in <a class="el" href="a00076.html#a0f97fd1654b110132c5d7b88fd3d1475">ucc::mapped_reuse&lt; T &gt;</a>.</p>

<p>Definition at line <a class="el" href="a00196_source.html#l00125">125</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>

</div>
</div>
<a class="anchor" id="a27b3986e3831ff3c9c1672f6c3299349"></a><!-- doxytag: member="ucc::MappedMemory::operator!" ref="a27b3986e3831ff3c9c1672f6c3299349" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ucc::MappedMemory::operator! </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Test if map is inactive. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if map inactive. </dd></dl>

<p>Reimplemented in <a class="el" href="a00076.html#a718e2aaca553791a031fbe9acb72050f">ucc::mapped_reuse&lt; T &gt;</a>.</p>

<p>Definition at line <a class="el" href="a00196_source.html#l00132">132</a> of file <a class="el" href="a00196_source.html">mapped.h</a>.</p>

</div>
</div>
<a class="anchor" id="af32b948b3ca50a8bb439ea9bef4b8930"></a><!-- doxytag: member="ucc::MappedMemory::remove" ref="af32b948b3ca50a8bb439ea9bef4b8930" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void ucc::MappedMemory::remove </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destroy a previously existing memory segment under the specified name. </p>
<p>This is used both before creating a new one, and after a publishing process unmaps the segment it created. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>name</em>&nbsp;</td><td>of segment to remove. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="aff5d59ddecd57c87ab38ab6a0b6dd62c"></a><!-- doxytag: member="ucc::MappedMemory::sbrk" ref="aff5d59ddecd57c87ab38ab6a0b6dd62c" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* ucc::MappedMemory::sbrk </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Extend size of managed heap on shared memory segment. </p>
<p>This does not change the size of the mapped segment in any way, only that of any heap space that is being allocated and used from the mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>start of space from map. </dd></dl>
<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>&nbsp;</td><td>of space requested. Will fault if past end of segment. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00196_source.html">mapped.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:34 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>