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
|
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
<TITLE>nevrax.org : docs</TITLE>
<LINK REL=stylesheet TYPE="text/css" HREF="/inc/css/nevrax.css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">
<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0>
<TR>
<TD WIDTH=16><IMG SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD WIDTH=16><IMG SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF='/'><b>Home</B></FONT></A> </TD>
<TD><IMG width=6 height=14 SRC="/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=><b>nevrax.com</B></FONT></A> </TD>
</TR>
</TABLE>
<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%>
<TR><TD BGCOLOR="#000000" BACKGROUND="/inc/img/black_banner.jpg"><A HREF=""><IMG SRC="/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>
<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%>
<TR>
<TD WIDTH=16><IMG SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
<TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
<!------ Begin Box ------>
<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF>
<TABLE cellspacing=0 cellpadding=1 border=0>
<tr><td ALIGN=middle><a class='linkbox' href="/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="/news/" TITLE="News">News</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="/docs/" TITLE="Documentation">Documentation</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="/cvs/" TITLE="CVS Web">CVS</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
<tr><td ALIGN=middle><a class='linkbox' href="/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="/GPL.php3" TITLE="License">License</a></td></tr>
</TABLE>
</TD></TR></TABLE></TD></TR></TABLE>
<!------ End Box ------>
</TD>
<TD WIDTH=15><IMG SRC="/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
<TD ALIGN=left valign=top><IMG SRC="/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">
<!-- title -->
<TABLE background="/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td>
<A HREF="/docs/"><img src="/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG SRC="/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
<!-- block -->
<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="/inc/img/reddots.gif"></TD>
<TD><B>Documentation</B></TD>
<TD ALIGN=RIGHT> </td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:/cgi-bin/nel-search.cgi" href="/cgi-bin/nel-search.cgi">Search</a> </center>
<hr><h1>NLMISC::CSharedMemory Class Reference</h1>Encapsulation of shared memory APIs.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="shared__memory_8h-source.html">shared_memory.h</a>></code>
<p>
<a href="classNLMISC_1_1CSharedMemory-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classNLMISC_1_1CSharedMemory.html#d0">createSharedMemory</a> (<a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> sharedMemId, <a class="el" href="memory__common_8h.html#a11">uint32</a> <a class="el" href="cf__lexical_8cpp.html#a94">size</a>)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a shared memory segment and get access to it.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void * </td><td valign=bottom><a class="el" href="classNLMISC_1_1CSharedMemory.html#d1">accessSharedMemory</a> (<a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> sharedMemId)</td></tr>
<tr><td> </td><td><font size=-1><em>Get access to an existing shared memory segment.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classNLMISC_1_1CSharedMemory.html#d2">closeSharedMemory</a> (void *accessAddress)</td></tr>
<tr><td> </td><td><font size=-1><em>Close a shared memory segment, given the address returned by <a class="el" href="classNLMISC_1_1CSharedMemory.html#d0">createSharedMemory</a>() or <a class="el" href="classNLMISC_1_1CSharedMemory.html#d1">accessSharedMemory</a>().</em> <a href="#d2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classNLMISC_1_1CSharedMemory.html#d3">destroySharedMemory</a> (<a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> sharedMemId, bool force=false)</td></tr>
<tr><td> </td><td><font size=-1><em>Destroy a shared memory segment (must be call by the process that created the segment, not by the accessors).</em> <a href="#d3">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Encapsulation of shared memory APIs.
<p>
Using file mapping under Windows, System V shared memory (shm) under Linux.
<p>
Note: under Linux, an option could be added to prevent a segment to be swapped out.
<p>
<dl compact><dt><b>
Author: </b><dd>
Olivier Cado , Nevrax France </dl><dl compact><dt><b>
Date: </b><dd>
2002 </dl>
<p>
<p>
Definition at line <a class="el" href="shared__memory_8h-source.html#l00068">68</a> of file <a class="el" href="shared__memory_8h-source.html">shared_memory.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="d1" doxytag="NLMISC::CSharedMemory::accessSharedMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void * NLMISC::CSharedMemory::accessSharedMemory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> </td>
<td class="mdname1" valign="top" nowrap> <em>sharedMemId</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get access to an existing shared memory segment.
<p>
The id must be used. <dl compact><dt><b>
Returns: </b><dd>
Access address of the segment. Its size was determined at the creation. </dl>
<p>
Definition at line <a class="el" href="shared__memory_8cpp-source.html#l00090">90</a> of file <a class="el" href="shared__memory_8cpp-source.html">shared_memory.cpp</a>.
<p>
References <a class="el" href="shared__memory_8h-source.html#l00041">NLMISC::TSharedMemId</a>. </td>
</tr>
</table>
<a name="d2" doxytag="NLMISC::CSharedMemory::closeSharedMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool NLMISC::CSharedMemory::closeSharedMemory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname1" valign="top" nowrap> <em>accessAddress</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Close a shared memory segment, given the address returned by <a class="el" href="classNLMISC_1_1CSharedMemory.html#d0">createSharedMemory</a>() or <a class="el" href="classNLMISC_1_1CSharedMemory.html#d1">accessSharedMemory</a>().
<p>
Must be called by each process that called <a class="el" href="classNLMISC_1_1CSharedMemory.html#d0">createSharedMemory</a>() or <a class="el" href="classNLMISC_1_1CSharedMemory.html#d1">accessSharedMemory</a>().
<p>
Definition at line <a class="el" href="shared__memory_8cpp-source.html#l00125">125</a> of file <a class="el" href="shared__memory_8cpp-source.html">shared_memory.cpp</a>. </td>
</tr>
</table>
<a name="d0" doxytag="NLMISC::CSharedMemory::createSharedMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void * NLMISC::CSharedMemory::createSharedMemory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> </td>
<td class="mdname" nowrap> <em>sharedMemId</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap><a class="el" href="memory__common_8h.html#a11">uint32</a> </td>
<td class="mdname" nowrap> <em>size</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a shared memory segment and get access to it.
<p>
The id must not be used. The id 0x3a732235 is used by the NeL memory manager. <dl compact><dt><b>
Returns: </b><dd>
Access address of the segment of the choosen size </dl>
<p>
Definition at line <a class="el" href="shared__memory_8cpp-source.html#l00055">55</a> of file <a class="el" href="shared__memory_8cpp-source.html">shared_memory.cpp</a>.
<p>
References <a class="el" href="shared__memory_8cpp-source.html#l00048">NLMISC::SharedMemIdsToShmids</a>, and <a class="el" href="shared__memory_8h-source.html#l00041">NLMISC::TSharedMemId</a>. </td>
</tr>
</table>
<a name="d3" doxytag="NLMISC::CSharedMemory::destroySharedMemory"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void NLMISC::CSharedMemory::destroySharedMemory </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a176">TSharedMemId</a> </td>
<td class="mdname" nowrap> <em>sharedMemId</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>force</em> = false</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroy a shared memory segment (must be call by the process that created the segment, not by the accessors).
<p>
"Rescue feature": set "force" to true if a segment was created and left out of control (meaning a new <a class="el" href="classNLMISC_1_1CSharedMemory.html#d0">createSharedMemory</a>() with the same sharedMemId fails), but before, make sure the segment really belongs to you!
<p>
Note: this method does nothing under Windows, destroying is automatic.
<p>
Definition at line <a class="el" href="shared__memory_8cpp-source.html#l00159">159</a> of file <a class="el" href="shared__memory_8cpp-source.html">shared_memory.cpp</a>.
<p>
References <a class="el" href="shared__memory_8cpp-source.html#l00048">NLMISC::SharedMemIdsToShmids</a>, and <a class="el" href="shared__memory_8h-source.html#l00041">NLMISC::TSharedMemId</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="shared__memory_8h-source.html">shared_memory.h</a><li><a class="el" href="shared__memory_8cpp-source.html">shared_memory.cpp</a></ul>
<!-- footer -->
<BR><FONT Size=+5> </FONT>
</TD>
<TD WIDTH=15><IMG SRC=/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
