<!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>GNU Radio 3.2.2 C++ API: gr_vmcircbuf_mmap_shm_open_factory 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.2 -->
<div class="contents">
<h1>gr_vmcircbuf_mmap_shm_open_factory Class Reference</h1><!-- doxytag: class="gr_vmcircbuf_mmap_shm_open_factory" --><!-- doxytag: inherits="gr_vmcircbuf_factory" -->
<p>concrete factory for circular buffers built using mmap and shm_open
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__vmcircbuf__mmap__shm__open_8h_source.html">gr_vmcircbuf_mmap_shm_open.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_vmcircbuf_mmap_shm_open_factory:</div>
<div class="dynsection">
<div class="center"><img src="classgr__vmcircbuf__mmap__shm__open__factory__inherit__graph.png" border="0" usemap="#gr__vmcircbuf__mmap__shm__open__factory_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__vmcircbuf__mmap__shm__open__factory_inherit__map" id="gr__vmcircbuf__mmap__shm__open__factory_inherit__map">
<area shape="rect" id="node2" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers" alt="" coords="60,5,204,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__vmcircbuf__mmap__shm__open__factory-members.html">List of all members.</a></p>
<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">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#a32b247e41531e9162e7c2d43ca5f0425">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return name of this factory <a href="#a32b247e41531e9162e7c2d43ca5f0425"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#ae5fc13be16d326275a05e178daacc6db">granularity</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return granularity of mapping, typically equal to page size <a href="#ae5fc13be16d326275a05e178daacc6db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#a36d1a5b9ec8316b5c49257fada79d5f3">make</a> (int size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">return a <a class="el" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a>, or 0 if unable. <a href="#a36d1a5b9ec8316b5c49257fada79d5f3"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgr__vmcircbuf__factory.html">gr_vmcircbuf_factory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__shm__open__factory.html#ac3003e43ff5d69eca049959a54cb7e05">singleton</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>concrete factory for circular buffers built using mmap and shm_open </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ae5fc13be16d326275a05e178daacc6db"></a><!-- doxytag: member="gr_vmcircbuf_mmap_shm_open_factory::granularity" ref="ae5fc13be16d326275a05e178daacc6db" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int gr_vmcircbuf_mmap_shm_open_factory::granularity </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return granularity of mapping, typically equal to page size </p>
<p>Implements <a class="el" href="classgr__vmcircbuf__factory.html#a1e6730e738aef0a4164538ce8bcf5e8d">gr_vmcircbuf_factory</a>.</p>
</div>
</div>
<a class="anchor" id="a36d1a5b9ec8316b5c49257fada79d5f3"></a><!-- doxytag: member="gr_vmcircbuf_mmap_shm_open_factory::make" ref="a36d1a5b9ec8316b5c49257fada79d5f3" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a>* gr_vmcircbuf_mmap_shm_open_factory::make </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return a <a class="el" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a>, or 0 if unable. </p>
<p>Call this to create a doubly mapped circular buffer. </p>
<p>Implements <a class="el" href="classgr__vmcircbuf__factory.html#a93e1d9a839a9edc332e1b7b9eb594293">gr_vmcircbuf_factory</a>.</p>
</div>
</div>
<a class="anchor" id="a32b247e41531e9162e7c2d43ca5f0425"></a><!-- doxytag: member="gr_vmcircbuf_mmap_shm_open_factory::name" ref="a32b247e41531e9162e7c2d43ca5f0425" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* gr_vmcircbuf_mmap_shm_open_factory::name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>return name of this factory </p>
<p>Implements <a class="el" href="classgr__vmcircbuf__factory.html#ac8f96616c04ac03db2c5f9fa0c2d728d">gr_vmcircbuf_factory</a>.</p>
</div>
</div>
<a class="anchor" id="ac3003e43ff5d69eca049959a54cb7e05"></a><!-- doxytag: member="gr_vmcircbuf_mmap_shm_open_factory::singleton" ref="ac3003e43ff5d69eca049959a54cb7e05" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgr__vmcircbuf__factory.html">gr_vmcircbuf_factory</a>* gr_vmcircbuf_mmap_shm_open_factory::singleton </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__vmcircbuf__mmap__shm__open_8h_source.html">gr_vmcircbuf_mmap_shm_open.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
