ESP3D/docs/html/websocket__server_8h.html
2020-01-06 14:46:56 +01:00

220 lines
11 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">
<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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ESP3D: esp3d/src/modules/websocket/websocket_server.h File 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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="ESP3D_social_mini.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">ESP3D
&#160;<span id="projectnumber">3.0</span>
</div>
<div id="projectbrief">Firmware for ESP boards connected to 3D Printer</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('websocket__server_8h.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">websocket_server.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;Print.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for websocket_server.h:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8h__incl.png" border="0" usemap="#esp3d_2src_2modules_2websocket_2websocket__server_8h" alt=""/></div>
<map name="esp3d_2src_2modules_2websocket_2websocket__server_8h" id="esp3d_2src_2modules_2websocket_2websocket__server_8h">
<area shape="rect" title=" " alt="" coords="5,5,204,47"/>
<area shape="rect" title=" " alt="" coords="75,95,135,121"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8h__dep__incl.png" border="0" usemap="#esp3d_2src_2modules_2websocket_2websocket__server_8hdep" alt=""/></div>
<map name="esp3d_2src_2modules_2websocket_2websocket__server_8hdep" id="esp3d_2src_2modules_2websocket_2websocket__server_8hdep">
<area shape="rect" title=" " alt="" coords="491,5,690,47"/>
<area shape="rect" href="esp3doutput_8cpp.html" title=" " alt="" coords="5,102,213,129"/>
<area shape="rect" href="_e_s_p160_8cpp.html" title=" " alt="" coords="238,95,397,136"/>
<area shape="rect" href="_e_s_p420_8cpp.html" title=" " alt="" coords="421,95,579,136"/>
<area shape="rect" href="http__server_8cpp.html" title=" " alt="" coords="603,95,762,136"/>
<area shape="rect" href="netservices_8cpp.html" title=" " alt="" coords="787,95,968,136"/>
<area shape="rect" href="websocket__server_8cpp.html" title=" " alt="" coords="993,95,1191,136"/>
</map>
</div>
</div>
<p><a href="websocket__server_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_web_socket___server.html">WebSocket_Server</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a8c651ff98c42106f3a14ee4225677cc8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8h.html#a8c651ff98c42106f3a14ee4225677cc8">TXBUFFERSIZE</a>&#160;&#160;&#160;1200</td></tr>
<tr class="separator:a8c651ff98c42106f3a14ee4225677cc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a29d12c67e4b6e0ff96d7aa793757b094"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8h.html#a29d12c67e4b6e0ff96d7aa793757b094">RXBUFFERSIZE</a>&#160;&#160;&#160;256</td></tr>
<tr class="separator:a29d12c67e4b6e0ff96d7aa793757b094"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4731ef512b433abe9b4c9e709c214ace"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8h.html#a4731ef512b433abe9b4c9e709c214ace">FLUSHTIMEOUT</a>&#160;&#160;&#160;500</td></tr>
<tr class="separator:a4731ef512b433abe9b4c9e709c214ace"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a29d7b81ffbf494bef178e3f94376fddb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_web_socket___server.html">WebSocket_Server</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8h.html#a29d7b81ffbf494bef178e3f94376fddb">websocket_terminal_server</a></td></tr>
<tr class="separator:a29d7b81ffbf494bef178e3f94376fddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="a4731ef512b433abe9b4c9e709c214ace"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4731ef512b433abe9b4c9e709c214ace">&#9670;&nbsp;</a></span>FLUSHTIMEOUT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUSHTIMEOUT&#160;&#160;&#160;500</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8h_source.html#l00028">28</a> of file <a class="el" href="websocket__server_8h_source.html">websocket_server.h</a>.</p>
</div>
</div>
<a id="a29d12c67e4b6e0ff96d7aa793757b094"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29d12c67e4b6e0ff96d7aa793757b094">&#9670;&nbsp;</a></span>RXBUFFERSIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RXBUFFERSIZE&#160;&#160;&#160;256</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8h_source.html#l00027">27</a> of file <a class="el" href="websocket__server_8h_source.html">websocket_server.h</a>.</p>
</div>
</div>
<a id="a8c651ff98c42106f3a14ee4225677cc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c651ff98c42106f3a14ee4225677cc8">&#9670;&nbsp;</a></span>TXBUFFERSIZE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TXBUFFERSIZE&#160;&#160;&#160;1200</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8h_source.html#l00026">26</a> of file <a class="el" href="websocket__server_8h_source.html">websocket_server.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="a29d7b81ffbf494bef178e3f94376fddb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a29d7b81ffbf494bef178e3f94376fddb">&#9670;&nbsp;</a></span>websocket_terminal_server</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_web_socket___server.html">WebSocket_Server</a> websocket_terminal_server</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8cpp_source.html#l00033">33</a> of file <a class="el" href="websocket__server_8cpp_source.html">websocket_server.cpp</a>.</p>
</div>
</div>
</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="dir_26e324fd2d3b807b96644664d24a0768.html">esp3d</a></li><li class="navelem"><a class="el" href="dir_8d0579f238dc492a9f9393e76adf8153.html">src</a></li><li class="navelem"><a class="el" href="dir_2c1830491e0576ae3395f8c2f91c7d85.html">modules</a></li><li class="navelem"><a class="el" href="dir_3bf4f05cbe0623f623c0273016c80f8a.html">websocket</a></li><li class="navelem"><a class="el" href="websocket__server_8h.html">websocket_server.h</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>