GitHub-Proxy/ESP3D
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/luc-github/ESP3D.git synced 2025-04-21 05:09:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
ESP3D/docs/html/websocket__server_8cpp.html
Luc 312f88e6e2 Test for dioxygen doc generation
2020-01-06 14:46:56 +01:00

341 lines
20 KiB
HTML
Raw Permalink Blame History

<!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.cpp 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_8cpp.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="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">websocket_server.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="esp3d__config_8h_source.html">../../include/esp3d_config.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="websocket__server_8h_source.html">websocket_server.h</a>&quot;</code><br />
<code>#include &lt;WebSocketsServer.h&gt;</code><br />
<code>#include &quot;<a class="el" href="settings__esp3d_8h_source.html">../../core/settings_esp3d.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="esp3doutput_8h_source.html">../../core/esp3doutput.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="commands_8h_source.html">../../core/commands.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for websocket_server.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8cpp__incl.png" border="0" usemap="#esp3d_2src_2modules_2websocket_2websocket__server_8cpp" alt=""/></div>
<map name="esp3d_2src_2modules_2websocket_2websocket__server_8cpp" id="esp3d_2src_2modules_2websocket_2websocket__server_8cpp">
<area shape="rect" title=" " alt="" coords="400,5,599,47"/>
<area shape="rect" href="esp3d__config_8h.html" title=" " alt="" coords="524,259,651,300"/>
<area shape="rect" href="websocket__server_8h.html" title=" " alt="" coords="181,95,317,121"/>
<area shape="rect" title=" " alt="" coords="341,95,485,121"/>
<area shape="rect" href="settings__esp3d_8h.html" title=" " alt="" coords="1024,259,1145,300"/>
<area shape="rect" href="esp3doutput_8h.html" title=" " alt="" coords="509,95,666,121"/>
<area shape="rect" href="commands_8h.html" title=" " alt="" coords="5,95,156,121"/>
<area shape="rect" title=" " alt="" coords="547,423,625,449"/>
<area shape="rect" href="defines_8h.html" title=" " alt="" coords="913,348,1043,375"/>
<area shape="rect" href="pins_8h.html" title=" " alt="" coords="98,348,213,375"/>
<area shape="rect" href="configuration_8h.html" title=" " alt="" coords="237,348,367,375"/>
<area shape="rect" href="sanity__esp3d_8h.html" title=" " alt="" coords="392,348,559,375"/>
<area shape="rect" href="hal_8h.html" title=" " alt="" coords="1067,348,1158,375"/>
<area shape="rect" href="debug__esp3d_8h.html" title=" " alt="" coords="583,348,733,375"/>
<area shape="rect" href="version_8h.html" title=" " alt="" coords="758,348,889,375"/>
<area shape="rect" title=" " alt="" coords="427,177,487,203"/>
<area shape="rect" href="authentication__service_8h.html" title=" " alt="" coords="110,169,278,211"/>
</map>
</div>
</div>
<p><a href="websocket__server_8cpp_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="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aa61b16b920381ad35d41e7b217ec3322"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8cpp.html#aa61b16b920381ad35d41e7b217ec3322">handle_Websocket_Server_Event</a> (uint8_t num, uint8_t type, uint8_t *payload, size_t length)</td></tr>
<tr class="separator:aa61b16b920381ad35d41e7b217ec3322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5e5953051702a5f60356fc9e9c2a9bac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="websocket__server_8cpp.html#a5e5953051702a5f60356fc9e9c2a9bac">handle_Websocket_Terminal_Event</a> (uint8_t num, uint8_t type, uint8_t *payload, size_t length)</td></tr>
<tr class="separator:a5e5953051702a5f60356fc9e9c2a9bac"><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_8cpp.html#a29d7b81ffbf494bef178e3f94376fddb">websocket_terminal_server</a></td></tr>
<tr class="separator:a29d7b81ffbf494bef178e3f94376fddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd9f167d8093fe6848435a1845d88797"><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_8cpp.html#afd9f167d8093fe6848435a1845d88797">websocket_data_server</a></td></tr>
<tr class="separator:afd9f167d8093fe6848435a1845d88797"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="aa61b16b920381ad35d41e7b217ec3322"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa61b16b920381ad35d41e7b217ec3322">&#9670;&nbsp;</a></span>handle_Websocket_Server_Event()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void handle_Websocket_Server_Event </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>payload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8cpp_source.html#l00057">57</a> of file <a class="el" href="websocket__server_8cpp_source.html">websocket_server.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_cgraph.png" border="0" usemap="#websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_cgraph" alt=""/></div>
<map name="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_cgraph" id="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_cgraph">
<area shape="rect" title=" " alt="" coords="5,23,181,65"/>
<area shape="rect" href="class_web_socket___server.html#a26bb64221d687dbba4876e764df35814" title=" " alt="" coords="259,5,422,32"/>
<area shape="rect" href="class_web_socket___server.html#ae8a75478d845aeefb2daf628fd81c6a4" title=" " alt="" coords="229,56,452,83"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_icgraph.png" border="0" usemap="#websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_icgraph" alt=""/></div>
<map name="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_icgraph" id="websocket__server_8cpp_aa61b16b920381ad35d41e7b217ec3322_icgraph">
<area shape="rect" title=" " alt="" coords="2020,116,2196,157"/>
<area shape="rect" href="class_web_socket___server.html#aff7a7bab8f34d6e925f6168522e1d19b" title=" " alt="" coords="1800,123,1972,150"/>
<area shape="rect" href="class_net_services.html#a22e0d6e1a67c2f32074978eb05c38cff" title=" " alt="" coords="1621,123,1752,150"/>
<area shape="rect" href="class_net_config.html#a74ee795ace62d7ebac495e158f3adac1" title=" " alt="" coords="1446,98,1563,124"/>
<area shape="rect" href="class_net_services.html#a4d4bcc19494af6b5c6e7471638098c88" title=" " alt="" coords="1436,148,1573,175"/>
<area shape="rect" href="class_esp3_d.html#afb33f64a43ad00448d494e66e970339a" title=" " alt="" coords="5,47,105,74"/>
<area shape="rect" href="class_commands.html#a40b3fb1daf8996ec50ceadefb8c0e915" title=" " alt="" coords="1244,47,1388,74"/>
<area shape="rect" href="class_commands.html#ac7765cf4da97460c7e96253306306056" title=" " alt="" coords="1244,98,1388,124"/>
<area shape="rect" href="class_net_config.html#a324adac016e2d7adea545cc919d8d408" title=" " alt="" coords="1254,148,1378,175"/>
<area shape="rect" href="class_commands.html#ae3516c283e84729667119c390d697eb7" title=" " alt="" coords="1005,65,1196,106"/>
<area shape="rect" href="class_commands.html#ad1efcbcb621f598f3cd4ab4ebfb2f173" title=" " alt="" coords="815,98,957,124"/>
<area shape="rect" href="class_gcode_host.html#ae3c261bf836a76d3441724eae30555b5" title=" " alt="" coords="588,98,767,124"/>
<area shape="rect" href="class_gcode_host.html#af17ebce982e939ebc8205ea587b88bee" title=" " alt="" coords="375,148,540,175"/>
<area shape="rect" href="class_gcode_host.html#a1c624777512a678e5d5b662fc6c28f02" title=" " alt="" coords="376,98,539,124"/>
<area shape="rect" href="class_commands.html#a16350ec121b0ec859f6458d045a5a60d" title=" " alt="" coords="168,47,312,74"/>
<area shape="rect" href="class_gcode_host.html#ade23e0a1b4602dfdab7080505b26ff42" title=" " alt="" coords="153,98,327,124"/>
<area shape="rect" href="class_esp3_d.html#acfb8aca15f861a61952b484f807cc9af" title=" " alt="" coords="1047,148,1154,175"/>
</map>
</div>
</div>
</div>
<a id="a5e5953051702a5f60356fc9e9c2a9bac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e5953051702a5f60356fc9e9c2a9bac">&#9670;&nbsp;</a></span>handle_Websocket_Terminal_Event()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void handle_Websocket_Terminal_Event </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>num</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t *&#160;</td>
<td class="paramname"><em>payload</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8cpp_source.html#l00084">84</a> of file <a class="el" href="websocket__server_8cpp_source.html">websocket_server.cpp</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_cgraph.png" border="0" usemap="#websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_cgraph" alt=""/></div>
<map name="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_cgraph" id="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_cgraph">
<area shape="rect" title=" " alt="" coords="5,49,195,90"/>
<area shape="rect" href="class_web_socket___server.html#a26bb64221d687dbba4876e764df35814" title=" " alt="" coords="261,5,423,32"/>
<area shape="rect" href="class_web_socket___server.html#aef7cb1f2c64329229a34c6fdc205e31d" title=" " alt="" coords="243,56,441,83"/>
<area shape="rect" href="class_web_socket___server.html#a9476a3dc4406dbec16f27565d1be5963" title=" " alt="" coords="263,107,421,149"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_icgraph.png" border="0" usemap="#websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_icgraph" alt=""/></div>
<map name="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_icgraph" id="websocket__server_8cpp_a5e5953051702a5f60356fc9e9c2a9bac_icgraph">
<area shape="rect" title=" " alt="" coords="2020,116,2209,157"/>
<area shape="rect" href="class_web_socket___server.html#aff7a7bab8f34d6e925f6168522e1d19b" title=" " alt="" coords="1800,123,1972,150"/>
<area shape="rect" href="class_net_services.html#a22e0d6e1a67c2f32074978eb05c38cff" title=" " alt="" coords="1621,123,1752,150"/>
<area shape="rect" href="class_net_config.html#a74ee795ace62d7ebac495e158f3adac1" title=" " alt="" coords="1446,98,1563,124"/>
<area shape="rect" href="class_net_services.html#a4d4bcc19494af6b5c6e7471638098c88" title=" " alt="" coords="1436,148,1573,175"/>
<area shape="rect" href="class_esp3_d.html#afb33f64a43ad00448d494e66e970339a" title=" " alt="" coords="5,47,105,74"/>
<area shape="rect" href="class_commands.html#a40b3fb1daf8996ec50ceadefb8c0e915" title=" " alt="" coords="1244,47,1388,74"/>
<area shape="rect" href="class_commands.html#ac7765cf4da97460c7e96253306306056" title=" " alt="" coords="1244,98,1388,124"/>
<area shape="rect" href="class_net_config.html#a324adac016e2d7adea545cc919d8d408" title=" " alt="" coords="1254,148,1378,175"/>
<area shape="rect" href="class_commands.html#ae3516c283e84729667119c390d697eb7" title=" " alt="" coords="1005,65,1196,106"/>
<area shape="rect" href="class_commands.html#ad1efcbcb621f598f3cd4ab4ebfb2f173" title=" " alt="" coords="815,98,957,124"/>
<area shape="rect" href="class_gcode_host.html#ae3c261bf836a76d3441724eae30555b5" title=" " alt="" coords="588,98,767,124"/>
<area shape="rect" href="class_gcode_host.html#af17ebce982e939ebc8205ea587b88bee" title=" " alt="" coords="375,148,540,175"/>
<area shape="rect" href="class_gcode_host.html#a1c624777512a678e5d5b662fc6c28f02" title=" " alt="" coords="376,98,539,124"/>
<area shape="rect" href="class_commands.html#a16350ec121b0ec859f6458d045a5a60d" title=" " alt="" coords="168,47,312,74"/>
<area shape="rect" href="class_gcode_host.html#ade23e0a1b4602dfdab7080505b26ff42" title=" " alt="" coords="153,98,327,124"/>
<area shape="rect" href="class_esp3_d.html#acfb8aca15f861a61952b484f807cc9af" title=" " alt="" coords="1047,148,1154,175"/>
</map>
</div>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="afd9f167d8093fe6848435a1845d88797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd9f167d8093fe6848435a1845d88797">&#9670;&nbsp;</a></span>websocket_data_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_data_server</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="websocket__server_8cpp_source.html#l00035">35</a> of file <a class="el" href="websocket__server_8cpp_source.html">websocket_server.cpp</a>.</p>
</div>
</div>
<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_8cpp.html">websocket_server.cpp</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>
Reference in New Issue View Git Blame Copy Permalink