diff options
Diffstat (limited to 'classwinapi_1_1SharedMemory.html')
| -rw-r--r-- | classwinapi_1_1SharedMemory.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/classwinapi_1_1SharedMemory.html b/classwinapi_1_1SharedMemory.html new file mode 100644 index 0000000..e638368 --- /dev/null +++ b/classwinapi_1_1SharedMemory.html @@ -0,0 +1,245 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>winapi_common: winapi::SharedMemory Class Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">winapi_common + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><b>winapi</b></li><li class="navelem"><a class="el" href="classwinapi_1_1SharedMemory.html">SharedMemory</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-static-methods">Static Public Member Functions</a> | +<a href="classwinapi_1_1SharedMemory-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">winapi::SharedMemory Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Named shared memory region. + <a href="classwinapi_1_1SharedMemory.html#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:ada3f0075608dd1541f54f004e18a4775"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1SharedMemory.html#ada3f0075608dd1541f54f004e18a4775">get</a> () const</td></tr> +<tr class="separator:ada3f0075608dd1541f54f004e18a4775"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a44e75ba35ae3e470fb521f6274991673"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1SharedMemory.html#a44e75ba35ae3e470fb521f6274991673">ptr</a> () const</td></tr> +<tr class="separator:a44e75ba35ae3e470fb521f6274991673"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> +Static Public Member Functions</h2></td></tr> +<tr class="memitem:a475d4dcdf99d777cb0968d7631cc6f7e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1SharedMemory.html#a475d4dcdf99d777cb0968d7631cc6f7e">create</a> (const std::string &name, std::size_t nb)</td></tr> +<tr class="separator:a475d4dcdf99d777cb0968d7631cc6f7e"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a82eafb0e7c2c6b5af1a7ff8945af2027"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classwinapi_1_1SharedMemory.html#a82eafb0e7c2c6b5af1a7ff8945af2027">open</a> (const std::string &name)</td></tr> +<tr class="separator:a82eafb0e7c2c6b5af1a7ff8945af2027"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Named shared memory region. </p> + +<p class="definition">Definition at line <a class="el" href="shmem_8hpp_source.html#l00019">19</a> of file <a class="el" href="shmem_8hpp_source.html">shmem.hpp</a>.</p> +</div><h2 class="groupheader">Member Function Documentation</h2> +<a id="a475d4dcdf99d777cb0968d7631cc6f7e"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a475d4dcdf99d777cb0968d7631cc6f7e">◆ </a></span>create()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> winapi::SharedMemory::create </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>nb</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Creates a shared memory region. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>UTF-8 string. </td></tr> + <tr><td class="paramname">nb</td><td>Number of bytes. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="shmem_8cpp_source.html#l00040">40</a> of file <a class="el" href="shmem_8cpp_source.html">shmem.cpp</a>.</p> + +</div> +</div> +<a id="a82eafb0e7c2c6b5af1a7ff8945af2027"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a82eafb0e7c2c6b5af1a7ff8945af2027">◆ </a></span>open()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classwinapi_1_1SharedMemory.html">SharedMemory</a> winapi::SharedMemory::open </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>name</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">static</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Opens a shared memory region. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>UTF-8 string. </td></tr> + </table> + </dd> +</dl> + +<p class="definition">Definition at line <a class="el" href="shmem_8cpp_source.html#l00059">59</a> of file <a class="el" href="shmem_8cpp_source.html">shmem.cpp</a>.</p> + +</div> +</div> +<a id="ada3f0075608dd1541f54f004e18a4775"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ada3f0075608dd1541f54f004e18a4775">◆ </a></span>get()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void* winapi::SharedMemory::get </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Get pointer to the data. </p> + +<p class="definition">Definition at line <a class="el" href="shmem_8hpp_source.html#l00034">34</a> of file <a class="el" href="shmem_8hpp_source.html">shmem.hpp</a>.</p> + +</div> +</div> +<a id="a44e75ba35ae3e470fb521f6274991673"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a44e75ba35ae3e470fb521f6274991673">◆ </a></span>ptr()</h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void* winapi::SharedMemory::ptr </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td> const</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. </p> + +<p class="definition">Definition at line <a class="el" href="shmem_8hpp_source.html#l00036">36</a> of file <a class="el" href="shmem_8hpp_source.html">shmem.hpp</a>.</p> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>include/winapi/<a class="el" href="shmem_8hpp_source.html">shmem.hpp</a></li> +<li>src/<a class="el" href="shmem_8cpp_source.html">shmem.cpp</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 +</small></address> +</body> +</html> |