diff options
Diffstat (limited to 'docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html')
| -rw-r--r-- | docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html b/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html new file mode 100644 index 00000000..fe9cae18 --- /dev/null +++ b/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html @@ -0,0 +1,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="http://www.nevrax.org/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="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><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="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/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="http://www.nevrax.org/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:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/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=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |