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.
libsdr/ax25_8hh_source.html

153 lines
15 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: /Users/hannes/Uni/Elektronik/sdr/libsdr/src/ax25.hh Source File</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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</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"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">ax25.hh</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __SDR_AX25_HH__</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __SDR_AX25_HH__</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;node.hh&quot;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesdr.html">sdr</a> {</div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html"> 21</a></span>&#160;<span class="keyword">class </span><a class="code" href="classsdr_1_1_a_x25.html">AX25</a>: <span class="keyword">public</span> <a class="code" href="classsdr_1_1_sink.html">Sink</a>&lt;uint8_t&gt;, <span class="keyword">public</span> <a class="code" href="classsdr_1_1_source.html">Source</a></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;{</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classsdr_1_1_a_x25.html#aebbe666ff47df7ea8a868a1ab552d34f">AX25</a>();</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; <span class="keyword">virtual</span> <a class="code" href="classsdr_1_1_a_x25.html#ae5221438081b14c4b22662eb6e79b8af">~AX25</a>();</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsdr_1_1_a_x25.html#a35ae34c6c6337f67adbcb3a6e0c8fac8">config</a>(<span class="keyword">const</span> <a class="code" href="classsdr_1_1_config.html">Config</a> &amp;src_cfg);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classsdr_1_1_a_x25.html#abadb32804529f36819c675c4c746ff4c">process</a>(<span class="keyword">const</span> <a class="code" href="classsdr_1_1_buffer.html">Buffer&lt;uint8_t&gt;</a> &amp;buffer, <span class="keywordtype">bool</span> allow_overwrite);</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="classsdr_1_1_a_x25.html#a05c586d156e856b0820aef7669512368">unpackCall</a>(<span class="keyword">const</span> uint8_t *buffer, std::string &amp;call, <span class="keywordtype">int</span> &amp;ssid, <span class="keywordtype">bool</span> &amp;addrExt);</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="keyword">protected</span>:</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#ac84c7af0b37d6c6359f4098b96dc36b0"> 38</a></span>&#160; uint32_t <a class="code" href="classsdr_1_1_a_x25.html#ac84c7af0b37d6c6359f4098b96dc36b0">_bitstream</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#a6260b7c8fc548edca0cfc18fb5303b83"> 40</a></span>&#160; uint32_t <a class="code" href="classsdr_1_1_a_x25.html#a6260b7c8fc548edca0cfc18fb5303b83">_bitbuffer</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#a65d296d63bbd33fd0ece2f865b12cc3d"> 42</a></span>&#160; uint32_t <a class="code" href="classsdr_1_1_a_x25.html#a65d296d63bbd33fd0ece2f865b12cc3d">_state</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div>
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#a861bace14bcb17b833a5dce8668d719d"> 45</a></span>&#160; uint8_t <a class="code" href="classsdr_1_1_a_x25.html#a861bace14bcb17b833a5dce8668d719d">_rxbuffer</a>[512];</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#a2d0222c915def9bf7582365b4ce0efd9"> 47</a></span>&#160; uint8_t *<a class="code" href="classsdr_1_1_a_x25.html#a2d0222c915def9bf7582365b4ce0efd9">_ptr</a>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classsdr_1_1_a_x25.html#a85e68f14dbf26067fa13c96d540d38a5"> 50</a></span>&#160; <a class="code" href="classsdr_1_1_buffer.html">Buffer&lt;uint8_t&gt;</a> <a class="code" href="classsdr_1_1_a_x25.html#a85e68f14dbf26067fa13c96d540d38a5">_buffer</a>;</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;};</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;}</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="preprocessor">#endif // __SDR_AX25_HH__</span></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_ae5221438081b14c4b22662eb6e79b8af"><div class="ttname"><a href="classsdr_1_1_a_x25.html#ae5221438081b14c4b22662eb6e79b8af">sdr::AX25::~AX25</a></div><div class="ttdeci">virtual ~AX25()</div><div class="ttdoc">Destructor. </div><div class="ttdef"><b>Definition:</b> ax25.cc:60</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a65d296d63bbd33fd0ece2f865b12cc3d"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a65d296d63bbd33fd0ece2f865b12cc3d">sdr::AX25::_state</a></div><div class="ttdeci">uint32_t _state</div><div class="ttdoc">The current state. </div><div class="ttdef"><b>Definition:</b> ax25.hh:42</div></div>
<div class="ttc" id="classsdr_1_1_config_html"><div class="ttname"><a href="classsdr_1_1_config.html">sdr::Config</a></div><div class="ttdoc">A collection of configuration information that is send by a source to all connected sinks to properga...</div><div class="ttdef"><b>Definition:</b> node.hh:35</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a2d0222c915def9bf7582365b4ce0efd9"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a2d0222c915def9bf7582365b4ce0efd9">sdr::AX25::_ptr</a></div><div class="ttdeci">uint8_t * _ptr</div><div class="ttdoc">Insert-pointer to the buffer. </div><div class="ttdef"><b>Definition:</b> ax25.hh:47</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_ac84c7af0b37d6c6359f4098b96dc36b0"><div class="ttname"><a href="classsdr_1_1_a_x25.html#ac84c7af0b37d6c6359f4098b96dc36b0">sdr::AX25::_bitstream</a></div><div class="ttdeci">uint32_t _bitstream</div><div class="ttdoc">The last bits. </div><div class="ttdef"><b>Definition:</b> ax25.hh:38</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a861bace14bcb17b833a5dce8668d719d"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a861bace14bcb17b833a5dce8668d719d">sdr::AX25::_rxbuffer</a></div><div class="ttdeci">uint8_t _rxbuffer[512]</div><div class="ttdoc">Message buffer. </div><div class="ttdef"><b>Definition:</b> ax25.hh:45</div></div>
<div class="ttc" id="classsdr_1_1_sink_html"><div class="ttname"><a href="classsdr_1_1_sink.html">sdr::Sink</a></div><div class="ttdoc">Typed sink. </div><div class="ttdef"><b>Definition:</b> node.hh:192</div></div>
<div class="ttc" id="namespacesdr_html"><div class="ttname"><a href="namespacesdr.html">sdr</a></div><div class="ttdef"><b>Definition:</b> afsk.hh:6</div></div>
<div class="ttc" id="classsdr_1_1_source_html"><div class="ttname"><a href="classsdr_1_1_source.html">sdr::Source</a></div><div class="ttdoc">Generic source class. </div><div class="ttdef"><b>Definition:</b> node.hh:213</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_aebbe666ff47df7ea8a868a1ab552d34f"><div class="ttname"><a href="classsdr_1_1_a_x25.html#aebbe666ff47df7ea8a868a1ab552d34f">sdr::AX25::AX25</a></div><div class="ttdeci">AX25()</div><div class="ttdoc">Constructor. </div><div class="ttdef"><b>Definition:</b> ax25.cc:54</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_abadb32804529f36819c675c4c746ff4c"><div class="ttname"><a href="classsdr_1_1_a_x25.html#abadb32804529f36819c675c4c746ff4c">sdr::AX25::process</a></div><div class="ttdeci">virtual void process(const Buffer&lt; uint8_t &gt; &amp;buffer, bool allow_overwrite)</div><div class="ttdoc">Processes the bit stream. </div><div class="ttdef"><b>Definition:</b> ax25.cc:92</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html"><div class="ttname"><a href="classsdr_1_1_a_x25.html">sdr::AX25</a></div><div class="ttdoc">Decodes AX25 (PacketRadio) messages from a bit stream. </div><div class="ttdef"><b>Definition:</b> ax25.hh:21</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a6260b7c8fc548edca0cfc18fb5303b83"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a6260b7c8fc548edca0cfc18fb5303b83">sdr::AX25::_bitbuffer</a></div><div class="ttdeci">uint32_t _bitbuffer</div><div class="ttdoc">A buffer of received bits. </div><div class="ttdef"><b>Definition:</b> ax25.hh:40</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a05c586d156e856b0820aef7669512368"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a05c586d156e856b0820aef7669512368">sdr::AX25::unpackCall</a></div><div class="ttdeci">static void unpackCall(const uint8_t *buffer, std::string &amp;call, int &amp;ssid, bool &amp;addrExt)</div><div class="ttdoc">Unpacks a AX.25 encoded call (address). </div><div class="ttdef"><b>Definition:</b> ax25.cc:163</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a35ae34c6c6337f67adbcb3a6e0c8fac8"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a35ae34c6c6337f67adbcb3a6e0c8fac8">sdr::AX25::config</a></div><div class="ttdeci">virtual void config(const Config &amp;src_cfg)</div><div class="ttdoc">Configures the node. </div><div class="ttdef"><b>Definition:</b> ax25.cc:65</div></div>
<div class="ttc" id="classsdr_1_1_a_x25_html_a85e68f14dbf26067fa13c96d540d38a5"><div class="ttname"><a href="classsdr_1_1_a_x25.html#a85e68f14dbf26067fa13c96d540d38a5">sdr::AX25::_buffer</a></div><div class="ttdeci">Buffer&lt; uint8_t &gt; _buffer</div><div class="ttdoc">Output buffer. </div><div class="ttdef"><b>Definition:</b> ax25.hh:50</div></div>
<div class="ttc" id="classsdr_1_1_buffer_html"><div class="ttname"><a href="classsdr_1_1_buffer.html">sdr::Buffer&lt; uint8_t &gt;</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 1 2015 11:35:00 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>