<!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_file_descriptor_source 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_file_descriptor_source Class Reference<br/>
<small>
[<a class="el" href="group__source__blk.html">Signal Sources</a>]</small>
</h1><!-- doxytag: class="gr_file_descriptor_source" --><!-- doxytag: inherits="gr_sync_block" -->
<p>Read stream from file descriptor.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="gr__file__descriptor__source_8h_source.html">gr_file_descriptor_source.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for gr_file_descriptor_source:</div>
<div class="dynsection">
<div class="center"><img src="classgr__file__descriptor__source__inherit__graph.png" border="0" usemap="#gr__file__descriptor__source_inherit__map" alt="Inheritance graph"/></div>
<map name="gr__file__descriptor__source_inherit__map" id="gr__file__descriptor__source_inherit__map">
<area shape="rect" id="node2" href="classgr__sync__block.html" title="synchronous 1:1 input to output with historyOverride work to provide the signal processing..." alt="" coords="35,160,141,189"/><area shape="rect" id="node4" href="classgr__block.html" title="The abstract base class for all 'terminal' processing blocks.A signal processing..." alt="" coords="53,83,123,112"/><area shape="rect" id="node6" href="classgr__basic__block.html" title="The abstract base class for all signal processing blocks.Basic blocks are the bare..." alt="" coords="33,5,143,35"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classgr__file__descriptor__source-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a8553a2b7f53a6ffe8754860177c6a714">~gr_file_descriptor_source</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a28a7c20d750296c73c14c1391605ab19">work</a> (int noutput_items, <a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> &input_items, <a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> &output_items)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you <a href="#a28a7c20d750296c73c14c1391605ab19"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a18569b6c876227223e861d66c726218d">gr_file_descriptor_source</a> (size_t itemsize, int fd, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> repeat)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a19ace13388bd5037196b9ee4dce0543a">read_items</a> (char *buf, int nitems)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#af0f9a847bf3cb06905b587e47368340e">handle_residue</a> (char *buf, int nbytes_read)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a11599f25e05597bdda4f7e003435fecb">flush_residue</a> ()</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboost_1_1shared__ptr.html">gr_file_descriptor_source_sptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgr__file__descriptor__source.html#a5eb5d8d1aa70425cfd14c69f91da71a9">gr_make_file_descriptor_source</a> (size_t itemsize, int fd, <a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> repeat)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Read stream from file descriptor. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a18569b6c876227223e861d66c726218d"></a><!-- doxytag: member="gr_file_descriptor_source::gr_file_descriptor_source" ref="a18569b6c876227223e861d66c726218d" args="(size_t itemsize, int fd, bool repeat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_descriptor_source::gr_file_descriptor_source </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>repeat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a8553a2b7f53a6ffe8754860177c6a714"></a><!-- doxytag: member="gr_file_descriptor_source::~gr_file_descriptor_source" ref="a8553a2b7f53a6ffe8754860177c6a714" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gr_file_descriptor_source::~gr_file_descriptor_source </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a11599f25e05597bdda4f7e003435fecb"></a><!-- doxytag: member="gr_file_descriptor_source::flush_residue" ref="a11599f25e05597bdda4f7e003435fecb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gr_file_descriptor_source::flush_residue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="af0f9a847bf3cb06905b587e47368340e"></a><!-- doxytag: member="gr_file_descriptor_source::handle_residue" ref="af0f9a847bf3cb06905b587e47368340e" args="(char *buf, int nbytes_read)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_file_descriptor_source::handle_residue </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nbytes_read</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a19ace13388bd5037196b9ee4dce0543a"></a><!-- doxytag: member="gr_file_descriptor_source::read_items" ref="a19ace13388bd5037196b9ee4dce0543a" args="(char *buf, int nitems)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_file_descriptor_source::read_items </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>buf</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>nitems</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a28a7c20d750296c73c14c1391605ab19"></a><!-- doxytag: member="gr_file_descriptor_source::work" ref="a28a7c20d750296c73c14c1391605ab19" args="(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int gr_file_descriptor_source::work </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>noutput_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_const_void_star</a> & </td>
<td class="paramname"> <em>input_items</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classstd_1_1vector.html">gr_vector_void_star</a> & </td>
<td class="paramname"> <em>output_items</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>just like <a class="el" href="classgr__block.html#a137b93d87dc83bbdb6369d33f4ea8197" title="compute output items from input items">gr_block::general_work</a>, only this arranges to call consume_each for you </p>
<p>The user must override work to define the signal processing code </p>
<p>Implements <a class="el" href="classgr__sync__block.html#a0c523f4285a6eb690f677ee6295ab117">gr_sync_block</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a5eb5d8d1aa70425cfd14c69f91da71a9"></a><!-- doxytag: member="gr_file_descriptor_source::gr_make_file_descriptor_source" ref="a5eb5d8d1aa70425cfd14c69f91da71a9" args="(size_t itemsize, int fd, bool repeat)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboost_1_1shared__ptr.html">gr_file_descriptor_source_sptr</a> gr_make_file_descriptor_source </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>itemsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>fd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="gc__types_8h.html#a0f2b5d454b7e4dda3861032cfce91085">bool</a> </td>
<td class="paramname"> <em>repeat</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</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__file__descriptor__source_8h_source.html">gr_file_descriptor_source.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>
