<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: gr_vmcircbuf_sysv_shm_factory 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</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 style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classgr__vmcircbuf__sysv__shm__factory.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="classgr__vmcircbuf__sysv__shm__factory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">gr_vmcircbuf_sysv_shm_factory Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>concrete factory for circular buffers built using mmap and shm_open
<a href="classgr__vmcircbuf__sysv__shm__factory.html#details">More...</a></p>
<p><code>#include <<a class="el" href="gr__vmcircbuf__sysv__shm_8h_source.html">gr_vmcircbuf_sysv_shm.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_vmcircbuf_sysv_shm_factory:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__vmcircbuf__sysv__shm__factory__inherit__graph.png" border="0" usemap="#gr__vmcircbuf__sysv__shm__factory_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__vmcircbuf__sysv__shm__factory_inherit__map" id="gr__vmcircbuf__sysv__shm__factory_inherit__map">
<area shape="rect" id="node2" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers" alt="" coords="15,5,159,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:a2d0f2257634ca1f73969fca21f477959"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html#a2d0f2257634ca1f73969fca21f477959">name</a> () const </td></tr>
<tr class="memdesc:a2d0f2257634ca1f73969fca21f477959"><td class="mdescLeft"> </td><td class="mdescRight">return name of this factory <a href="#a2d0f2257634ca1f73969fca21f477959"></a><br/></td></tr>
<tr class="separator:a2d0f2257634ca1f73969fca21f477959"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a551727a238e3bb70091dfa8e6059c96f"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html#a551727a238e3bb70091dfa8e6059c96f">granularity</a> ()</td></tr>
<tr class="memdesc:a551727a238e3bb70091dfa8e6059c96f"><td class="mdescLeft"> </td><td class="mdescRight">return granularity of mapping, typically equal to page size <a href="#a551727a238e3bb70091dfa8e6059c96f"></a><br/></td></tr>
<tr class="separator:a551727a238e3bb70091dfa8e6059c96f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb2c3faf0cd7b50c472c7b163aa9b177"><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__sysv__shm__factory.html#abb2c3faf0cd7b50c472c7b163aa9b177">make</a> (int size)</td></tr>
<tr class="memdesc:abb2c3faf0cd7b50c472c7b163aa9b177"><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="#abb2c3faf0cd7b50c472c7b163aa9b177"></a><br/></td></tr>
<tr class="separator:abb2c3faf0cd7b50c472c7b163aa9b177"><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:ae2eb8cac1ed69a907a9b6d14a4238576"><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__sysv__shm__factory.html#ae2eb8cac1ed69a907a9b6d14a4238576">singleton</a> ()</td></tr>
<tr class="separator:ae2eb8cac1ed69a907a9b6d14a4238576"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_methods_classgr__vmcircbuf__factory"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgr__vmcircbuf__factory')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classgr__vmcircbuf__factory.html">gr_vmcircbuf_factory</a></td></tr>
<tr class="memitem:a5d08857f4d2c09b0bd027963cf904a10 inherit pro_methods_classgr__vmcircbuf__factory"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#a5d08857f4d2c09b0bd027963cf904a10">gr_vmcircbuf_factory</a> ()</td></tr>
<tr class="separator:a5d08857f4d2c09b0bd027963cf904a10 inherit pro_methods_classgr__vmcircbuf__factory"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af7b1bc5f8cf80eadd8f771a8931e10cf inherit pro_methods_classgr__vmcircbuf__factory"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__factory.html#af7b1bc5f8cf80eadd8f771a8931e10cf">~gr_vmcircbuf_factory</a> ()</td></tr>
<tr class="separator:af7b1bc5f8cf80eadd8f771a8931e10cf inherit pro_methods_classgr__vmcircbuf__factory"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>concrete factory for circular buffers built using mmap and shm_open </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a551727a238e3bb70091dfa8e6059c96f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int gr_vmcircbuf_sysv_shm_factory::granularity </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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="abb2c3faf0cd7b50c472c7b163aa9b177"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a>* gr_vmcircbuf_sysv_shm_factory::make </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </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="a2d0f2257634ca1f73969fca21f477959"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* gr_vmcircbuf_sysv_shm_factory::name </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 class="mlabel">virtual</span></span> </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="ae2eb8cac1ed69a907a9b6d14a4238576"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classgr__vmcircbuf__factory.html">gr_vmcircbuf_factory</a>* gr_vmcircbuf_sysv_shm_factory::singleton </td>
<td>(</td>
<td class="paramname"></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">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="gr__vmcircbuf__sysv__shm_8h_source.html">gr_vmcircbuf_sysv_shm.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="classgr__vmcircbuf__sysv__shm__factory.html">gr_vmcircbuf_sysv_shm_factory</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:39 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
