<!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>My Project: hal/architecture/Linux/drivers/core/EthernetServer.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/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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</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&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&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>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_52c912f73dac9c4c0e442232e1b2bd80.html">hal</a></li><li class="navelem"><a class="el" href="dir_f2b50fdf5983ac8db5dbb1f1d585f6a3.html">architecture</a></li><li class="navelem"><a class="el" href="dir_14e8f5cb68fb87a2830d32ad3850b550.html">Linux</a></li><li class="navelem"><a class="el" href="dir_68a77b0bc8673001e7a269f14784e305.html">drivers</a></li><li class="navelem"><a class="el" href="dir_0a272b5cc5deeb53553d5784b8e7c3ce.html">core</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">EthernetServer.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * The MySensors Arduino library handles the wireless radio link and protocol</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * between your home built sensors/actuators and HA controller of choice.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * The sensors forms a self healing radio network with optional repeaters. Each</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * repeater and gateway builds a routing tables in EEPROM which keeps track of the</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * network topology allowing messages to be routed to nodes.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * Created by Henrik Ekblad <henrik.ekblad@mysensors.org></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Copyright (C) 2013-2019 Sensnology AB</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Full contributor list: https://github.com/mysensors/MySensors/graphs/contributors</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Documentation: http://www.mysensors.org</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * Support Forum: http://forum.mysensors.org</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * This program is free software; you can redistribute it and/or</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * modify it under the terms of the GNU General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * version 2 as published by the Free Software Foundation.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * Based on Arduino ethernet library, Copyright (c) 2010 Arduino LLC. All right reserved.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef EthernetServer_h</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define EthernetServer_h</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <list></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "Server.h"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "IPAddress.h"</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#ifdef ETHERNETSERVER_MAX_CLIENTS</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define ETHERNETSERVER_BACKLOG ETHERNETSERVER_MAX_CLIENTS </span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define ETHERNETSERVER_MAX_CLIENTS 10 </span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define ETHERNETSERVER_BACKLOG 10 </span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">class </span><a class="code" href="class_ethernet_client.html">EthernetClient</a>;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="class_ethernet_server.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="class_ethernet_server.html">EthernetServer</a> : <span class="keyword">public</span> <a class="code" href="class_server.html">Server</a></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="class_ethernet_server.html#ae76fd84e3ca8c9fa0754396ebd97c280">EthernetServer</a>(uint16_t port, uint16_t max_clients = ETHERNETSERVER_MAX_CLIENTS);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ethernet_server.html#a8a236499f179a28ba80377f9a93adcce">begin</a>();</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">void</span> <a class="code" href="class_ethernet_server.html#a8a236499f179a28ba80377f9a93adcce">begin</a>(<a class="code" href="class_i_p_address.html">IPAddress</a> addr);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">bool</span> <a class="code" href="class_ethernet_server.html#a931d064471fb5a01668686fbef99172a">hasClient</a>();</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="class_ethernet_client.html">EthernetClient</a> <a class="code" href="class_ethernet_server.html#a609906d2a44c915990d4bf8437f01a2d">available</a>();</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_ethernet_server.html#ab29ae81867e314699c2bef2c2656d484">write</a>(uint8_t b);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> <a class="code" href="class_ethernet_server.html#ab29ae81867e314699c2bef2c2656d484">write</a>(<span class="keyword">const</span> uint8_t *buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_ethernet_server.html#ab29ae81867e314699c2bef2c2656d484">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *str);</div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_ethernet_server.html#ab29ae81867e314699c2bef2c2656d484">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  uint16_t port; </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  std::list<int> new_clients; </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  std::vector<int> clients; </div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  uint16_t max_clients; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keywordtype">int</span> sockfd; </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keywordtype">void</span> _accept();</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> };</div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclass_ethernet_server_html"><div class="ttname"><a href="class_ethernet_server.html">EthernetServer</a></div><div class="ttdoc">EthernetServer class.</div><div class="ttdef"><b>Definition:</b> EthernetServer.h:42</div></div>
<div class="ttc" id="aclass_server_html"><div class="ttname"><a href="class_server.html">Server</a></div><div class="ttdef"><b>Definition:</b> Server.h:26</div></div>
<div class="ttc" id="aclass_ethernet_server_html_a609906d2a44c915990d4bf8437f01a2d"><div class="ttname"><a href="class_ethernet_server.html#a609906d2a44c915990d4bf8437f01a2d">EthernetServer::available</a></div><div class="ttdeci">EthernetClient available()</div><div class="ttdoc">Get the new connected client.</div><div class="ttdef"><b>Definition:</b> EthernetServer.cpp:139</div></div>
<div class="ttc" id="aclass_i_p_address_html"><div class="ttname"><a href="class_i_p_address.html">IPAddress</a></div><div class="ttdoc">A class to make it easier to handle and pass around IP addresses.</div><div class="ttdef"><b>Definition:</b> IPAddress.h:32</div></div>
<div class="ttc" id="aclass_ethernet_server_html_a931d064471fb5a01668686fbef99172a"><div class="ttname"><a href="class_ethernet_server.html#a931d064471fb5a01668686fbef99172a">EthernetServer::hasClient</a></div><div class="ttdeci">bool hasClient()</div><div class="ttdoc">Verifies if a new client has connected.</div><div class="ttdef"><b>Definition:</b> EthernetServer.cpp:114</div></div>
<div class="ttc" id="aclass_ethernet_server_html_ae76fd84e3ca8c9fa0754396ebd97c280"><div class="ttname"><a href="class_ethernet_server.html#ae76fd84e3ca8c9fa0754396ebd97c280">EthernetServer::EthernetServer</a></div><div class="ttdeci">EthernetServer(uint16_t port, uint16_t max_clients=ETHERNETSERVER_MAX_CLIENTS)</div><div class="ttdoc">EthernetServer constructor.</div><div class="ttdef"><b>Definition:</b> EthernetServer.cpp:35</div></div>
<div class="ttc" id="aclass_ethernet_server_html_ab29ae81867e314699c2bef2c2656d484"><div class="ttname"><a href="class_ethernet_server.html#ab29ae81867e314699c2bef2c2656d484">EthernetServer::write</a></div><div class="ttdeci">virtual size_t write(uint8_t b)</div><div class="ttdoc">Write a byte to all clients.</div><div class="ttdef"><b>Definition:</b> EthernetServer.cpp:150</div></div>
<div class="ttc" id="aclass_ethernet_client_html"><div class="ttname"><a href="class_ethernet_client.html">EthernetClient</a></div><div class="ttdef"><b>Definition:</b> EthernetClient.h:43</div></div>
<div class="ttc" id="aclass_ethernet_server_html_a8a236499f179a28ba80377f9a93adcce"><div class="ttname"><a href="class_ethernet_server.html#a8a236499f179a28ba80377f9a93adcce">EthernetServer::begin</a></div><div class="ttdeci">virtual void begin()</div><div class="ttdoc">Listen for inbound connection request.</div><div class="ttdef"><b>Definition:</b> EthernetServer.cpp:41</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>