doc/doxygen/output/html/index.html - third_party/github/STMicroelectronics/stm32_mw_lwip - Git at Google

 <!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.13"/>
 <meta name="viewport" content="width=device-width, initial-scale=1"/>
 <title>lwIP: Overview</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">
   $(document).ready(initResizable);
 </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">lwIP
    &#160;<span id="projectnumber">2.1.2</span>
    </div>
    <div id="projectbrief">Lightweight IP stack</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.13 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
 <script type="text/javascript" src="menudata.js"></script>
 <script type="text/javascript" src="menu.js"></script>
 <script type="text/javascript">
 $(function() {
   initMenu('',true,false,'search.php','Search');
   $(document).ready(function() { init_search(); });
 });
 </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">
 $(document).ready(function(){initNavTree('index.html','');});
 </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">Overview </div>  </div>
 </div><!--header-->
 <div class="contents">
 <div class="textblock"><pre class="fragment">INTRODUCTION

 lwIP is a small independent implementation of the TCP/IP protocol suite.

 The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
 while still having a full scale TCP. This making lwIP suitable for use
 in embedded systems with tens of kilobytes of free RAM and room for
 around 40 kilobytes of code ROM.

 lwIP was originally developed by Adam Dunkels at the Computer and Networks
 Architectures (CNA) lab at the Swedish Institute of Computer Science (SICS)
 and is now developed and maintained by a worldwide network of developers.

 FEATURES

   * IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over
     multiple network interfaces
   * ICMP (Internet Control Message Protocol) for network maintenance and debugging
   * IGMP (Internet Group Management Protocol) for multicast traffic management
   * MLD (Multicast listener discovery for IPv6). Aims to be compliant with
     RFC 2710. No support for MLDv2
   * ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
     Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
     (Address autoconfiguration)
   * DHCP, AutoIP/APIPA (Zeroconf) and (stateless) DHCPv6
   * UDP (User Datagram Protocol) including experimental UDP-lite extensions
   * TCP (Transmission Control Protocol) with congestion control, RTT estimation
     fast recovery/fast retransmit and sending SACKs
   * raw/native API for enhanced performance
   * Optional Berkeley-like socket API
   * TLS: optional layered TCP ("altcp") for nearly transparent TLS for any
     TCP-based protocol (ported to mbedTLS) (see changelog for more info)
   * PPPoS and PPPoE (Point-to-point protocol over Serial/Ethernet)
   * DNS (Domain name resolver incl. mDNS)
   * 6LoWPAN (via IEEE 802.15.4, BLE or ZEP)


 APPLICATIONS

   * HTTP server with SSI and CGI (HTTPS via altcp)
   * SNMPv2c agent with MIB compiler (Simple Network Management Protocol), v3 via altcp
   * SNTP (Simple network time protocol)
   * NetBIOS name service responder
   * MDNS (Multicast DNS) responder
   * iPerf server implementation
   * MQTT client (TLS support via altcp)


 LICENSE

 lwIP is freely available under a BSD license.


 DEVELOPMENT

 lwIP has grown into an excellent TCP/IP stack for embedded devices,
 and developers using the stack often submit bug fixes, improvements,
 and additions to the stack to further increase its usefulness.

 Development of lwIP is hosted on Savannah, a central point for
 software development, maintenance and distribution. Everyone can
 help improve lwIP by use of Savannah's interface, Git and the
 mailing list. A core team of developers will commit changes to the
 Git source tree.

 The lwIP TCP/IP stack is maintained in the 'lwip' Git module and
 contributions (such as platform ports) are in the 'contrib' Git module.

 See doc/savannah.txt for details on Git server access for users and
 developers.

 The current Git trees are web-browsable:
   http://git.savannah.gnu.org/cgit/lwip.git
   http://git.savannah.gnu.org/cgit/lwip/lwip-contrib.git

 Submit patches and bugs via the lwIP project page:
   http://savannah.nongnu.org/projects/lwip/

 Continuous integration builds (GCC, clang):
   https://travis-ci.org/yarrick/lwip-merged


 DOCUMENTATION

 Self documentation of the source code is regularly extracted from the current
 Git sources and is available from this web page:
   http://www.nongnu.org/lwip/

 There is now a constantly growing wiki about lwIP at
   http://lwip.wikia.com/wiki/LwIP_Wiki

 Also, there are mailing lists you can subscribe at
   http://savannah.nongnu.org/mail/?group=lwip
 plus searchable archives:
   http://lists.nongnu.org/archive/html/lwip-users/
   http://lists.nongnu.org/archive/html/lwip-devel/

 lwIP was originally written by Adam Dunkels:
   http://dunkels.com/adam/

 Reading Adam's papers, the files in docs/, browsing the source code
 documentation and browsing the mailing list archives is a good way to
 become familiar with the design of lwIP.

 Adam Dunkels &lt;adam@sics.se&gt;
 Leon Woestenberg &lt;leon.woestenberg@gmx.net&gt;
 </pre> </div></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="footer">Generated by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
   </ul>
 </div>
 </body>
 </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.13"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>lwIP: Overview</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">
	$(document).ready(initResizable);
	</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">lwIP
	<span id="projectnumber">2.1.2</span>
	</div>
	<div id="projectbrief">Lightweight IP stack</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<!-- end header part -->
	<!-- Generated by Doxygen 1.8.13 -->
	<script type="text/javascript">
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	</script>
	<script type="text/javascript" src="menudata.js"></script>
	<script type="text/javascript" src="menu.js"></script>
	<script type="text/javascript">
	$(function() {
	initMenu('',true,false,'search.php','Search');
	$(document).ready(function() { init_search(); });
	});
	</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">
	$(document).ready(function(){initNavTree('index.html','');});
	</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">Overview </div> </div>
	</div><!--header-->
	<div class="contents">
	<div class="textblock"><pre class="fragment">INTRODUCTION

	lwIP is a small independent implementation of the TCP/IP protocol suite.

	The focus of the lwIP TCP/IP implementation is to reduce the RAM usage
	while still having a full scale TCP. This making lwIP suitable for use
	in embedded systems with tens of kilobytes of free RAM and room for
	around 40 kilobytes of code ROM.

	lwIP was originally developed by Adam Dunkels at the Computer and Networks
	Architectures (CNA) lab at the Swedish Institute of Computer Science (SICS)
	and is now developed and maintained by a worldwide network of developers.

	FEATURES

	* IP (Internet Protocol, IPv4 and IPv6) including packet forwarding over
	multiple network interfaces
	* ICMP (Internet Control Message Protocol) for network maintenance and debugging
	* IGMP (Internet Group Management Protocol) for multicast traffic management
	* MLD (Multicast listener discovery for IPv6). Aims to be compliant with
	RFC 2710. No support for MLDv2
	* ND (Neighbor discovery and stateless address autoconfiguration for IPv6).
	Aims to be compliant with RFC 4861 (Neighbor discovery) and RFC 4862
	(Address autoconfiguration)
	* DHCP, AutoIP/APIPA (Zeroconf) and (stateless) DHCPv6
	* UDP (User Datagram Protocol) including experimental UDP-lite extensions
	* TCP (Transmission Control Protocol) with congestion control, RTT estimation
	fast recovery/fast retransmit and sending SACKs
	* raw/native API for enhanced performance
	* Optional Berkeley-like socket API
	* TLS: optional layered TCP ("altcp") for nearly transparent TLS for any
	TCP-based protocol (ported to mbedTLS) (see changelog for more info)
	* PPPoS and PPPoE (Point-to-point protocol over Serial/Ethernet)
	* DNS (Domain name resolver incl. mDNS)
	* 6LoWPAN (via IEEE 802.15.4, BLE or ZEP)


	APPLICATIONS

	* HTTP server with SSI and CGI (HTTPS via altcp)
	* SNMPv2c agent with MIB compiler (Simple Network Management Protocol), v3 via altcp
	* SNTP (Simple network time protocol)
	* NetBIOS name service responder
	* MDNS (Multicast DNS) responder
	* iPerf server implementation
	* MQTT client (TLS support via altcp)


	LICENSE

	lwIP is freely available under a BSD license.


	DEVELOPMENT

	lwIP has grown into an excellent TCP/IP stack for embedded devices,
	and developers using the stack often submit bug fixes, improvements,
	and additions to the stack to further increase its usefulness.

	Development of lwIP is hosted on Savannah, a central point for
	software development, maintenance and distribution. Everyone can
	help improve lwIP by use of Savannah's interface, Git and the
	mailing list. A core team of developers will commit changes to the
	Git source tree.

	The lwIP TCP/IP stack is maintained in the 'lwip' Git module and
	contributions (such as platform ports) are in the 'contrib' Git module.

	See doc/savannah.txt for details on Git server access for users and
	developers.

	The current Git trees are web-browsable:
	http://git.savannah.gnu.org/cgit/lwip.git
	http://git.savannah.gnu.org/cgit/lwip/lwip-contrib.git

	Submit patches and bugs via the lwIP project page:
	http://savannah.nongnu.org/projects/lwip/

	Continuous integration builds (GCC, clang):
	https://travis-ci.org/yarrick/lwip-merged


	DOCUMENTATION

	Self documentation of the source code is regularly extracted from the current
	Git sources and is available from this web page:
	http://www.nongnu.org/lwip/

	There is now a constantly growing wiki about lwIP at
	http://lwip.wikia.com/wiki/LwIP_Wiki

	Also, there are mailing lists you can subscribe at
	http://savannah.nongnu.org/mail/?group=lwip
	plus searchable archives:
	http://lists.nongnu.org/archive/html/lwip-users/
	http://lists.nongnu.org/archive/html/lwip-devel/

	lwIP was originally written by Adam Dunkels:
	http://dunkels.com/adam/

	Reading Adam's papers, the files in docs/, browsing the source code
	documentation and browsing the mailing list archives is a good way to
	become familiar with the design of lwIP.

	Adam Dunkels <adam@sics.se>
	Leon Woestenberg <leon.woestenberg@gmx.net>
	</pre> </div></div><!-- contents -->
	</div><!-- doc-content -->
	<!-- start footer part -->
	<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<ul>
	<li class="footer">Generated by
	<a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
	</ul>
	</div>
	</body>
	</html>