rt-thread-official/components/net/uip/doc/html/a00171.html

78 lines
6.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>uIP 1.0: apps/hello-world/hello-world.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="classes.html"><span>Data&nbsp;Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>apps/hello-world/hello-world.h</h1><a href="a00101.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**</span>
<a name="l00002"></a>00002 <span class="comment"> * \addtogroup apps</span>
<a name="l00003"></a>00003 <span class="comment"> * @{</span>
<a name="l00004"></a>00004 <span class="comment"> */</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/**</span>
<a name="l00007"></a>00007 <span class="comment"> * \defgroup helloworld Hello, world</span>
<a name="l00008"></a>00008 <span class="comment"> * @{</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * A small example showing how to write applications with</span>
<a name="l00011"></a>00011 <span class="comment"> * \ref psock "protosockets".</span>
<a name="l00012"></a>00012 <span class="comment"> */</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">/**</span>
<a name="l00015"></a>00015 <span class="comment"> * \file</span>
<a name="l00016"></a>00016 <span class="comment"> * Header file for an example of how to write uIP applications</span>
<a name="l00017"></a>00017 <span class="comment"> * with protosockets.</span>
<a name="l00018"></a>00018 <span class="comment"> * \author</span>
<a name="l00019"></a>00019 <span class="comment"> * Adam Dunkels &lt;adam@sics.se&gt;</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __HELLO_WORLD_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __HELLO_WORLD_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">/* Since this file will be included by uip.h, we cannot include uip.h</span>
<a name="l00026"></a>00026 <span class="comment"> here. But we might need to include uipopt.h if we need the u8_t and</span>
<a name="l00027"></a>00027 <span class="comment"> u16_t datatypes. */</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="a00127.html">psock.h</a>"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="comment">/* Next, we define the uip_tcp_appstate_t datatype. This is the state</span>
<a name="l00033"></a>00033 <span class="comment"> of our application, and the memory required for this state is</span>
<a name="l00034"></a>00034 <span class="comment"> allocated together with each TCP connection. One application state</span>
<a name="l00035"></a>00035 <span class="comment"> for each TCP connection. */</span>
<a name="l00036"></a><a class="code" href="a00078.html">00036</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00078.html">hello_world_state</a> {
<a name="l00037"></a><a class="code" href="a00078.html#a9825b5977b2d4dec66e6bd09e6ae6ea">00037</a> <span class="keyword">struct </span><a class="code" href="a00082.html">psock</a> <a class="code" href="a00078.html#a9825b5977b2d4dec66e6bd09e6ae6ea">p</a>;
<a name="l00038"></a><a class="code" href="a00078.html#4b1b1436b50ed7638aece35f41421196">00038</a> <span class="keywordtype">char</span> <a class="code" href="a00078.html#4b1b1436b50ed7638aece35f41421196">inputbuffer</a>[10];
<a name="l00039"></a><a class="code" href="a00078.html#4da86e9feb5e5835eb15163c2cb61116">00039</a> <span class="keywordtype">char</span> <a class="code" href="a00078.html#4da86e9feb5e5835eb15163c2cb61116">name</a>[40];
<a name="l00040"></a>00040 } <a class="code" href="a00085.html">uip_tcp_appstate_t</a>;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="comment">/* Finally we define the application function to be called by uIP. */</span>
<a name="l00043"></a>00043 <span class="keywordtype">void</span> <a class="code" href="a00162.html#g03070adbf8faab0f34f87c1270964306">hello_world_appcall</a>(<span class="keywordtype">void</span>);
<a name="l00044"></a>00044 <span class="preprocessor">#ifndef UIP_APPCALL</span>
<a name="l00045"></a><a class="code" href="a00162.html#ge28f6cb60e86088d8886d0f804b4f37c">00045</a> <span class="preprocessor"></span><span class="preprocessor">#define UIP_APPCALL hello_world_appcall</span>
<a name="l00046"></a>00046 <span class="preprocessor"></span><span class="preprocessor">#endif </span><span class="comment">/* UIP_APPCALL */</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keywordtype">void</span> <a class="code" href="a00162.html#gb97849f0d3ea858eee790b69591e6427">hello_world_init</a>(<span class="keywordtype">void</span>);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="preprocessor">#endif </span><span class="comment">/* __HELLO_WORLD_H__ */</span>
<a name="l00051"></a>00051 <span class="comment">/** @} */</span><span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">/** @} */</span>
</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>