1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
arduinolibs/TelnetDefs_8h_source.html
Rhys Weatherley 9d2e774894 Update docs
2016-08-27 14:32:42 +10:00

214 lines
19 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.6"/>
<title>ArduinoLibs: TelnetDefs.h 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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">ArduinoLibs
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></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_bc0718b08fb2015b8e59c47b2805f60c.html">libraries</a></li><li class="navelem"><a class="el" href="dir_1de32c476debcefedf4aa8bb43bea551.html">Shell</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">TelnetDefs.h</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="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2016 Southern Storm Software, Pty Ltd.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * copy of this software and associated documentation files (the &quot;Software&quot;),</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * to deal in the Software without restriction, including without limitation</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * in all copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> * DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment"> */</span></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="preprocessor">#ifndef TELNET_DEFS_h</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define TELNET_DEFS_h</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment">// References:</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment">// https://tools.ietf.org/html/rfc854</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="comment">// http://www.iana.org/assignments/telnet-options/telnet-options.xhtml</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">namespace </span>TelnetDefs</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</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">enum</span> Command</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; EndOfFile = 236, </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; Suspend = 237, </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; Abort = 238, </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; EndOfRecord = 239, </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; SubEnd = 240, </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; NOP = 241, </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; DataMark = 242, </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; Break = 243, </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; Interrupt = 244, </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; AbortOutput = 245, </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; AreYouThere = 246, </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; EraseChar = 247, </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; EraseLine = 248, </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; GoAhead = 249, </div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; SubStart = 250, </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; WILL = 251, </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; WONT = 252, </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; DO = 253, </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; DONT = 254, </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; IAC = 255 </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;};</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;<span class="keyword">enum</span> Option</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;{</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; Binary = 0, </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; Echo = 1, </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; Reconnection = 2, </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; SuppressGoAhead = 3, </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; ApproxMsgSize = 4, </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; Status = 5, </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; TimingMark = 6, </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; RemoteTransmitEcho = 7, </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; LineWidth = 8, </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; PageSize = 9, </div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; CarriageReturn = 10, </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; HorzTabStops = 11, </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; HorzTabStopDisp = 12, </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; FormFeed = 13, </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; VertTabStops = 14, </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; VertTabStopDisp = 15, </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; LineFeed = 16, </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; ExtendedASCII = 17, </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; Logout = 18, </div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; ByteMacro = 19, </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; DataEntryTerminal = 20, </div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; SUPDUP = 21, </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; SUPDUPOutput = 22, </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; SendLocation = 23, </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; TerminalType = 24, </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; EndOfRecordOption = 25, </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; TACACSUserId = 26, </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; OutputMarking = 27, </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; TerminalLocation = 28, </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; Telnet3270Regime = 29, </div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; X3Pad = 30, </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; WindowSize = 31, </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; Speed = 32, </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; RemoteFlowControl = 33, </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; Linemode = 34, </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; XDisplay = 35, </div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; EnvironmentOld = 36, </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; Authentication = 37, </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; Encryption = 38, </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; Environment = 39, </div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; TN3270E = 40, </div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; XAUTH = 41, </div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; Charset = 42, </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; RemoteSerialPort = 43, </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; ComPortControl = 44, </div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; SuppressLocalEcho = 45, </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; StartTLS = 46, </div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; Kermit = 47, </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; SendURL = 48, </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; ForwardX = 49, </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; Extended = 255 </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160;};</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;};</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160;</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Aug 27 2016 14:32:20 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>