alex
/
libsdr
mirror of https://github.com/hmatuschek/libsdr
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
master
gh-pages
v0.1.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'gh-pages'
${ noResults }
libsdr/classsdr_1_1_queue_1_1_mess...

420 lines
19 KiB
HTML
Raw Permalink Blame History

<!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::Queue::Message 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
&#160;<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;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_queue.html">Queue</a></li><li class="navelem"><a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classsdr_1_1_queue_1_1_message-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">sdr::Queue::Message Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The internal used message type.
<a href="classsdr_1_1_queue_1_1_message.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="queue_8hh_source.html">queue.hh</a>&gt;</code></p>
<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:a69200e761a282cda093aec9b23d6febe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a69200e761a282cda093aec9b23d6febe">Message</a> (const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;<a class="el" href="classsdr_1_1_queue_1_1_message.html#aa023b90e3e9c9f66639f24924f9a94e7">buffer</a>, <a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *<a class="el" href="classsdr_1_1_queue_1_1_message.html#a8df22de4fd6608016d5b20716138c5f7">sink</a>, bool allow_overwrite)</td></tr>
<tr class="memdesc:a69200e761a282cda093aec9b23d6febe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="#a69200e761a282cda093aec9b23d6febe">More...</a><br /></td></tr>
<tr class="separator:a69200e761a282cda093aec9b23d6febe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3475f0dd585f7d92b21b70710ed1616e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a3475f0dd585f7d92b21b70710ed1616e">Message</a> (const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a> &amp;other)</td></tr>
<tr class="memdesc:a3475f0dd585f7d92b21b70710ed1616e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#a3475f0dd585f7d92b21b70710ed1616e">More...</a><br /></td></tr>
<tr class="separator:a3475f0dd585f7d92b21b70710ed1616e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81ba08e644a4c224d395dff8524b2875"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a81ba08e644a4c224d395dff8524b2875">operator=</a> (const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a> &amp;other)</td></tr>
<tr class="memdesc:a81ba08e644a4c224d395dff8524b2875"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="#a81ba08e644a4c224d395dff8524b2875">More...</a><br /></td></tr>
<tr class="separator:a81ba08e644a4c224d395dff8524b2875"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa023b90e3e9c9f66639f24924f9a94e7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#aa023b90e3e9c9f66639f24924f9a94e7">buffer</a> () const </td></tr>
<tr class="memdesc:aa023b90e3e9c9f66639f24924f9a94e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the buffer of the message. <a href="#aa023b90e3e9c9f66639f24924f9a94e7">More...</a><br /></td></tr>
<tr class="separator:aa023b90e3e9c9f66639f24924f9a94e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc914df82e28a4dd8093b6b6e294640d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#abc914df82e28a4dd8093b6b6e294640d">buffer</a> ()</td></tr>
<tr class="memdesc:abc914df82e28a4dd8093b6b6e294640d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the buffer of the message. <a href="#abc914df82e28a4dd8093b6b6e294640d">More...</a><br /></td></tr>
<tr class="separator:abc914df82e28a4dd8093b6b6e294640d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8df22de4fd6608016d5b20716138c5f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a8df22de4fd6608016d5b20716138c5f7">sink</a> () const </td></tr>
<tr class="memdesc:a8df22de4fd6608016d5b20716138c5f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the destination of the message. <a href="#a8df22de4fd6608016d5b20716138c5f7">More...</a><br /></td></tr>
<tr class="separator:a8df22de4fd6608016d5b20716138c5f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd22d9aa751e2bd05f22b00df91d1668"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#acd22d9aa751e2bd05f22b00df91d1668">allowOverwrite</a> () const </td></tr>
<tr class="memdesc:acd22d9aa751e2bd05f22b00df91d1668"><td class="mdescLeft">&#160;</td><td class="mdescRight">If true, the sender allows to overwrite the content of the buffer. <a href="#acd22d9aa751e2bd05f22b00df91d1668">More...</a><br /></td></tr>
<tr class="separator:acd22d9aa751e2bd05f22b00df91d1668"><td class="memSeparator" colspan="2">&#160;</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:a920ee574314cfa09d49b423c90e45674"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a920ee574314cfa09d49b423c90e45674">_buffer</a></td></tr>
<tr class="memdesc:a920ee574314cfa09d49b423c90e45674"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer being send. <a href="#a920ee574314cfa09d49b423c90e45674">More...</a><br /></td></tr>
<tr class="separator:a920ee574314cfa09d49b423c90e45674"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0dac26785e72edd9cb7154ca1f265353"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#a0dac26785e72edd9cb7154ca1f265353">_sink</a></td></tr>
<tr class="memdesc:a0dac26785e72edd9cb7154ca1f265353"><td class="mdescLeft">&#160;</td><td class="mdescRight">The destination. <a href="#a0dac26785e72edd9cb7154ca1f265353">More...</a><br /></td></tr>
<tr class="separator:a0dac26785e72edd9cb7154ca1f265353"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace94bf2702c9a1590b4c1257cbec0dee"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsdr_1_1_queue_1_1_message.html#ace94bf2702c9a1590b4c1257cbec0dee">_allow_overwrite</a></td></tr>
<tr class="memdesc:ace94bf2702c9a1590b4c1257cbec0dee"><td class="mdescLeft">&#160;</td><td class="mdescRight">If true, the sender allows to overwrite the buffer. <a href="#ace94bf2702c9a1590b4c1257cbec0dee">More...</a><br /></td></tr>
<tr class="separator:ace94bf2702c9a1590b4c1257cbec0dee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The internal used message type. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a69200e761a282cda093aec9b23d6febe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sdr::Queue::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> &amp;&#160;</td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a> *&#160;</td>
<td class="paramname"><em>sink</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>allow_overwrite</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Constructor. </p>
</div>
</div>
<a class="anchor" id="a3475f0dd585f7d92b21b70710ed1616e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">sdr::Queue::Message::Message </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></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>Copy constructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acd22d9aa751e2bd05f22b00df91d1668"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sdr::Queue::Message::allowOverwrite </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>If true, the sender allows to overwrite the content of the buffer. </p>
</div>
</div>
<a class="anchor" id="aa023b90e3e9c9f66639f24924f9a94e7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a>&amp; sdr::Queue::Message::buffer </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 the buffer of the message. </p>
</div>
</div>
<a class="anchor" id="abc914df82e28a4dd8093b6b6e294640d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a>&amp; sdr::Queue::Message::buffer </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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 the buffer of the message. </p>
</div>
</div>
<a class="anchor" id="a81ba08e644a4c224d395dff8524b2875"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a>&amp; sdr::Queue::Message::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classsdr_1_1_queue_1_1_message.html">Message</a> &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></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>Assignment operator. </p>
</div>
</div>
<a class="anchor" id="a8df22de4fd6608016d5b20716138c5f7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a>* sdr::Queue::Message::sink </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 the destination of the message. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ace94bf2702c9a1590b4c1257cbec0dee"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sdr::Queue::Message::_allow_overwrite</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 sender allows to overwrite the buffer. </p>
</div>
</div>
<a class="anchor" id="a920ee574314cfa09d49b423c90e45674"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_raw_buffer.html">RawBuffer</a> sdr::Queue::Message::_buffer</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 buffer being send. </p>
</div>
</div>
<a class="anchor" id="a0dac26785e72edd9cb7154ca1f265353"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classsdr_1_1_sink_base.html">SinkBase</a>* sdr::Queue::Message::_sink</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 destination. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/hannes/Uni/Elektronik/sdr/libsdr/src/<a class="el" href="queue_8hh_source.html">queue.hh</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 2 2015 18:28:39 for libsdr by &#160;<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>
Reference in New Issue View Git Blame Copy Permalink