amacocian/MTSC
1
0
Fork 0
mirror of https://github.com/AlexMacocian/MTSC.git synced 2026-07-15 14:59:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
4f3428f96e5a170274df9613fcbcc664afb79322
MTSC/docs/d2/d29/_echo_module_8cs_source.html
T
amacocian 4f3428f96e Updated documentation
2019-10-20 14:52:16 +02:00

124 lines
20 KiB
HTML
Raw 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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTSC: D:/Projects/MTSC/MTSC/Common/WebSockets/ServerModules/EchoModule.cs 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="../../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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</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="../../MTSC_Logo_small.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MTSC
&#160;<span id="projectnumber">1.0.5</span>
</div>
<div id="projectbrief">Build TCP servers out of modules with handlers for communication, exception and logging.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<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('d2/d29/_echo_module_8cs_source.html','../../');});
/* @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="headertitle">
<div class="title">EchoModule.cs</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="keyword">using</span> System;</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="keyword">using</span> System.Collections.Generic;</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="keyword">using</span> System.Linq;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="keyword">using</span> System.Text;</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="keyword">using</span> <a class="code" href="../../d7/dcd/namespace_m_t_s_c.html">MTSC</a>.<a class="code" href="../../d3/d97/namespace_m_t_s_c_1_1_server.html">Server</a>;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">using</span> <a class="code" href="../../d7/dcd/namespace_m_t_s_c.html">MTSC</a>.<a class="code" href="../../d3/d97/namespace_m_t_s_c_1_1_server.html">Server</a>.<a class="code" href="../../d4/d86/namespace_m_t_s_c_1_1_server_1_1_handlers.html">Handlers</a>;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d2/d2f/namespace_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules.html">MTSC.Common.WebSockets.ServerModules</a></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;{</div><div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="../../d4/d10/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_echo_module.html"> 10</a></span>&#160; <span class="keyword">public</span> <span class="keyword">class </span><a class="code" href="../../d4/d10/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_echo_module.html">EchoModule</a> : <a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html">IWebsocketModule</a></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160; {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor"> #region Public Methods</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160; <span class="keyword">public</span> <span class="keywordtype">void</span> SendMessage(<a class="code" href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html">WebsocketHandler</a> handler, <a class="code" href="../../d4/dbb/class_m_t_s_c_1_1_server_1_1_client_data.html">ClientData</a> client, <a class="code" href="../../d8/d92/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message.html">WebsocketMessage</a> message)</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; <span class="keywordtype">byte</span>[] encodedMessage = message.<a class="code" href="../../d8/d92/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message.html#ab11957d5fe1a10fa5f0e15edcb4cfd62">GetMessageBytes</a>();</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; handler.<a class="code" href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html#a4ba115e772f3c30814b21c508ef2cf61">QueueMessage</a>(client, encodedMessage);</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; }</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor"> #endregion</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor"> #region Interface Implementation</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordtype">bool</span> <a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html">IWebsocketModule</a>.<a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#a4c7c43390bb8f4f49cb2d354a8cb57d8">HandleReceivedMessage</a>(<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html">Server</a>.<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html#a39681d659b0b0b78d64ceb200346b572">Server</a> server, <a class="code" href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html">WebsocketHandler</a> handler, <a class="code" href="../../d4/dbb/class_m_t_s_c_1_1_server_1_1_client_data.html">ClientData</a> client, <a class="code" href="../../d8/d92/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message.html">WebsocketMessage</a> receivedMessage)</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; SendMessage(handler, client, receivedMessage);</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; }</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html">IWebsocketModule</a>.<a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#af7995b56b7be456b8e243219723a58a3">ConnectionClosed</a>(<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html">Server</a>.<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html#a39681d659b0b0b78d64ceb200346b572">Server</a> server, <a class="code" href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html">WebsocketHandler</a> handler, <a class="code" href="../../d4/dbb/class_m_t_s_c_1_1_server_1_1_client_data.html">ClientData</a> client)</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </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;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordtype">void</span> <a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html">IWebsocketModule</a>.<a class="code" href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#af8343d909795c638731c01c92bfb3101">ConnectionInitialized</a>(<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html">Server</a>.<a class="code" href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html#a39681d659b0b0b78d64ceb200346b572">Server</a> server, <a class="code" href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html">WebsocketHandler</a> handler, <a class="code" href="../../d4/dbb/class_m_t_s_c_1_1_server_1_1_client_data.html">ClientData</a> client)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; }</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor"> #endregion</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; }</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;}</div><div class="ttc" id="class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler_html"><div class="ttname"><a href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html">MTSC.Server.Handlers.WebsocketHandler</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d00/_server_2_handlers_2_websocket_handler_8cs_source.html#l00012">WebsocketHandler.cs:12</a></div></div>
<div class="ttc" id="interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module_html_a4c7c43390bb8f4f49cb2d354a8cb57d8"><div class="ttname"><a href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#a4c7c43390bb8f4f49cb2d354a8cb57d8">MTSC.Common.WebSockets.ServerModules.IWebsocketModule.HandleReceivedMessage</a></div><div class="ttdeci">bool HandleReceivedMessage(Server.Server server, WebsocketHandler handler, ClientData client, WebsocketMessage receivedMessage)</div><div class="ttdoc">Handle a received message.</div></div>
<div class="ttc" id="interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module_html_af7995b56b7be456b8e243219723a58a3"><div class="ttname"><a href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#af7995b56b7be456b8e243219723a58a3">MTSC.Common.WebSockets.ServerModules.IWebsocketModule.ConnectionClosed</a></div><div class="ttdeci">void ConnectionClosed(Server.Server server, WebsocketHandler handler, ClientData client)</div><div class="ttdoc">Called when a connection has been closed.</div></div>
<div class="ttc" id="class_m_t_s_c_1_1_server_1_1_client_data_html"><div class="ttname"><a href="../../d4/dbb/class_m_t_s_c_1_1_server_1_1_client_data.html">MTSC.Server.ClientData</a></div><div class="ttdoc">Structure containing client information.</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/dba/_server_8cs_source.html#l00402">Server.cs:402</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message_html"><div class="ttname"><a href="../../d8/d92/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message.html">MTSC.Common.WebSockets.WebsocketMessage</a></div><div class="ttdoc">Class containing the bytes of a websocket received message.</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/da0/_websocket_message_8cs_source.html#l00011">WebsocketMessage.cs:11</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_server_1_1_server_html_a39681d659b0b0b78d64ceb200346b572"><div class="ttname"><a href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html#a39681d659b0b0b78d64ceb200346b572">MTSC.Server.Server.Server</a></div><div class="ttdeci">Server()</div><div class="ttdoc">Creates an instance of server with default values.</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/dba/_server_8cs_source.html#l00068">Server.cs:68</a></div></div>
<div class="ttc" id="namespace_m_t_s_c_1_1_server_1_1_handlers_html"><div class="ttname"><a href="../../d4/d86/namespace_m_t_s_c_1_1_server_1_1_handlers.html">MTSC.Server.Handlers</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/d9a/_server_2_handlers_2_broadcast_handler_8cs_source.html#l00005">BroadcastHandler.cs:5</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_echo_module_html"><div class="ttname"><a href="../../d4/d10/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_echo_module.html">MTSC.Common.WebSockets.ServerModules.EchoModule</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d2/d29/_echo_module_8cs_source.html#l00010">EchoModule.cs:10</a></div></div>
<div class="ttc" id="namespace_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_html"><div class="ttname"><a href="../../d2/d2f/namespace_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules.html">MTSC.Common.WebSockets.ServerModules</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/d68/_broadcast_module_8cs_source.html#l00007">BroadcastModule.cs:7</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_server_1_1_server_html"><div class="ttname"><a href="../../d3/d7e/class_m_t_s_c_1_1_server_1_1_server.html">MTSC.Server.Server</a></div><div class="ttdoc">Basic server class to handle TCP connections.</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/dba/_server_8cs_source.html#l00020">Server.cs:20</a></div></div>
<div class="ttc" id="namespace_m_t_s_c_1_1_server_html"><div class="ttname"><a href="../../d3/d97/namespace_m_t_s_c_1_1_server.html">MTSC.Server</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/d9a/_server_2_handlers_2_broadcast_handler_8cs_source.html#l00005">BroadcastHandler.cs:5</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message_html_ab11957d5fe1a10fa5f0e15edcb4cfd62"><div class="ttname"><a href="../../d8/d92/class_m_t_s_c_1_1_common_1_1_web_sockets_1_1_websocket_message.html#ab11957d5fe1a10fa5f0e15edcb4cfd62">MTSC.Common.WebSockets.WebsocketMessage.GetMessageBytes</a></div><div class="ttdeci">byte [] GetMessageBytes()</div><div class="ttdoc">Get the packed message bytes.</div><div class="ttdef"><b>Definition:</b> <a href="../../d0/da0/_websocket_message_8cs_source.html#l00191">WebsocketMessage.cs:191</a></div></div>
<div class="ttc" id="namespace_m_t_s_c_html"><div class="ttname"><a href="../../d7/dcd/namespace_m_t_s_c.html">MTSC</a></div><div class="ttdef"><b>Definition:</b> <a href="../../db/d43/_client_8cs_source.html#l00014">Client.cs:14</a></div></div>
<div class="ttc" id="class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler_html_a4ba115e772f3c30814b21c508ef2cf61"><div class="ttname"><a href="../../da/dc7/class_m_t_s_c_1_1_server_1_1_handlers_1_1_websocket_handler.html#a4ba115e772f3c30814b21c508ef2cf61">MTSC.Server.Handlers.WebsocketHandler.QueueMessage</a></div><div class="ttdeci">void QueueMessage(ClientData client, byte[] message)</div><div class="ttdoc">Send a message to the client.</div><div class="ttdef"><b>Definition:</b> <a href="../../d8/d00/_server_2_handlers_2_websocket_handler_8cs_source.html#l00048">WebsocketHandler.cs:48</a></div></div>
<div class="ttc" id="interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module_html"><div class="ttname"><a href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html">MTSC.Common.WebSockets.ServerModules.IWebsocketModule</a></div><div class="ttdef"><b>Definition:</b> <a href="../../d5/d1b/_server_modules_2_i_websocket_module_8cs_source.html#l00009">IWebsocketModule.cs:9</a></div></div>
<div class="ttc" id="interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module_html_af8343d909795c638731c01c92bfb3101"><div class="ttname"><a href="../../d9/dc0/interface_m_t_s_c_1_1_common_1_1_web_sockets_1_1_server_modules_1_1_i_websocket_module.html#af8343d909795c638731c01c92bfb3101">MTSC.Common.WebSockets.ServerModules.IWebsocketModule.ConnectionInitialized</a></div><div class="ttdeci">void ConnectionInitialized(Server.Server server, WebsocketHandler handler, ClientData client)</div><div class="ttdoc">Called when a connection has been initialized.</div></div>
</div><!-- fragment --></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_62d48bea4fe746cedac2516f67715e2f.html">MTSC</a></li><li class="navelem"><a class="el" href="../../dir_dd7589cd703d467b08715c004924abac.html">MTSC</a></li><li class="navelem"><a class="el" href="../../dir_2b786a618fa1a35d0fa6c1f0a951f035.html">Common</a></li><li class="navelem"><a class="el" href="../../dir_191ea0d58bc4aa76598804cf9a9a4081.html">WebSockets</a></li><li class="navelem"><a class="el" href="../../dir_3e6c9ca704d5ac39bea56d7971e0d054.html">ServerModules</a></li><li class="navelem"><b>EchoModule.cs</b></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.15 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink