568 lines
33 KiB
HTML
568 lines
33 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: AX25Frame 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="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.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>
|
|
<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 id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_a_x25_frame.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_a_x25_frame-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">AX25Frame Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Abstraction of AX.25 frame format.
|
|
<a href="class_a_x25_frame.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_a_x25_8h_source.html">AX25.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a138d97d90a371bef7ebd86cce1cc4979" id="r_a138d97d90a371bef7ebd86cce1cc4979"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a138d97d90a371bef7ebd86cce1cc4979">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a7fe9805148e2dd46d163cd989473dbff">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#a38f7fb6a4a6344b5892c3a3cdf26c585">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>)</td></tr>
|
|
<tr class="memdesc:a138d97d90a371bef7ebd86cce1cc4979"><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor, for frames without info field. <br /></td></tr>
|
|
<tr class="separator:a138d97d90a371bef7ebd86cce1cc4979"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a60e1b318d6e4b9299a4eab72e40877fc" id="r_a60e1b318d6e4b9299a4eab72e40877fc"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a60e1b318d6e4b9299a4eab72e40877fc">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a7fe9805148e2dd46d163cd989473dbff">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#a38f7fb6a4a6344b5892c3a3cdf26c585">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>, uint8_t <a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a>, const char *<a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a>)</td></tr>
|
|
<tr class="memdesc:a60e1b318d6e4b9299a4eab72e40877fc"><td class="mdescLeft"> </td><td class="mdescRight">Overloaded constructor, for frames with C-string info field. <br /></td></tr>
|
|
<tr class="separator:a60e1b318d6e4b9299a4eab72e40877fc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a713292937322e4be63e793092e17b680" id="r_a713292937322e4be63e793092e17b680"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a713292937322e4be63e793092e17b680">AX25Frame</a> (const char *<a class="el" href="class_a_x25_frame.html#a7fe9805148e2dd46d163cd989473dbff">destCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#af62935e56dc24bca5d2e2aeb932b63f8">destSSID</a>, const char *<a class="el" href="class_a_x25_frame.html#a38f7fb6a4a6344b5892c3a3cdf26c585">srcCallsign</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a50c63276facf8126f0f8555b1fc6b2c9">srcSSID</a>, uint8_t <a class="el" href="class_a_x25_frame.html#a5b196079b539dc417ca65dd4ad622f8f">control</a>, uint8_t <a class="el" href="class_a_x25_frame.html#aa8895fea37220c82f68bd320331595c8">protocolID</a>, const uint8_t *<a class="el" href="class_a_x25_frame.html#aa82f006b84b71b9c5d036a4946a65988">info</a>, uint16_t <a class="el" href="class_a_x25_frame.html#a75e8ad33c2540ede5bb130050f6ffc41">infoLen</a>)</td></tr>
|
|
<tr class="memdesc:a713292937322e4be63e793092e17b680"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a713292937322e4be63e793092e17b680"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25b83cc9c281d2758165833fe238fe0e" id="r_a25b83cc9c281d2758165833fe238fe0e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a25b83cc9c281d2758165833fe238fe0e">AX25Frame</a> (const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> &frame)</td></tr>
|
|
<tr class="memdesc:a25b83cc9c281d2758165833fe238fe0e"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
|
|
<tr class="separator:a25b83cc9c281d2758165833fe238fe0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab84a13f720ada37aee6201a560d9dc5a" id="r_ab84a13f720ada37aee6201a560d9dc5a"><td class="memItemLeft" align="right" valign="top"><a id="ab84a13f720ada37aee6201a560d9dc5a" name="ab84a13f720ada37aee6201a560d9dc5a"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>~AX25Frame</b> ()</td></tr>
|
|
<tr class="memdesc:ab84a13f720ada37aee6201a560d9dc5a"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:ab84a13f720ada37aee6201a560d9dc5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52e7e5f6f48c3e62544721d2a5e00640" id="r_a52e7e5f6f48c3e62544721d2a5e00640"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a52e7e5f6f48c3e62544721d2a5e00640">operator=</a> (const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> &frame)</td></tr>
|
|
<tr class="memdesc:a52e7e5f6f48c3e62544721d2a5e00640"><td class="mdescLeft"> </td><td class="mdescRight">Overload for assignment operator. <br /></td></tr>
|
|
<tr class="separator:a52e7e5f6f48c3e62544721d2a5e00640"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac9a4e40266e81bd2245ebb361a03ddd9" id="r_ac9a4e40266e81bd2245ebb361a03ddd9"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#ac9a4e40266e81bd2245ebb361a03ddd9">setRepeaters</a> (char **<a class="el" href="class_a_x25_frame.html#a29eb08c9e72bbaced8d37dcb2343ee94">repeaterCallsigns</a>, const uint8_t *<a class="el" href="class_a_x25_frame.html#a5b63c6b6f69e0ac47ba9230ad39c6830">repeaterSSIDs</a>, uint8_t <a class="el" href="class_a_x25_frame.html#ad27453a838ba90f917a1a9853358bb9a">numRepeaters</a>)</td></tr>
|
|
<tr class="memdesc:ac9a4e40266e81bd2245ebb361a03ddd9"><td class="mdescLeft"> </td><td class="mdescRight">Method to set the repeater callsigns and SSIDs. <br /></td></tr>
|
|
<tr class="separator:ac9a4e40266e81bd2245ebb361a03ddd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4696a8eede8bac85f0ee6de6fee79ea8" id="r_a4696a8eede8bac85f0ee6de6fee79ea8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a4696a8eede8bac85f0ee6de6fee79ea8">setRecvSequence</a> (uint8_t seqNumber)</td></tr>
|
|
<tr class="memdesc:a4696a8eede8bac85f0ee6de6fee79ea8"><td class="mdescLeft"> </td><td class="mdescRight">Method to set receive sequence number. <br /></td></tr>
|
|
<tr class="separator:a4696a8eede8bac85f0ee6de6fee79ea8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a026e9b96fa69018590fcf6842df8be70" id="r_a026e9b96fa69018590fcf6842df8be70"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_a_x25_frame.html#a026e9b96fa69018590fcf6842df8be70">setSendSequence</a> (uint8_t seqNumber)</td></tr>
|
|
<tr class="memdesc:a026e9b96fa69018590fcf6842df8be70"><td class="mdescLeft"> </td><td class="mdescRight">Method to set send sequence number. <br /></td></tr>
|
|
<tr class="separator:a026e9b96fa69018590fcf6842df8be70"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a7fe9805148e2dd46d163cd989473dbff" id="r_a7fe9805148e2dd46d163cd989473dbff"><td class="memItemLeft" align="right" valign="top"><a id="a7fe9805148e2dd46d163cd989473dbff" name="a7fe9805148e2dd46d163cd989473dbff"></a>
|
|
char </td><td class="memItemRight" valign="bottom"><b>destCallsign</b> [RADIOLIB_AX25_MAX_CALLSIGN_LEN+1]</td></tr>
|
|
<tr class="memdesc:a7fe9805148e2dd46d163cd989473dbff"><td class="mdescLeft"> </td><td class="mdescRight">Callsign of the destination station. <br /></td></tr>
|
|
<tr class="separator:a7fe9805148e2dd46d163cd989473dbff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af62935e56dc24bca5d2e2aeb932b63f8" id="r_af62935e56dc24bca5d2e2aeb932b63f8"><td class="memItemLeft" align="right" valign="top"><a id="af62935e56dc24bca5d2e2aeb932b63f8" name="af62935e56dc24bca5d2e2aeb932b63f8"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>destSSID</b></td></tr>
|
|
<tr class="memdesc:af62935e56dc24bca5d2e2aeb932b63f8"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the destination station. <br /></td></tr>
|
|
<tr class="separator:af62935e56dc24bca5d2e2aeb932b63f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38f7fb6a4a6344b5892c3a3cdf26c585" id="r_a38f7fb6a4a6344b5892c3a3cdf26c585"><td class="memItemLeft" align="right" valign="top"><a id="a38f7fb6a4a6344b5892c3a3cdf26c585" name="a38f7fb6a4a6344b5892c3a3cdf26c585"></a>
|
|
char </td><td class="memItemRight" valign="bottom"><b>srcCallsign</b> [RADIOLIB_AX25_MAX_CALLSIGN_LEN+1]</td></tr>
|
|
<tr class="memdesc:a38f7fb6a4a6344b5892c3a3cdf26c585"><td class="mdescLeft"> </td><td class="mdescRight">Callsign of the source station. <br /></td></tr>
|
|
<tr class="separator:a38f7fb6a4a6344b5892c3a3cdf26c585"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50c63276facf8126f0f8555b1fc6b2c9" id="r_a50c63276facf8126f0f8555b1fc6b2c9"><td class="memItemLeft" align="right" valign="top"><a id="a50c63276facf8126f0f8555b1fc6b2c9" name="a50c63276facf8126f0f8555b1fc6b2c9"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>srcSSID</b></td></tr>
|
|
<tr class="memdesc:a50c63276facf8126f0f8555b1fc6b2c9"><td class="mdescLeft"> </td><td class="mdescRight">SSID of the source station. <br /></td></tr>
|
|
<tr class="separator:a50c63276facf8126f0f8555b1fc6b2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad27453a838ba90f917a1a9853358bb9a" id="r_ad27453a838ba90f917a1a9853358bb9a"><td class="memItemLeft" align="right" valign="top"><a id="ad27453a838ba90f917a1a9853358bb9a" name="ad27453a838ba90f917a1a9853358bb9a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>numRepeaters</b></td></tr>
|
|
<tr class="memdesc:ad27453a838ba90f917a1a9853358bb9a"><td class="mdescLeft"> </td><td class="mdescRight">Number of repeaters to be used. <br /></td></tr>
|
|
<tr class="separator:ad27453a838ba90f917a1a9853358bb9a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b196079b539dc417ca65dd4ad622f8f" id="r_a5b196079b539dc417ca65dd4ad622f8f"><td class="memItemLeft" align="right" valign="top"><a id="a5b196079b539dc417ca65dd4ad622f8f" name="a5b196079b539dc417ca65dd4ad622f8f"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>control</b></td></tr>
|
|
<tr class="memdesc:a5b196079b539dc417ca65dd4ad622f8f"><td class="mdescLeft"> </td><td class="mdescRight">The control field. <br /></td></tr>
|
|
<tr class="separator:a5b196079b539dc417ca65dd4ad622f8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa8895fea37220c82f68bd320331595c8" id="r_aa8895fea37220c82f68bd320331595c8"><td class="memItemLeft" align="right" valign="top"><a id="aa8895fea37220c82f68bd320331595c8" name="aa8895fea37220c82f68bd320331595c8"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>protocolID</b></td></tr>
|
|
<tr class="memdesc:aa8895fea37220c82f68bd320331595c8"><td class="mdescLeft"> </td><td class="mdescRight">The protocol identifier (PID) field. <br /></td></tr>
|
|
<tr class="separator:aa8895fea37220c82f68bd320331595c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a75e8ad33c2540ede5bb130050f6ffc41" id="r_a75e8ad33c2540ede5bb130050f6ffc41"><td class="memItemLeft" align="right" valign="top"><a id="a75e8ad33c2540ede5bb130050f6ffc41" name="a75e8ad33c2540ede5bb130050f6ffc41"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><b>infoLen</b></td></tr>
|
|
<tr class="memdesc:a75e8ad33c2540ede5bb130050f6ffc41"><td class="mdescLeft"> </td><td class="mdescRight">Number of bytes in the information field. <br /></td></tr>
|
|
<tr class="separator:a75e8ad33c2540ede5bb130050f6ffc41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adce5294af25f09df752997d33ac0e87f" id="r_adce5294af25f09df752997d33ac0e87f"><td class="memItemLeft" align="right" valign="top"><a id="adce5294af25f09df752997d33ac0e87f" name="adce5294af25f09df752997d33ac0e87f"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>rcvSeqNumber</b></td></tr>
|
|
<tr class="memdesc:adce5294af25f09df752997d33ac0e87f"><td class="mdescLeft"> </td><td class="mdescRight">Receive sequence number. <br /></td></tr>
|
|
<tr class="separator:adce5294af25f09df752997d33ac0e87f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4c0fdf148d3b779d48441d45af87add2" id="r_a4c0fdf148d3b779d48441d45af87add2"><td class="memItemLeft" align="right" valign="top"><a id="a4c0fdf148d3b779d48441d45af87add2" name="a4c0fdf148d3b779d48441d45af87add2"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><b>sendSeqNumber</b></td></tr>
|
|
<tr class="memdesc:a4c0fdf148d3b779d48441d45af87add2"><td class="mdescLeft"> </td><td class="mdescRight">Send sequence number. <br /></td></tr>
|
|
<tr class="separator:a4c0fdf148d3b779d48441d45af87add2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa82f006b84b71b9c5d036a4946a65988" id="r_aa82f006b84b71b9c5d036a4946a65988"><td class="memItemLeft" align="right" valign="top"><a id="aa82f006b84b71b9c5d036a4946a65988" name="aa82f006b84b71b9c5d036a4946a65988"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><b>info</b></td></tr>
|
|
<tr class="memdesc:aa82f006b84b71b9c5d036a4946a65988"><td class="mdescLeft"> </td><td class="mdescRight">The info field. <br /></td></tr>
|
|
<tr class="separator:aa82f006b84b71b9c5d036a4946a65988"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a29eb08c9e72bbaced8d37dcb2343ee94" id="r_a29eb08c9e72bbaced8d37dcb2343ee94"><td class="memItemLeft" align="right" valign="top"><a id="a29eb08c9e72bbaced8d37dcb2343ee94" name="a29eb08c9e72bbaced8d37dcb2343ee94"></a>
|
|
char ** </td><td class="memItemRight" valign="bottom"><b>repeaterCallsigns</b></td></tr>
|
|
<tr class="memdesc:a29eb08c9e72bbaced8d37dcb2343ee94"><td class="mdescLeft"> </td><td class="mdescRight">Array of repeater callsigns. <br /></td></tr>
|
|
<tr class="separator:a29eb08c9e72bbaced8d37dcb2343ee94"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b63c6b6f69e0ac47ba9230ad39c6830" id="r_a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="memItemLeft" align="right" valign="top"><a id="a5b63c6b6f69e0ac47ba9230ad39c6830" name="a5b63c6b6f69e0ac47ba9230ad39c6830"></a>
|
|
uint8_t * </td><td class="memItemRight" valign="bottom"><b>repeaterSSIDs</b></td></tr>
|
|
<tr class="memdesc:a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="mdescLeft"> </td><td class="mdescRight">Array of repeater SSIDs. <br /></td></tr>
|
|
<tr class="separator:a5b63c6b6f69e0ac47ba9230ad39c6830"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Abstraction of AX.25 frame format. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a138d97d90a371bef7ebd86cce1cc4979" name="a138d97d90a371bef7ebd86cce1cc4979"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a138d97d90a371bef7ebd86cce1cc4979">◆ </a></span>AX25Frame() <span class="overload">[1/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AX25Frame::AX25Frame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>destCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>destSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>srcCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>srcSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>control</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overloaded constructor, for frames without info field. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station. </td></tr>
|
|
<tr><td class="paramname">destSSID</td><td>SSID of the destination station. </td></tr>
|
|
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station. </td></tr>
|
|
<tr><td class="paramname">srcSSID</td><td>SSID of the source station. </td></tr>
|
|
<tr><td class="paramname">control</td><td>The control field. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a60e1b318d6e4b9299a4eab72e40877fc" name="a60e1b318d6e4b9299a4eab72e40877fc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a60e1b318d6e4b9299a4eab72e40877fc">◆ </a></span>AX25Frame() <span class="overload">[2/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AX25Frame::AX25Frame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>destCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>destSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>srcCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>srcSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>control</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>protocolID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>info</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overloaded constructor, for frames with C-string info field. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station. </td></tr>
|
|
<tr><td class="paramname">destSSID</td><td>SSID of the destination station. </td></tr>
|
|
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station. </td></tr>
|
|
<tr><td class="paramname">srcSSID</td><td>SSID of the source station. </td></tr>
|
|
<tr><td class="paramname">control</td><td>The control field. </td></tr>
|
|
<tr><td class="paramname">protocolID</td><td>The protocol identifier (PID) field. Set to zero if the frame doesn't have this field. </td></tr>
|
|
<tr><td class="paramname">info</td><td>Information field, in the form of null-terminated C-string. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a713292937322e4be63e793092e17b680" name="a713292937322e4be63e793092e17b680"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a713292937322e4be63e793092e17b680">◆ </a></span>AX25Frame() <span class="overload">[3/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AX25Frame::AX25Frame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>destCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>destSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>srcCallsign</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>srcSSID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>control</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>protocolID</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>info</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint16_t </td>
|
|
<td class="paramname"><em>infoLen</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">destCallsign</td><td>Callsign of the destination station. </td></tr>
|
|
<tr><td class="paramname">destSSID</td><td>SSID of the destination station. </td></tr>
|
|
<tr><td class="paramname">srcCallsign</td><td>Callsign of the source station. </td></tr>
|
|
<tr><td class="paramname">srcSSID</td><td>SSID of the source station. </td></tr>
|
|
<tr><td class="paramname">control</td><td>The control field. </td></tr>
|
|
<tr><td class="paramname">protocolID</td><td>The protocol identifier (PID) field. Set to zero if the frame doesn't have this field. </td></tr>
|
|
<tr><td class="paramname">info</td><td>Information field, in the form of arbitrary binary buffer. </td></tr>
|
|
<tr><td class="paramname">infoLen</td><td>Number of bytes in the information field. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a25b83cc9c281d2758165833fe238fe0e" name="a25b83cc9c281d2758165833fe238fe0e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a25b83cc9c281d2758165833fe238fe0e">◆ </a></span>AX25Frame() <span class="overload">[4/4]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">AX25Frame::AX25Frame </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td>
|
|
<td class="paramname"><em>frame</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Copy constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame</td><td><a class="el" href="class_a_x25_frame.html" title="Abstraction of AX.25 frame format.">AX25Frame</a> instance to copy. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a52e7e5f6f48c3e62544721d2a5e00640" name="a52e7e5f6f48c3e62544721d2a5e00640"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a52e7e5f6f48c3e62544721d2a5e00640">◆ </a></span>operator=()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="class_a_x25_frame.html">AX25Frame</a> & AX25Frame::operator= </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="class_a_x25_frame.html">AX25Frame</a> & </td>
|
|
<td class="paramname"><em>frame</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Overload for assignment operator. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">frame</td><td>rvalue <a class="el" href="class_a_x25_frame.html" title="Abstraction of AX.25 frame format.">AX25Frame</a>. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4696a8eede8bac85f0ee6de6fee79ea8" name="a4696a8eede8bac85f0ee6de6fee79ea8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4696a8eede8bac85f0ee6de6fee79ea8">◆ </a></span>setRecvSequence()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void AX25Frame::setRecvSequence </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>seqNumber</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to set receive sequence number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">seqNumber</td><td>Sequence number to set, 0 to 7. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9a4e40266e81bd2245ebb361a03ddd9" name="ac9a4e40266e81bd2245ebb361a03ddd9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9a4e40266e81bd2245ebb361a03ddd9">◆ </a></span>setRepeaters()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t AX25Frame::setRepeaters </td>
|
|
<td>(</td>
|
|
<td class="paramtype">char ** </td>
|
|
<td class="paramname"><em>repeaterCallsigns</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>repeaterSSIDs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>numRepeaters</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to set the repeater callsigns and SSIDs. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">repeaterCallsigns</td><td>Array of repeater callsigns in the form of null-terminated C-strings. </td></tr>
|
|
<tr><td class="paramname">repeaterSSIDs</td><td>Array of repeater SSIDs. </td></tr>
|
|
<tr><td class="paramname">numRepeaters</td><td>Number of repeaters, maximum is 8. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a026e9b96fa69018590fcf6842df8be70" name="a026e9b96fa69018590fcf6842df8be70"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a026e9b96fa69018590fcf6842df8be70">◆ </a></span>setSendSequence()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void AX25Frame::setSendSequence </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>seqNumber</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Method to set send sequence number. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">seqNumber</td><td>Sequence number to set, 0 to 7. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/protocols/AX25/<a class="el" href="_a_x25_8h_source.html">AX25.h</a></li>
|
|
<li>src/protocols/AX25/<b>AX25.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_a_x25_frame.html">AX25Frame</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|