254 lines
25 KiB
HTML
254 lines
25 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/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>
|
|
<a name="l00108"></a>00108 <span class="keywordtype">void</span> <a class="code" href="a00163.html#g23705efb9077187881f094fc9be13bde">webclient_timedout</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00109"></a>00109 <span class="comment"></span>
|
|
<a name="l00110"></a>00110 <span class="comment">/**</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * Callback function that is called from the webclient code if the</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * HTTP connection to the web server has been aborted by the web</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> * server.</span>
|
|
<a name="l00114"></a>00114 <span class="comment"> *</span>
|
|
<a name="l00115"></a>00115 <span class="comment"> * This function must be implemented by the module that uses the</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> * webclient code.</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> */</span>
|
|
<a name="l00118"></a>00118 <span class="keywordtype">void</span> <a class="code" href="a00163.html#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7">webclient_aborted</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00119"></a>00119 <span class="comment"></span>
|
|
<a name="l00120"></a>00120 <span class="comment">/**</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> * Callback function that is called from the webclient code when the</span>
|
|
<a name="l00122"></a>00122 <span class="comment"> * HTTP connection to the web server has been closed.</span>
|
|
<a name="l00123"></a>00123 <span class="comment"> *</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * This function must be implemented by the module that uses the</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> * webclient code.</span>
|
|
<a name="l00126"></a>00126 <span class="comment"> */</span>
|
|
<a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="a00163.html#gf8f12c820cc08da32aa62898bfc02db3">webclient_closed</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00128"></a>00128
|
|
<a name="l00129"></a>00129
|
|
<a name="l00130"></a>00130 <span class="comment"></span>
|
|
<a name="l00131"></a>00131 <span class="comment">/**</span>
|
|
<a name="l00132"></a>00132 <span class="comment"> * Initialize the webclient module.</span>
|
|
<a name="l00133"></a>00133 <span class="comment"> */</span>
|
|
<a name="l00134"></a>00134 <span class="keywordtype">void</span> <a class="code" href="a00163.html#g3caacabb2fe1c71921e1a471719ccbd2">webclient_init</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00135"></a>00135 <span class="comment"></span>
|
|
<a name="l00136"></a>00136 <span class="comment">/**</span>
|
|
<a name="l00137"></a>00137 <span class="comment"> * Open an HTTP connection to a web server and ask for a file using</span>
|
|
<a name="l00138"></a>00138 <span class="comment"> * the GET method.</span>
|
|
<a name="l00139"></a>00139 <span class="comment"> *</span>
|
|
<a name="l00140"></a>00140 <span class="comment"> * This function opens an HTTP connection to the specified web server</span>
|
|
<a name="l00141"></a>00141 <span class="comment"> * and requests the specified file using the GET method. When the HTTP</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> * connection has been connected, the webclient_connected() callback</span>
|
|
<a name="l00143"></a>00143 <span class="comment"> * function is called and when the HTTP data arrives the</span>
|
|
<a name="l00144"></a>00144 <span class="comment"> * webclient_datahandler() callback function is called.</span>
|
|
<a name="l00145"></a>00145 <span class="comment"> *</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * The callback function webclient_timedout() is called if the web</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> * server could not be contacted, and the webclient_aborted() callback</span>
|
|
<a name="l00148"></a>00148 <span class="comment"> * function is called if the HTTP connection is aborted by the web</span>
|
|
<a name="l00149"></a>00149 <span class="comment"> * server.</span>
|
|
<a name="l00150"></a>00150 <span class="comment"> *</span>
|
|
<a name="l00151"></a>00151 <span class="comment"> * When the HTTP request has been completed and the HTTP connection is</span>
|
|
<a name="l00152"></a>00152 <span class="comment"> * closed, the webclient_closed() callback function will be called.</span>
|
|
<a name="l00153"></a>00153 <span class="comment"> *</span>
|
|
<a name="l00154"></a>00154 <span class="comment"> * \note If the function is passed a host name, it must already be in</span>
|
|
<a name="l00155"></a>00155 <span class="comment"> * the resolver cache in order for the function to connect to the web</span>
|
|
<a name="l00156"></a>00156 <span class="comment"> * server. It is therefore up to the calling module to implement the</span>
|
|
<a name="l00157"></a>00157 <span class="comment"> * resolver calls and the signal handler used for reporting a resolv</span>
|
|
<a name="l00158"></a>00158 <span class="comment"> * query answer.</span>
|
|
<a name="l00159"></a>00159 <span class="comment"> *</span>
|
|
<a name="l00160"></a>00160 <span class="comment"> * \param host A pointer to a string containing either a host name or</span>
|
|
<a name="l00161"></a>00161 <span class="comment"> * a numerical IP address in dotted decimal notation (e.g., 192.168.23.1).</span>
|
|
<a name="l00162"></a>00162 <span class="comment"> *</span>
|
|
<a name="l00163"></a>00163 <span class="comment"> * \param port The port number to which to connect, in host byte order.</span>
|
|
<a name="l00164"></a>00164 <span class="comment"> *</span>
|
|
<a name="l00165"></a>00165 <span class="comment"> * \param file A pointer to the name of the file to get.</span>
|
|
<a name="l00166"></a>00166 <span class="comment"> *</span>
|
|
<a name="l00167"></a>00167 <span class="comment"> * \retval 0 if the host name could not be found in the cache, or</span>
|
|
<a name="l00168"></a>00168 <span class="comment"> * if a TCP connection could not be created.</span>
|
|
<a name="l00169"></a>00169 <span class="comment"> *</span>
|
|
<a name="l00170"></a>00170 <span class="comment"> * \retval 1 if the connection was initiated.</span>
|
|
<a name="l00171"></a>00171 <span class="comment"> */</span>
|
|
<a name="l00172"></a>00172 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3">webclient_get</a>(<span class="keywordtype">char</span> *<a class="code" href="a00097.html#a6487b9c1c773b32656065d0e19bf142">host</a>, <a class="code" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> <a class="code" href="a00097.html#7092781c50dcad50f473888585c85b83">port</a>, <span class="keywordtype">char</span> *<a class="code" href="a00097.html#e87913860c6b05c6e6b060639b950098">file</a>);
|
|
<a name="l00173"></a>00173 <span class="comment"></span>
|
|
<a name="l00174"></a>00174 <span class="comment">/**</span>
|
|
<a name="l00175"></a>00175 <span class="comment"> * Close the currently open HTTP connection.</span>
|
|
<a name="l00176"></a>00176 <span class="comment"> */</span>
|
|
<a name="l00177"></a>00177 <span class="keywordtype">void</span> <a class="code" href="a00163.html#g1d34be506a61db90dd7829117efdf8cf">webclient_close</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00178"></a>00178 <span class="keywordtype">void</span> <a class="code" href="a00163.html#g9e6d2864f390a4ba1ac60dc65e2b9815">webclient_appcall</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00179"></a>00179 <span class="comment"></span>
|
|
<a name="l00180"></a>00180 <span class="comment">/**</span>
|
|
<a name="l00181"></a>00181 <span class="comment"> * Obtain the MIME type of the current HTTP data stream.</span>
|
|
<a name="l00182"></a>00182 <span class="comment"> *</span>
|
|
<a name="l00183"></a>00183 <span class="comment"> * \return A pointer to a string contaning the MIME type. The string</span>
|
|
<a name="l00184"></a>00184 <span class="comment"> * may be empty if no MIME type was reported by the web server.</span>
|
|
<a name="l00185"></a>00185 <span class="comment"> */</span>
|
|
<a name="l00186"></a>00186 <span class="keywordtype">char</span> *<a class="code" href="a00163.html#g4433d3af16ea083a81576d0f18ba57c9">webclient_mimetype</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00187"></a>00187 <span class="comment"></span>
|
|
<a name="l00188"></a>00188 <span class="comment">/**</span>
|
|
<a name="l00189"></a>00189 <span class="comment"> * Obtain the filename of the current HTTP data stream.</span>
|
|
<a name="l00190"></a>00190 <span class="comment"> *</span>
|
|
<a name="l00191"></a>00191 <span class="comment"> * The filename of an HTTP request may be changed by the web server,</span>
|
|
<a name="l00192"></a>00192 <span class="comment"> * and may therefore not be the same as when the original GET request</span>
|
|
<a name="l00193"></a>00193 <span class="comment"> * was made with webclient_get(). This function is used for obtaining</span>
|
|
<a name="l00194"></a>00194 <span class="comment"> * the current filename.</span>
|
|
<a name="l00195"></a>00195 <span class="comment"> *</span>
|
|
<a name="l00196"></a>00196 <span class="comment"> * \return A pointer to the current filename.</span>
|
|
<a name="l00197"></a>00197 <span class="comment"> */</span>
|
|
<a name="l00198"></a>00198 <span class="keywordtype">char</span> *<a class="code" href="a00163.html#g41e616d3fcc17e0aabfe8ab45ef0d30f">webclient_filename</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00199"></a>00199 <span class="comment"></span>
|
|
<a name="l00200"></a>00200 <span class="comment">/**</span>
|
|
<a name="l00201"></a>00201 <span class="comment"> * Obtain the hostname of the current HTTP data stream.</span>
|
|
<a name="l00202"></a>00202 <span class="comment"> *</span>
|
|
<a name="l00203"></a>00203 <span class="comment"> * The hostname of the web server of an HTTP request may be changed</span>
|
|
<a name="l00204"></a>00204 <span class="comment"> * by the web server, and may therefore not be the same as when the</span>
|
|
<a name="l00205"></a>00205 <span class="comment"> * original GET request was made with webclient_get(). This function</span>
|
|
<a name="l00206"></a>00206 <span class="comment"> * is used for obtaining the current hostname.</span>
|
|
<a name="l00207"></a>00207 <span class="comment"> *</span>
|
|
<a name="l00208"></a>00208 <span class="comment"> * \return A pointer to the current hostname.</span>
|
|
<a name="l00209"></a>00209 <span class="comment"> */</span>
|
|
<a name="l00210"></a>00210 <span class="keywordtype">char</span> *<a class="code" href="a00163.html#g0e0ea5f24b77f124ba33bcbc7ede5bfb">webclient_hostname</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00211"></a>00211 <span class="comment"></span>
|
|
<a name="l00212"></a>00212 <span class="comment">/**</span>
|
|
<a name="l00213"></a>00213 <span class="comment"> * Obtain the port number of the current HTTP data stream.</span>
|
|
<a name="l00214"></a>00214 <span class="comment"> *</span>
|
|
<a name="l00215"></a>00215 <span class="comment"> * The port number of an HTTP request may be changed by the web</span>
|
|
<a name="l00216"></a>00216 <span class="comment"> * server, and may therefore not be the same as when the original GET</span>
|
|
<a name="l00217"></a>00217 <span class="comment"> * request was made with webclient_get(). This function is used for</span>
|
|
<a name="l00218"></a>00218 <span class="comment"> * obtaining the current port number.</span>
|
|
<a name="l00219"></a>00219 <span class="comment"> *</span>
|
|
<a name="l00220"></a>00220 <span class="comment"> * \return The port number of the current HTTP data stream, in host byte order.</span>
|
|
<a name="l00221"></a>00221 <span class="comment"> */</span>
|
|
<a name="l00222"></a>00222 <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> <a class="code" href="a00163.html#g2a939aa4fcffabbce1dc1f784a7e0ad3">webclient_port</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00223"></a>00223
|
|
<a name="l00224"></a>00224
|
|
<a name="l00225"></a>00225
|
|
<a name="l00226"></a>00226 <span class="preprocessor">#endif </span><span class="comment">/* __WEBCLIENT_H__ */</span>
|
|
<a name="l00227"></a>00227 <span class="comment"></span>
|
|
<a name="l00228"></a>00228 <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
|
|
<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>
|