Sophie

Sophie

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

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: data_handler.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('data__handler_8h.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<h1>data_handler.h</h1>  </div>
</div>
<div class="contents">
<a href="data__handler_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 2008 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 along</span>
<a name="l00018"></a>00018 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00019"></a>00019 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef INCLUDED_DATA_HANDLER_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_DATA_HANDLER_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include &lt;stdint.h&gt;</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;stddef.h&gt;</span>
<a name="l00026"></a>00026 
<a name="l00027"></a>00027 <span class="keyword">namespace </span>usrp2 {
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment">  /*!</span>
<a name="l00030"></a>00030 <span class="comment">   * \brief Abstract function object called to handle received data blocks.</span>
<a name="l00031"></a>00031 <span class="comment">   */</span>
<a name="l00032"></a><a class="code" href="classusrp2_1_1data__handler.html">00032</a>   <span class="keyword">class </span><a class="code" href="classusrp2_1_1data__handler.html" title="Abstract function object called to handle received data blocks.">data_handler</a> 
<a name="l00033"></a>00033   {
<a name="l00034"></a>00034   <span class="keyword">public</span>:
<a name="l00035"></a>00035 
<a name="l00036"></a><a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1f">00036</a>     <span class="keyword">enum</span> <a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1f">result_bits</a> {
<a name="l00037"></a><a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1fac7506490d9b638b59cd2a151ec75dfe1">00037</a>       <a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1fac7506490d9b638b59cd2a151ec75dfe1">RELEASE</a>   = 0x0000,       <span class="comment">//&lt; OK to release data (opposite of KEEP)</span>
<a name="l00038"></a><a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1facaebcc1d16db0a6697c902860ba8caf6">00038</a>       <a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1facaebcc1d16db0a6697c902860ba8caf6">KEEP</a>      = 0x0001,       <span class="comment">//&lt; do not discard data</span>
<a name="l00039"></a><a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1fa4f6eb3ace3f9b56c9f158a7760ae792e">00039</a>       <a class="code" href="classusrp2_1_1data__handler.html#a5ce66dd7fa850f1aef3f3a6e7b369a1fa4f6eb3ace3f9b56c9f158a7760ae792e">DONE</a>      = 0x0002,       <span class="comment">//&lt; do not call this object again</span>
<a name="l00040"></a>00040     };
<a name="l00041"></a>00041     
<a name="l00042"></a><a class="code" href="classusrp2_1_1data__handler.html#ae3cfdbd2cebb63c565df513556114ab6">00042</a>     <span class="keyword">typedef</span> <span class="keywordtype">int</span> <a class="code" href="classusrp2_1_1data__handler.html#ae3cfdbd2cebb63c565df513556114ab6">result</a>;         <span class="comment">//&lt; bitmask of result_bits</span>
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">    /*!</span>
<a name="l00045"></a>00045 <span class="comment">     * \param base points to the beginning of the data</span>
<a name="l00046"></a>00046 <span class="comment">     * \param len is the length in bytes of the data</span>
<a name="l00047"></a>00047 <span class="comment">     * \returns bitmask composed of DONE, KEEP</span>
<a name="l00048"></a>00048 <span class="comment">     */</span>
<a name="l00049"></a>00049     <span class="keyword">virtual</span> <a class="code" href="classusrp2_1_1data__handler.html#ae3cfdbd2cebb63c565df513556114ab6">result</a> <a class="code" href="classusrp2_1_1data__handler.html#a151f3e63f81507503a39f03a77092201">operator()</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *base, <span class="keywordtype">size_t</span> len) = 0;
<a name="l00050"></a>00050     <span class="keyword">virtual</span> <a class="code" href="classusrp2_1_1data__handler.html#a5f6cf79201388a4aff926a4f1ada949e">~data_handler</a>();
<a name="l00051"></a>00051   };
<a name="l00052"></a>00052 
<a name="l00053"></a>00053 } <span class="comment">// namespace usrp2</span>
<a name="l00054"></a>00054 
<a name="l00055"></a>00055 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_DATA_HANDLER_H */</span>
</pre></div></div>
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="data__handler_8h.html">data_handler.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>