mirror of https://github.com/hmatuschek/libsdr
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
508 lines
33 KiB
HTML
508 lines
33 KiB
HTML
<!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.9.1"/>
|
|
<title>libsdr: sdr::BlockingSource 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="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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">libsdr
|
|
 <span id="projectnumber">0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">A simple SDR library</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>sdr</b></li><li class="navelem"><a class="el" href="classsdr_1_1_blocking_source.html">BlockingSource</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classsdr_1_1_blocking_source-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">sdr::BlockingSource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Iterface of a blocking source.
|
|
<a href="classsdr_1_1_blocking_source.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="node_8hh_source.html">node.hh</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for sdr::BlockingSource:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classsdr_1_1_blocking_source.png" usemap="#sdr::BlockingSource_map" alt=""/>
|
|
<map id="sdr::BlockingSource_map" name="sdr::BlockingSource_map">
|
|
<area href="classsdr_1_1_source.html" title="Generic source class. " alt="sdr::Source" shape="rect" coords="0,0,125,24"/>
|
|
</map>
|
|
</div></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:a4590feb79e59560b713af72107c8882b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a4590feb79e59560b713af72107c8882b">BlockingSource</a> (bool parallel=false, bool connect_idle=true, bool stop_queue_on_eos=false)</td></tr>
|
|
<tr class="memdesc:a4590feb79e59560b713af72107c8882b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4590feb79e59560b713af72107c8882b">More...</a><br /></td></tr>
|
|
<tr class="separator:a4590feb79e59560b713af72107c8882b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c5ff3213be1919ccf24fd2568806cb3"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a4c5ff3213be1919ccf24fd2568806cb3">~BlockingSource</a> ()</td></tr>
|
|
<tr class="memdesc:a4c5ff3213be1919ccf24fd2568806cb3"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a4c5ff3213be1919ccf24fd2568806cb3">More...</a><br /></td></tr>
|
|
<tr class="separator:a4c5ff3213be1919ccf24fd2568806cb3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a41188f9ed0b1658908ef3bc6e62ffcce"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a41188f9ed0b1658908ef3bc6e62ffcce">next</a> ()=0</td></tr>
|
|
<tr class="memdesc:a41188f9ed0b1658908ef3bc6e62ffcce"><td class="mdescLeft"> </td><td class="mdescRight">This method gets called either by the <code><a class="el" href="classsdr_1_1_queue.html" title="Central message queue (singleton). ">Queue</a></code> on idle events or by a thread to read more data from the input stream. <a href="#a41188f9ed0b1658908ef3bc6e62ffcce">More...</a><br /></td></tr>
|
|
<tr class="separator:a41188f9ed0b1658908ef3bc6e62ffcce"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a982d9e5c670e2a738dd5ae3cc783c9ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a982d9e5c670e2a738dd5ae3cc783c9ea">isActive</a> () const </td></tr>
|
|
<tr class="memdesc:a982d9e5c670e2a738dd5ae3cc783c9ea"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the source is active. <a href="#a982d9e5c670e2a738dd5ae3cc783c9ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a982d9e5c670e2a738dd5ae3cc783c9ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60ad748162edddcb2d2c21e7f81ba021"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a60ad748162edddcb2d2c21e7f81ba021">start</a> ()</td></tr>
|
|
<tr class="memdesc:a60ad748162edddcb2d2c21e7f81ba021"><td class="mdescLeft"> </td><td class="mdescRight">This function starts the input stream. <a href="#a60ad748162edddcb2d2c21e7f81ba021">More...</a><br /></td></tr>
|
|
<tr class="separator:a60ad748162edddcb2d2c21e7f81ba021"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aabf983bae519915df7e76f429cfce872"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#aabf983bae519915df7e76f429cfce872">stop</a> ()</td></tr>
|
|
<tr class="memdesc:aabf983bae519915df7e76f429cfce872"><td class="mdescLeft"> </td><td class="mdescRight">This function stops the input stream. <a href="#aabf983bae519915df7e76f429cfce872">More...</a><br /></td></tr>
|
|
<tr class="separator:aabf983bae519915df7e76f429cfce872"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classsdr_1_1_source')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
|
|
<tr class="memitem:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a660c0a4b8b8f8402568bef86f2cb2fbb">Source</a> ()</td></tr>
|
|
<tr class="memdesc:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a660c0a4b8b8f8402568bef86f2cb2fbb">More...</a><br /></td></tr>
|
|
<tr class="separator:a660c0a4b8b8f8402568bef86f2cb2fbb inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac5104a4d66641ae529419b47da4a1473">~Source</a> ()</td></tr>
|
|
<tr class="memdesc:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac5104a4d66641ae529419b47da4a1473">More...</a><br /></td></tr>
|
|
<tr class="separator:ac5104a4d66641ae529419b47da4a1473 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a13921d5daa00574e2057c1ae1fc28054">send</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &buffer, bool allow_overwrite=false)</td></tr>
|
|
<tr class="memdesc:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Sends the given buffer to all connected sinks. <a href="#a13921d5daa00574e2057c1ae1fc28054">More...</a><br /></td></tr>
|
|
<tr class="separator:a13921d5daa00574e2057c1ae1fc28054 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac7df1faefb31e72e135eec3ecf539132">connect</a> (<a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *sink, bool direct=false)</td></tr>
|
|
<tr class="memdesc:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Connect this source to a sink. <a href="#ac7df1faefb31e72e135eec3ecf539132">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7df1faefb31e72e135eec3ecf539132 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a9b1d1ccef6cee5f4668ee67bc28eed7a">disconnect</a> (<a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *sink)</td></tr>
|
|
<tr class="memdesc:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Disconnect a sink again. <a href="#a9b1d1ccef6cee5f4668ee67bc28eed7a">More...</a><br /></td></tr>
|
|
<tr class="separator:a9b1d1ccef6cee5f4668ee67bc28eed7a inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#afd4c7e3fb94a057ac40e9877167791ec">setConfig</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &config)</td></tr>
|
|
<tr class="memdesc:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Stores the configuration and propergates it if the configuration has been changed. <a href="#afd4c7e3fb94a057ac40e9877167791ec">More...</a><br /></td></tr>
|
|
<tr class="separator:afd4c7e3fb94a057ac40e9877167791ec inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#aca6c3a89bb5787de5657c4d221bb1ed4">sampleRate</a> () const </td></tr>
|
|
<tr class="memdesc:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Returns the configured sample rate or <code>0</code> otherwise. <a href="#aca6c3a89bb5787de5657c4d221bb1ed4">More...</a><br /></td></tr>
|
|
<tr class="separator:aca6c3a89bb5787de5657c4d221bb1ed4 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classsdr_1_1_config.html#a62084c40ed753ff6caefdc4564c597b8">Config::Type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ab9362057c06f35e0a23901cc0556b976">type</a> () const </td></tr>
|
|
<tr class="memdesc:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Returns the configured source type or <code>Config::Type_UNDEFINED</code> otherwise. <a href="#ab9362057c06f35e0a23901cc0556b976">More...</a><br /></td></tr>
|
|
<tr class="separator:ab9362057c06f35e0a23901cc0556b976 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
|
|
<tr class="memitem:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a7cf977be7a508097532991155e90ae45">addEOS</a> (T *instance, void(T::*function)())</td></tr>
|
|
<tr class="memdesc:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Adds a callback to the end-of-stream signal of the source. <a href="#a7cf977be7a508097532991155e90ae45">More...</a><br /></td></tr>
|
|
<tr class="separator:a7cf977be7a508097532991155e90ae45 inherit pub_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a9846623aa13f2743fe5de6eb7d6024c6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a9846623aa13f2743fe5de6eb7d6024c6">_parallel_main</a> ()</td></tr>
|
|
<tr class="memdesc:a9846623aa13f2743fe5de6eb7d6024c6"><td class="mdescLeft"> </td><td class="mdescRight">The parallel main loop. <a href="#a9846623aa13f2743fe5de6eb7d6024c6">More...</a><br /></td></tr>
|
|
<tr class="separator:a9846623aa13f2743fe5de6eb7d6024c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af8effc9fd6b088738e95719e5e242caf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#af8effc9fd6b088738e95719e5e242caf">_nonvirt_idle_cb</a> ()</td></tr>
|
|
<tr class="memdesc:af8effc9fd6b088738e95719e5e242caf"><td class="mdescLeft"> </td><td class="mdescRight">The non-virtual idle callback. <a href="#af8effc9fd6b088738e95719e5e242caf">More...</a><br /></td></tr>
|
|
<tr class="separator:af8effc9fd6b088738e95719e5e242caf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_methods_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classsdr_1_1_source')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
|
|
<tr class="memitem:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a30eeb1d98d9759ef01a36e938a1172bc">signalEOS</a> ()</td></tr>
|
|
<tr class="memdesc:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Signals the EOS. <a href="#a30eeb1d98d9759ef01a36e938a1172bc">More...</a><br /></td></tr>
|
|
<tr class="separator:a30eeb1d98d9759ef01a36e938a1172bc inherit pro_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a3fbd9bdaf370acad141440388da2100c">propagateConfig</a> (const <a class="el" href="classsdr_1_1_config.html">Config</a> &config)</td></tr>
|
|
<tr class="memdesc:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Propagates the given configuration to all connected sinks. <a href="#a3fbd9bdaf370acad141440388da2100c">More...</a><br /></td></tr>
|
|
<tr class="separator:a3fbd9bdaf370acad141440388da2100c inherit pro_methods_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a47c22cd9fc949b7745279970d26c9008"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a47c22cd9fc949b7745279970d26c9008">_is_active</a></td></tr>
|
|
<tr class="memdesc:a47c22cd9fc949b7745279970d26c9008"><td class="mdescLeft"> </td><td class="mdescRight">If true, the source is active. <a href="#a47c22cd9fc949b7745279970d26c9008">More...</a><br /></td></tr>
|
|
<tr class="separator:a47c22cd9fc949b7745279970d26c9008"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0dba272393a870e9cfd2934a9737fb0a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a0dba272393a870e9cfd2934a9737fb0a">_is_parallel</a></td></tr>
|
|
<tr class="memdesc:a0dba272393a870e9cfd2934a9737fb0a"><td class="mdescLeft"> </td><td class="mdescRight">If true, the surce is processed in parallel. <a href="#a0dba272393a870e9cfd2934a9737fb0a">More...</a><br /></td></tr>
|
|
<tr class="separator:a0dba272393a870e9cfd2934a9737fb0a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6395ea6ce34f3db1dadba775af35fd5f"><td class="memItemLeft" align="right" valign="top">pthread_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_blocking_source.html#a6395ea6ce34f3db1dadba775af35fd5f">_thread</a></td></tr>
|
|
<tr class="memdesc:a6395ea6ce34f3db1dadba775af35fd5f"><td class="mdescLeft"> </td><td class="mdescRight">The thread of the source. <a href="#a6395ea6ce34f3db1dadba775af35fd5f">More...</a><br /></td></tr>
|
|
<tr class="separator:a6395ea6ce34f3db1dadba775af35fd5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pro_attribs_classsdr_1_1_source"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classsdr_1_1_source')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classsdr_1_1_source.html">sdr::Source</a></td></tr>
|
|
<tr class="memitem:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_config.html">Config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#ac7ea547c33d45cf5b5654ce21957ab27">_config</a></td></tr>
|
|
<tr class="memdesc:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">Holds the source configuration, this can be updated by calling <code>setConfig</code>. <a href="#ac7ea547c33d45cf5b5654ce21957ab27">More...</a><br /></td></tr>
|
|
<tr class="separator:ac7ea547c33d45cf5b5654ce21957ab27 inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">std::map< <a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *, bool > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#a2d030b840c4a1ad45d7a6598f9f582b9">_sinks</a></td></tr>
|
|
<tr class="memdesc:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">The connected sinks. <a href="#a2d030b840c4a1ad45d7a6598f9f582b9">More...</a><br /></td></tr>
|
|
<tr class="separator:a2d030b840c4a1ad45d7a6598f9f582b9 inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="memItemLeft" align="right" valign="top">std::list< <a class="el" href="classsdr_1_1_delegate_interface.html">DelegateInterface</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_source.html#aee600dc30d6f91466acec5ffcde0f3ac">_eos</a></td></tr>
|
|
<tr class="memdesc:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="mdescLeft"> </td><td class="mdescRight">The connected EOS singal handlers. <a href="#aee600dc30d6f91466acec5ffcde0f3ac">More...</a><br /></td></tr>
|
|
<tr class="separator:aee600dc30d6f91466acec5ffcde0f3ac inherit pro_attribs_classsdr_1_1_source"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Iterface of a blocking source. </p>
|
|
<p>Blocking sources are usually input sources that wait for data from a device or file. Please note, a proper input source that reads data from a file should emmit the eos signal using the <code>signalEOS</code> method. This can be used to stop the <code><a class="el" href="classsdr_1_1_queue.html" title="Central message queue (singleton). ">Queue</a></code> loop once the input can not provide data anymore. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a4590feb79e59560b713af72107c8882b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BlockingSource::BlockingSource </td>
|
|
<td>(</td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>parallel</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>connect_idle</em> = <code>true</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>stop_queue_on_eos</em> = <code>false</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parallel</td><td>Specifies whether the source is waiting in a separate thread for new data. </td></tr>
|
|
<tr><td class="paramname">connect_idle</td><td>Specifies wheter the input source <code><a class="el" href="classsdr_1_1_blocking_source.html#a41188f9ed0b1658908ef3bc6e62ffcce" title="This method gets called either by the Queue on idle events or by a thread to read more data from the ...">next()</a></code> method should be connected to the idle signal of the <code><a class="el" href="classsdr_1_1_queue.html" title="Central message queue (singleton). ">Queue</a></code>. </td></tr>
|
|
<tr><td class="paramname">stop_queue_on_eos</td><td>Signals the that the <a class="el" href="classsdr_1_1_queue.html" title="Central message queue (singleton). ">Queue</a> should be stopped once the EOS is reached. Use this flag only if this source is the only source in the data stream. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a4c5ff3213be1919ccf24fd2568806cb3"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">BlockingSource::~BlockingSource </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>Destructor. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="af8effc9fd6b088738e95719e5e242caf"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BlockingSource::_nonvirt_idle_cb </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The non-virtual idle callback. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a9846623aa13f2743fe5de6eb7d6024c6"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BlockingSource::_parallel_main </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The parallel main loop. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a982d9e5c670e2a738dd5ae3cc783c9ea"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdr::BlockingSource::isActive </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> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns true if the source is active. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a41188f9ed0b1658908ef3bc6e62ffcce"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void sdr::BlockingSource::next </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>This method gets called either by the <code><a class="el" href="classsdr_1_1_queue.html" title="Central message queue (singleton). ">Queue</a></code> on idle events or by a thread to read more data from the input stream. </p>
|
|
<p>The <code>next</code> function should be blocking in order to avoid busy waiting on incomming data. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a60ad748162edddcb2d2c21e7f81ba021"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BlockingSource::start </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>This function starts the input stream. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aabf983bae519915df7e76f429cfce872"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void BlockingSource::stop </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>This function stops the input stream. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="a47c22cd9fc949b7745279970d26c9008"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdr::BlockingSource::_is_active</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>If true, the source is active. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0dba272393a870e9cfd2934a9737fb0a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool sdr::BlockingSource::_is_parallel</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>If true, the surce is processed in parallel. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6395ea6ce34f3db1dadba775af35fd5f"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">pthread_t sdr::BlockingSource::_thread</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The thread of the source. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="node_8hh_source.html">node.hh</a></li>
|
|
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/node.cc</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Jun 1 2015 11:43:48 for libsdr by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|