Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 6e7a2755bd78c9deedab199b86e675f3 > files > 2244

gnuradio-doc-3.2.2-9.fc14.x86_64.rpm

<!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_tmpfile_factory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<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.2.2 C++ API</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classgr__vmcircbuf__mmap__tmpfile__factory.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<h1>gr_vmcircbuf_mmap_tmpfile_factory Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="gr_vmcircbuf_mmap_tmpfile_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 &lt;<a class="el" href="gr__vmcircbuf__mmap__tmpfile_8h_source.html">gr_vmcircbuf_mmap_tmpfile.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gr_vmcircbuf_mmap_tmpfile_factory:</div>
<div class="dyncontent">
<div class="center"><img src="classgr__vmcircbuf__mmap__tmpfile__factory__inherit__graph.png" border="0" usemap="#gr__vmcircbuf__mmap__tmpfile__factory_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__vmcircbuf__mmap__tmpfile__factory_inherit__map" id="gr__vmcircbuf__mmap__tmpfile__factory_inherit__map">
<area shape="rect" id="node2" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers" alt="" coords="49,5,193,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classgr__vmcircbuf__mmap__tmpfile__factory-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#a96b5bc3b5be9becb3304ebd99ff7a98f">name</a> () const </td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return name of this factory  <a href="#a96b5bc3b5be9becb3304ebd99ff7a98f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#af21cbed100a7518c960af20b570c93e6">granularity</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return granularity of mapping, typically equal to page size  <a href="#af21cbed100a7518c960af20b570c93e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgr__vmcircbuf.html">gr_vmcircbuf</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#a3d1ede7a9b2c35892b2237bef39a10ca">make</a> (int size)</td></tr>
<tr><td class="mdescLeft">&#160;</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="#a3d1ede7a9b2c35892b2237bef39a10ca"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
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> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html#a7ae863b82c23b9696425fa60b06639f5">singleton</a> ()</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>concrete factory for circular buffers built using mmap and shm_open </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af21cbed100a7518c960af20b570c93e6"></a><!-- doxytag: member="gr_vmcircbuf_mmap_tmpfile_factory::granularity" ref="af21cbed100a7518c960af20b570c93e6" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int gr_vmcircbuf_mmap_tmpfile_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="a3d1ede7a9b2c35892b2237bef39a10ca"></a><!-- doxytag: member="gr_vmcircbuf_mmap_tmpfile_factory::make" ref="a3d1ede7a9b2c35892b2237bef39a10ca" 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_tmpfile_factory::make </td>
          <td>(</td>
          <td class="paramtype">int&#160;</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="a96b5bc3b5be9becb3304ebd99ff7a98f"></a><!-- doxytag: member="gr_vmcircbuf_mmap_tmpfile_factory::name" ref="a96b5bc3b5be9becb3304ebd99ff7a98f" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* gr_vmcircbuf_mmap_tmpfile_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="a7ae863b82c23b9696425fa60b06639f5"></a><!-- doxytag: member="gr_vmcircbuf_mmap_tmpfile_factory::singleton" ref="a7ae863b82c23b9696425fa60b06639f5" 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_tmpfile_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__tmpfile_8h_source.html">gr_vmcircbuf_mmap_tmpfile.h</a></li>
</ul>
</div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="classgr__vmcircbuf__mmap__tmpfile__factory.html">gr_vmcircbuf_mmap_tmpfile_factory</a>      </li>
      <li class="footer">Generated on Thu Feb 17 2011 for GNU Radio 3.2.2 C++ API by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
    </ul>
  </div>

</body>
</html>