📄 a00202.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: uip/uip.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 Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="classes.html"><span>Data 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 List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul></div><h1>uip/uip.h</h1><a href="a00136.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">/**</span><a name="l00003"></a>00003 <span class="comment"> * \addtogroup uip</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">/**</span><a name="l00008"></a>00008 <span class="comment"> * \file</span><a name="l00009"></a>00009 <span class="comment"> * Header file for the uIP TCP/IP stack.</span><a name="l00010"></a>00010 <span class="comment"> * \author Adam Dunkels <adam@dunkels.com></span><a name="l00011"></a>00011 <span class="comment"> *</span><a name="l00012"></a>00012 <span class="comment"> * The uIP TCP/IP stack header file contains definitions for a number</span><a name="l00013"></a>00013 <span class="comment"> * of C macros that are used by uIP programs as well as internal uIP</span><a name="l00014"></a>00014 <span class="comment"> * structures, TCP/IP header structures and function declarations.</span><a name="l00015"></a>00015 <span class="comment"> *</span><a name="l00016"></a>00016 <span class="comment"> */</span><a name="l00017"></a>00017 <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="comment">/*</span><a name="l00020"></a>00020 <span class="comment"> * Copyright (c) 2001-2003, Adam Dunkels.</span><a name="l00021"></a>00021 <span class="comment"> * All rights reserved.</span><a name="l00022"></a>00022 <span class="comment"> *</span><a name="l00023"></a>00023 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span><a name="l00024"></a>00024 <span class="comment"> * modification, are permitted provided that the following conditions</span><a name="l00025"></a>00025 <span class="comment"> * are met:</span><a name="l00026"></a>00026 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span><a name="l00027"></a>00027 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span><a name="l00028"></a>00028 <span class="comment"> * 2. Redistributions in binary form must reproduce the above copyright</span><a name="l00029"></a>00029 <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span><a name="l00030"></a>00030 <span class="comment"> * documentation and/or other materials provided with the distribution.</span><a name="l00031"></a>00031 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span><a name="l00032"></a>00032 <span class="comment"> * products derived from this software without specific prior</span><a name="l00033"></a>00033 <span class="comment"> * written permission.</span><a name="l00034"></a>00034 <span class="comment"> *</span><a name="l00035"></a>00035 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span><a name="l00036"></a>00036 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span><a name="l00037"></a>00037 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span><a name="l00038"></a>00038 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span><a name="l00039"></a>00039 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span><a name="l00040"></a>00040 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span><a name="l00041"></a>00041 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span><a name="l00042"></a>00042 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span><a name="l00043"></a>00043 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span><a name="l00044"></a>00044 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span><a name="l00045"></a>00045 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span><a name="l00046"></a>00046 <span class="comment"> *</span><a name="l00047"></a>00047 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span><a name="l00048"></a>00048 <span class="comment"> *</span><a name="l00049"></a>00049 <span class="comment"> * $Id: uip.h,v 1.40 2006/06/08 07:12:07 adam Exp $</span><a name="l00050"></a>00050 <span class="comment"> *</span><a name="l00051"></a>00051 <span class="comment"> */</span><a name="l00052"></a>00052 <a name="l00053"></a>00053 <span class="preprocessor">#ifndef __UIP_H__</span><a name="l00054"></a>00054 <span class="preprocessor"></span><span class="preprocessor">#define __UIP_H__</span><a name="l00055"></a>00055 <span class="preprocessor"></span><a name="l00056"></a>00056 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span><a name="l00057"></a>00057 <span class="comment"></span><a name="l00058"></a>00058 <span class="comment">/**</span><a name="l00059"></a>00059 <span class="comment"> * Repressentation of an IP address.</span><a name="l00060"></a>00060 <span class="comment"> *</span><a name="l00061"></a>00061 <span class="comment"> */</span><a name="l00062"></a><a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">00062</a> <span class="keyword">typedef</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">uip_ip4addr_t</a>[2];<a name="l00063"></a><a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">00063</a> <span class="keyword">typedef</span> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a>[8];<a name="l00064"></a>00064 <span class="preprocessor">#if UIP_CONF_IPV6</span><a name="l00065"></a>00065 <span class="preprocessor"></span><span class="keyword">typedef</span> <a class="code" href="a00150.html#g9ebb4dac683163840eab9c6c41ad61f7">uip_ip6addr_t</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a>;<a name="l00066"></a>00066 <span class="preprocessor">#else </span><span class="comment">/* UIP_CONF_IPV6 */</span><a name="l00067"></a><a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">00067</a> <span class="keyword">typedef</span> <a class="code" href="a00150.html#g20ceef9d0868d391c2f33041b02cb1f1">uip_ip4addr_t</a> <a class="code" href="a00150.html#g1ef35301f43a5bbb9f89f07b5a36b9a0">uip_ipaddr_t</a>;<a name="l00068"></a>00068 <span class="preprocessor">#endif </span><span class="comment">/* UIP_CONF_IPV6 */</span><a name="l00069"></a>00069 <a name="l00070"></a>00070 <span class="comment">/*---------------------------------------------------------------------------*/</span><a name="l00071"></a>00071 <span class="comment">/* First, the functions that should be called from the</span><a name="l00072"></a>00072 <span class="comment"> * system. Initialization, the periodic timer and incoming packets are</span><a name="l00073"></a>00073 <span class="comment"> * handled by the following three functions.</span><a name="l00074"></a>00074 <span class="comment"> */</span><a name="l00075"></a>00075 <span class="comment"></span><a name="l00076"></a>00076 <span class="comment">/**</span><a name="l00077"></a>00077 <span class="comment"> * \defgroup uipconffunc uIP configuration functions</span><a name="l00078"></a>00078 <span class="comment"> * @{</span><a name="l00079"></a>00079 <span class="comment"> *</span><a name="l00080"></a>00080 <span class="comment"> * The uIP configuration functions are used for setting run-time</span><a name="l00081"></a>00081 <span class="comment"> * parameters in uIP such as IP addresses.</span><a name="l00082"></a>00082 <span class="comment"> */</span><a name="l00083"></a>00083 <span class="comment"></span><a name="l00084"></a>00084 <span class="comment">/**</span><a name="l00085"></a>00085 <span class="comment"> * Set the IP address of this host.</span><a name="l00086"></a>00086 <span class="comment"> *</span><a name="l00087"></a>00087 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span><a name="l00088"></a>00088 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span><a name="l00089"></a>00089 <span class="comment"> * array.</span><a name="l00090"></a>00090 <span class="comment"> *</span><a name="l00091"></a>00091 <span class="comment"> * Example:</span><a name="l00092"></a>00092 <span class="comment"> \code</span><a name="l00093"></a>00093 <span class="comment"></span><a name="l00094"></a>00094 <span class="comment"> uip_ipaddr_t addr;</span><a name="l00095"></a>00095 <span class="comment"></span><a name="l00096"></a>00096 <span class="comment"> uip_ipaddr(&addr, 192,168,1,2);</span><a name="l00097"></a>00097 <span class="comment"> uip_sethostaddr(&addr);</span><a name="l00098"></a>00098 <span class="comment"> </span><a name="l00099"></a>00099 <span class="comment"> \endcode</span><a name="l00100"></a>00100 <span class="comment"> * \param addr A pointer to an IP address of type uip_ipaddr_t;</span><a name="l00101"></a>00101 <span class="comment"> *</span><a name="l00102"></a>00102 <span class="comment"> * \sa uip_ipaddr()</span><a name="l00103"></a>00103 <span class="comment"> *</span><a name="l00104"></a>00104 <span class="comment"> * \hideinitializer</span><a name="l00105"></a>00105 <span class="comment"> */</span><a name="l00106"></a><a class="code" href="a00144.html#g12b467f314489259dd718228d0827a51">00106</a> <span class="preprocessor">#define uip_sethostaddr(addr) uip_ipaddr_copy(uip_hostaddr, (addr))</span><a name="l00107"></a>00107 <span class="preprocessor"></span><span class="comment"></span><a name="l00108"></a>00108 <span class="comment">/**</span><a name="l00109"></a>00109 <span class="comment"> * Get the IP address of this host.</span><a name="l00110"></a>00110 <span class="comment"> *</span><a name="l00111"></a>00111 <span class="comment"> * The IP address is represented as a 4-byte array where the first</span><a name="l00112"></a>00112 <span class="comment"> * octet of the IP address is put in the first member of the 4-byte</span><a name="l00113"></a>00113 <span class="comment"> * array.</span><a name="l00114"></a>00114 <span class="comment"> *</span><a name="l00115"></a>00115 <span class="comment"> * Example:</span><a name="l00116"></a>00116 <span class="comment"> \code</span><a name="l00117"></a>00117 <span class="comment"> uip_ipaddr_t hostaddr;</span><a name="l00118"></a>00118 <span class="comment"></span><a name="l00119"></a>00119 <span class="comment"> uip_gethostaddr(&hostaddr);</span><a name="l00120"></a>00120 <span class="comment"> \endcode</span><a name="l00121"></a>00121 <span class="comment"> * \param addr A pointer to a uip_ipaddr_t variable that will be</span><a name="l00122"></a>00122 <span class="comment"> * filled in with the currently configured IP address.</span><a name="l00123"></a>00123 <span class="comment"> *</span><a name="l00124"></a>00124 <span class="comment"> * \hideinitializer</span><a name="l00125"></a>00125 <span class="comment"> */</span><a name="l00126"></a><a class="code" href="a00144.html#g20bc87e5c063c3f4b01547be6e5a0148">00126</a> <span class="preprocessor">#define uip_gethostaddr(addr) uip_ipaddr_copy((addr), uip_hostaddr)</span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -