Sophie

Sophie

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

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_createfilemapping.h Source File</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('gr__vmcircbuf__createfilemapping_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>gr_vmcircbuf_createfilemapping.h</h1>  </div>
</div>
<div class="contents">
<a href="gr__vmcircbuf__createfilemapping_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2003,2005 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING.  If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022 
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef _GR_VMCIRCBUF_CREATEFILEMAPPING_H_</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define _GR_VMCIRCBUF_CREATEFILEMAPPING_H_</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;<a class="code" href="gr__vmcircbuf_8h.html">gr_vmcircbuf.h</a>&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#ifdef HAVE_CREATEFILEMAPPING</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#include &lt;windows.h&gt;</span>
<a name="l00030"></a>00030 <span class="preprocessor">#endif</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="comment">/*!</span>
<a name="l00032"></a>00032 <span class="comment"> * \brief concrete class to implement circular buffers with mmap and shm_open</span>
<a name="l00033"></a>00033 <span class="comment"> * \ingroup internal</span>
<a name="l00034"></a>00034 <span class="comment"> */</span>
<a name="l00035"></a><a class="code" href="classgr__vmcircbuf__createfilemapping.html">00035</a> <span class="keyword">class </span><a class="code" href="classgr__vmcircbuf__createfilemapping.html" title="concrete class to implement circular buffers with mmap and shm_open">gr_vmcircbuf_createfilemapping</a> : <span class="keyword">public</span> <a class="code" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a>
<a name="l00036"></a>00036 {
<a name="l00037"></a>00037  <span class="keyword">public</span>:
<a name="l00038"></a>00038    <span class="comment">// CREATORS</span>
<a name="l00039"></a>00039    <a class="code" href="classgr__vmcircbuf__createfilemapping.html#a876a3f41d86d3258d7a89b5140e5a878">gr_vmcircbuf_createfilemapping</a> (<span class="keywordtype">int</span> size);
<a name="l00040"></a>00040    <span class="keyword">virtual</span> <a class="code" href="classgr__vmcircbuf__createfilemapping.html#acef2105613235dc05b651c3b4de0f470">~gr_vmcircbuf_createfilemapping</a> ();
<a name="l00041"></a>00041 <span class="preprocessor">#ifdef HAVE_CREATEFILEMAPPING</span>
<a name="l00042"></a>00042 <span class="preprocessor"></span> <span class="keyword">private</span>:
<a name="l00043"></a>00043    HANDLE d_handle;
<a name="l00044"></a>00044    LPVOID d_first_copy;
<a name="l00045"></a>00045    LPVOID d_second_copy;
<a name="l00046"></a>00046 <span class="preprocessor">#endif</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span>};
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/*!</span>
<a name="l00050"></a>00050 <span class="comment"> * \brief concrete factory for circular buffers built using mmap and shm_open</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a><a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html">00052</a> <span class="keyword">class </span><a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html" title="concrete factory for circular buffers built using mmap and shm_open">gr_vmcircbuf_createfilemapping_factory</a> : <span class="keyword">public</span> <a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a>
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054  <span class="keyword">private</span>:
<a name="l00055"></a>00055   <span class="keyword">static</span> <a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> *s_the_factory;
<a name="l00056"></a>00056 
<a name="l00057"></a>00057  <span class="keyword">public</span>:
<a name="l00058"></a>00058   <span class="keyword">static</span> <a class="code" href="classgr__vmcircbuf__factory.html" title="abstract factory for creating circular buffers">gr_vmcircbuf_factory</a> *<a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html#a620fffad1ab22cbb0d64f34cd984c0db">singleton</a> ();
<a name="l00059"></a>00059 
<a name="l00060"></a><a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html#afebcc0ac89ace2edb8808b44f5828f53">00060</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html#afebcc0ac89ace2edb8808b44f5828f53" title="return name of this factory">name</a> ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;gr_vmcircbuf_createfilemapping_factory&quot;</span>; }
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">  /*!</span>
<a name="l00063"></a>00063 <span class="comment">   * \brief return granularity of mapping, typically equal to page size</span>
<a name="l00064"></a>00064 <span class="comment">   */</span>
<a name="l00065"></a>00065   <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html#af9432da478e5bd419d7085d5c9ba02c2" title="return granularity of mapping, typically equal to page size">granularity</a> ();
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a>00067 <span class="comment">  /*!</span>
<a name="l00068"></a>00068 <span class="comment">   * \brief return a gr_vmcircbuf, or 0 if unable.</span>
<a name="l00069"></a>00069 <span class="comment">   *</span>
<a name="l00070"></a>00070 <span class="comment">   * Call this to create a doubly mapped circular buffer.</span>
<a name="l00071"></a>00071 <span class="comment">   */</span>
<a name="l00072"></a>00072   <span class="keyword">virtual</span> <a class="code" href="classgr__vmcircbuf.html" title="abstract class to implement doubly mapped virtual memory circular buffers">gr_vmcircbuf</a> *<a class="code" href="classgr__vmcircbuf__createfilemapping__factory.html#a9c26dfdb72af8766cb7073bd818b125b" title="return a gr_vmcircbuf, or 0 if unable.">make</a> (<span class="keywordtype">int</span> size);
<a name="l00073"></a>00073 };
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 <span class="preprocessor">#endif </span><span class="comment">/* _GR_VMCIRCBUF_CREATEFILEMAPPING_H_ */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="gr__vmcircbuf__createfilemapping_8h.html">gr_vmcircbuf_createfilemapping.h</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>