📄 a00181.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/webclient/webclient.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>apps/webclient/webclient.h</h1><a href="a00111.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 webclient</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"> * \file</span><a name="l00008"></a>00008 <span class="comment"> * Header file for the HTTP client.</span><a name="l00009"></a>00009 <span class="comment"> * \author Adam Dunkels <adam@dunkels.com></span><a name="l00010"></a>00010 <span class="comment"> */</span><a name="l00011"></a>00011 <a name="l00012"></a>00012 <span class="comment">/*</span><a name="l00013"></a>00013 <span class="comment"> * Copyright (c) 2002, Adam Dunkels.</span><a name="l00014"></a>00014 <span class="comment"> * All rights reserved.</span><a name="l00015"></a>00015 <span class="comment"> *</span><a name="l00016"></a>00016 <span class="comment"> * Redistribution and use in source and binary forms, with or without</span><a name="l00017"></a>00017 <span class="comment"> * modification, are permitted provided that the following conditions</span><a name="l00018"></a>00018 <span class="comment"> * are met:</span><a name="l00019"></a>00019 <span class="comment"> * 1. Redistributions of source code must retain the above copyright</span><a name="l00020"></a>00020 <span class="comment"> * notice, this list of conditions and the following disclaimer.</span><a name="l00021"></a>00021 <span class="comment"> * 2. Redistributions in binary form must reproduce the above</span><a name="l00022"></a>00022 <span class="comment"> * copyright notice, this list of conditions and the following</span><a name="l00023"></a>00023 <span class="comment"> * disclaimer in the documentation and/or other materials provided</span><a name="l00024"></a>00024 <span class="comment"> * with the distribution.</span><a name="l00025"></a>00025 <span class="comment"> * 3. The name of the author may not be used to endorse or promote</span><a name="l00026"></a>00026 <span class="comment"> * products derived from this software without specific prior</span><a name="l00027"></a>00027 <span class="comment"> * written permission.</span><a name="l00028"></a>00028 <span class="comment"> *</span><a name="l00029"></a>00029 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS</span><a name="l00030"></a>00030 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED</span><a name="l00031"></a>00031 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</span><a name="l00032"></a>00032 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY</span><a name="l00033"></a>00033 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL</span><a name="l00034"></a>00034 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE</span><a name="l00035"></a>00035 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</span><a name="l00036"></a>00036 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span><a name="l00037"></a>00037 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span><a name="l00038"></a>00038 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span><a name="l00039"></a>00039 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span><a name="l00040"></a>00040 <span class="comment"> *</span><a name="l00041"></a>00041 <span class="comment"> * This file is part of the uIP TCP/IP stack.</span><a name="l00042"></a>00042 <span class="comment"> *</span><a name="l00043"></a>00043 <span class="comment"> * $Id: webclient.h,v 1.2 2006/06/11 21:46:37 adam Exp $</span><a name="l00044"></a>00044 <span class="comment"> *</span><a name="l00045"></a>00045 <span class="comment"> */</span><a name="l00046"></a>00046 <span class="preprocessor">#ifndef __WEBCLIENT_H__</span><a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define __WEBCLIENT_H__</span><a name="l00048"></a>00048 <span class="preprocessor"></span><a name="l00049"></a>00049 <a name="l00050"></a>00050 <span class="preprocessor">#include "webclient-strings.h"</span><a name="l00051"></a>00051 <span class="preprocessor">#include "<a class="code" href="a00140.html">uipopt.h</a>"</span><a name="l00052"></a>00052 <a name="l00053"></a><a class="code" href="a00163.html#g5a5bfd7e9060903893481db90645187b">00053</a> <span class="preprocessor">#define WEBCLIENT_CONF_MAX_URLLEN 100</span><a name="l00054"></a>00054 <span class="preprocessor"></span><a name="l00055"></a><a class="code" href="a00097.html">00055</a> <span class="keyword">struct </span><a class="code" href="a00097.html">webclient_state</a> {<a name="l00056"></a><a class="code" href="a00097.html#5960d82e7aca2986b8509a0d87d6cbc8">00056</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00087.html">timer</a>;<a name="l00057"></a><a class="code" href="a00097.html#8ae6395641b7752dce47881e20cee970">00057</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00097.html#8ae6395641b7752dce47881e20cee970">state</a>;<a name="l00058"></a><a class="code" href="a00097.html#6925d46b2819adb474a5f0036f02dd7d">00058</a> <a class="code" href="a00153.html#g4caecabca98b43919dd11be1c0d4cd8e">u8_t</a> <a class="code" href="a00097.html#6925d46b2819adb474a5f0036f02dd7d">httpflag</a>;<a name="l00059"></a>00059 <a name="l00060"></a><a class="code" href="a00097.html#7092781c50dcad50f473888585c85b83">00060</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00097.html#7092781c50dcad50f473888585c85b83">port</a>;<a name="l00061"></a><a class="code" href="a00097.html#a6487b9c1c773b32656065d0e19bf142">00061</a> <span class="keywordtype">char</span> <a class="code" href="a00097.html#a6487b9c1c773b32656065d0e19bf142">host</a>[40];<a name="l00062"></a><a class="code" href="a00097.html#e87913860c6b05c6e6b060639b950098">00062</a> <span class="keywordtype">char</span> <a class="code" href="a00097.html#e87913860c6b05c6e6b060639b950098">file</a>[<a class="code" href="a00163.html#g5a5bfd7e9060903893481db90645187b">WEBCLIENT_CONF_MAX_URLLEN</a>];<a name="l00063"></a><a class="code" href="a00097.html#134ec55c3d5abaebfed4ff8edfedf1ea">00063</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00097.html#134ec55c3d5abaebfed4ff8edfedf1ea">getrequestptr</a>;<a name="l00064"></a><a class="code" href="a00097.html#5a3116623c6a7da7c82db6c301ae0da3">00064</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00097.html#5a3116623c6a7da7c82db6c301ae0da3">getrequestleft</a>;<a name="l00065"></a>00065 <a name="l00066"></a><a class="code" href="a00097.html#606d2729bf411ade69044828403a72af">00066</a> <span class="keywordtype">char</span> <a class="code" href="a00097.html#606d2729bf411ade69044828403a72af">httpheaderline</a>[200];<a name="l00067"></a><a class="code" href="a00097.html#2fca02673894f222b01ad2d3a4d7dd79">00067</a> <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00097.html#2fca02673894f222b01ad2d3a4d7dd79">httpheaderlineptr</a>;<a name="l00068"></a>00068 <a name="l00069"></a><a class="code" href="a00097.html#fb60f42593d305ea36d9b4303722696e">00069</a> <span class="keywordtype">char</span> <a class="code" href="a00097.html#fb60f42593d305ea36d9b4303722696e">mimetype</a>[32];<a name="l00070"></a>00070 };<a name="l00071"></a>00071 <a name="l00072"></a><a class="code" href="a00163.html#gdc5aec3587b2c55b714a6c2f37b56cba">00072</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a00097.html">webclient_state</a> <a class="code" href="a00153.html#g69646a81a922033c5281445a71f8ffed">uip_tcp_appstate_t</a>;<a name="l00073"></a><a class="code" href="a00163.html#ge28f6cb60e86088d8886d0f804b4f37c">00073</a> <span class="preprocessor">#define UIP_APPCALL webclient_appcall</span><a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment"></span><a name="l00075"></a>00075 <span class="comment">/**</span><a name="l00076"></a>00076 <span class="comment"> * Callback function that is called from the webclient code when HTTP</span><a name="l00077"></a>00077 <span class="comment"> * data has been received.</span><a name="l00078"></a>00078 <span class="comment"> *</span><a name="l00079"></a>00079 <span class="comment"> * This function must be implemented by the module that uses the</span><a name="l00080"></a>00080 <span class="comment"> * webclient code. The function is called from the webclient module</span><a name="l00081"></a>00081 <span class="comment"> * when HTTP data has been received. The function is not called when</span><a name="l00082"></a>00082 <span class="comment"> * HTTP headers are received, only for the actual data.</span><a name="l00083"></a>00083 <span class="comment"> *</span><a name="l00084"></a>00084 <span class="comment"> * \note This function is called many times, repetedly, when data is</span><a name="l00085"></a>00085 <span class="comment"> * being received, and not once when all data has been received.</span><a name="l00086"></a>00086 <span class="comment"> *</span><a name="l00087"></a>00087 <span class="comment"> * \param data A pointer to the data that has been received.</span><a name="l00088"></a>00088 <span class="comment"> * \param len The length of the data that has been received.</span><a name="l00089"></a>00089 <span class="comment"> */</span><a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="a00163.html#gc4b119801e50cc1824498a1cdf9adc37">webclient_datahandler</a>(<span class="keywordtype">char</span> *data, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> len);<a name="l00091"></a>00091 <span class="comment"></span><a name="l00092"></a>00092 <span class="comment">/**</span><a name="l00093"></a>00093 <span class="comment"> * Callback function that is called from the webclient code when the</span><a name="l00094"></a>00094 <span class="comment"> * HTTP connection has been connected to the web server.</span><a name="l00095"></a>00095 <span class="comment"> *</span><a name="l00096"></a>00096 <span class="comment"> * This function must be implemented by the module that uses the</span><a name="l00097"></a>00097 <span class="comment"> * webclient code.</span><a name="l00098"></a>00098 <span class="comment"> */</span><a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="a00163.html#g6b942c1ef22f8cd1a726ef3364c9fbea">webclient_connected</a>(<span class="keywordtype">void</span>);<a name="l00100"></a>00100 <span class="comment"></span><a name="l00101"></a>00101 <span class="comment">/**</span><a name="l00102"></a>00102 <span class="comment"> * Callback function that is called from the webclient code if the</span><a name="l00103"></a>00103 <span class="comment"> * HTTP connection to the web server has timed out.</span><a name="l00104"></a>00104 <span class="comment"> *</span><a name="l00105"></a>00105 <span class="comment"> * This function must be implemented by the module that uses the</span><a name="l00106"></a>00106 <span class="comment"> * webclient code.</span><a name="l00107"></a>00107 <span class="comment"> */</span>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -