Lines Matching full:a
10 <li><a href="main.html"><span>Main Page</span></a></li>
11 <li><a href="modules.html"><span>Modules</span></a></li>
12 <li><a href="classes.html"><span>Data Structures</span></a></li>
13 <li id="current"><a href="files.html"><span>Files</span></a></li>
14 <li><a href="examples.html"><span>Examples</span></a></li>
18 <li><a href="files.html"><span>File List</span></a></li>
19 <li><a href="globals.html"><span>Globals</span></a></li>
21 …lient.h</h1><a href="a00111.html">Go to the documentation of this file.</a><div class="fragment"><…
22 <a name="l00002"></a>00002 <span class="comment"> * \addtogroup webclient</span>
23 <a name="l00003"></a>00003 <span class="comment"> * @{</span>
24 <a name="l00004"></a>00004 <span class="comment"> */</span>
25 <a name="l00005"></a>00005 <span class="comment"></span>
26 <a name="l00006"></a>00006 <span class="comment">/**</span>
27 <a name="l00007"></a>00007 <span class="comment"> * \file</span>
28 <a name="l00008"></a>00008 <span class="comment"> * Header file for the HTTP client.</span>
29 <a name="l00009"></a>00009 <span class="comment"> * \author Adam Dunkels <[email protected]></…
30 <a name="l00010"></a>00010 <span class="comment"> */</span>
31 <a name="l00011"></a>00011
32 <a name="l00012"></a>00012 <span class="comment">/*</span>
33 <a name="l00013"></a>00013 <span class="comment"> * Copyright (c) 2002, Adam Dunkels.</span>
34 <a name="l00014"></a>00014 <span class="comment"> * All rights reserved.</span>
35 <a name="l00015"></a>00015 <span class="comment"> *</span>
36 <a name="l00016"></a>00016 <span class="comment"> * Redistribution and use in source and binary for…
37 <a name="l00017"></a>00017 <span class="comment"> * modification, are permitted provided that the f…
38 <a name="l00018"></a>00018 <span class="comment"> * are met:</span>
39 <a name="l00019"></a>00019 <span class="comment"> * 1. Redistributions of source code must retain t…
40 <a name="l00020"></a>00020 <span class="comment"> * notice, this list of conditions and the foll…
41 <a name="l00021"></a>00021 <span class="comment"> * 2. Redistributions in binary form must reproduc…
42 <a name="l00022"></a>00022 <span class="comment"> * copyright notice, this list of conditions an…
43 <a name="l00023"></a>00023 <span class="comment"> * disclaimer in the documentation and/or other…
44 <a name="l00024"></a>00024 <span class="comment"> * with the distribution.</span>
45 <a name="l00025"></a>00025 <span class="comment"> * 3. The name of the author may not be used to en…
46 <a name="l00026"></a>00026 <span class="comment"> * products derived from this software without …
47 <a name="l00027"></a>00027 <span class="comment"> * written permission.</span>
48 <a name="l00028"></a>00028 <span class="comment"> *</span>
49 <a name="l00029"></a>00029 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS…
50 <a name="l00030"></a>00030 <span class="comment"> * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMIT…
51 <a name="l00031"></a>00031 <span class="comment"> * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A…
52 <a name="l00032"></a>00032 <span class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR B…
53 <a name="l00033"></a>00033 <span class="comment"> * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLAR…
54 <a name="l00034"></a>00034 <span class="comment"> * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCURE…
55 <a name="l00035"></a>00035 <span class="comment"> * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFIT…
56 <a name="l00036"></a>00036 <span class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY …
57 <a name="l00037"></a>00037 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT …
58 <a name="l00038"></a>00038 <span class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT…
59 <a name="l00039"></a>00039 <span class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF…
60 <a name="l00040"></a>00040 <span class="comment"> *</span>
61 <a name="l00041"></a>00041 <span class="comment"> * This file is part of the uIP TCP/IP stack.</spa…
62 <a name="l00042"></a>00042 <span class="comment"> *</span>
63 <a name="l00043"></a>00043 <span class="comment"> * $Id: webclient.h,v 1.2 2006/06/11 21:46:37 adam…
64 <a name="l00044"></a>00044 <span class="comment"> *</span>
65 <a name="l00045"></a>00045 <span class="comment"> */</span>
66 <a name="l00046"></a>00046 <span class="preprocessor">#ifndef __WEBCLIENT_H__</span>
67 <a name="l00047"></a>00047 <span class="preprocessor"></span><span class="preprocessor">#define __W…
68 <a name="l00048"></a>00048 <span class="preprocessor"></span>
69 <a name="l00049"></a>00049
70 <a name="l00050"></a>00050 <span class="preprocessor">#include "webclient-strings.h"</span>
71 <a name="l00051"></a>00051 <span class="preprocessor">#include "<a class="code" href="a00140.html">…
72 <a name="l00052"></a>00052
73 <a name="l00053"></a><a class="code" href="a00163.html#g5a5bfd7e9060903893481db90645187b">00053</a>…
74 <a name="l00054"></a>00054 <span class="preprocessor"></span>
75 …a name="l00055"></a><a class="code" href="a00097.html">00055</a> <span class="keyword">struct </sp…
76 …a name="l00056"></a><a class="code" href="a00097.html#5960d82e7aca2986b8509a0d87d6cbc8">00056</a> …
77 …a name="l00057"></a><a class="code" href="a00097.html#8ae6395641b7752dce47881e20cee970">00057</a> …
78 …a name="l00058"></a><a class="code" href="a00097.html#6925d46b2819adb474a5f0036f02dd7d">00058</a> …
79 <a name="l00059"></a>00059
80 …a name="l00060"></a><a class="code" href="a00097.html#7092781c50dcad50f473888585c85b83">00060</a> …
81 …a name="l00061"></a><a class="code" href="a00097.html#a6487b9c1c773b32656065d0e19bf142">00061</a> …
82 …a name="l00062"></a><a class="code" href="a00097.html#e87913860c6b05c6e6b060639b950098">00062</a> …
83 …a name="l00063"></a><a class="code" href="a00097.html#134ec55c3d5abaebfed4ff8edfedf1ea">00063</a> …
84 …a name="l00064"></a><a class="code" href="a00097.html#5a3116623c6a7da7c82db6c301ae0da3">00064</a> …
85 <a name="l00065"></a>00065
86 …a name="l00066"></a><a class="code" href="a00097.html#606d2729bf411ade69044828403a72af">00066</a> …
87 …a name="l00067"></a><a class="code" href="a00097.html#2fca02673894f222b01ad2d3a4d7dd79">00067</a> …
88 <a name="l00068"></a>00068
89 …a name="l00069"></a><a class="code" href="a00097.html#fb60f42593d305ea36d9b4303722696e">00069</a> …
90 <a name="l00070"></a>00070 };
91 <a name="l00071"></a>00071
92 …a name="l00072"></a><a class="code" href="a00163.html#gdc5aec3587b2c55b714a6c2f37b56cba">00072</a>…
93 <a name="l00073"></a><a class="code" href="a00163.html#ge28f6cb60e86088d8886d0f804b4f37c">00073</a>…
94 <a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment"></span>
95 <a name="l00075"></a>00075 <span class="comment">/**</span>
96 <a name="l00076"></a>00076 <span class="comment"> * Callback function that is called from the webcl…
97 <a name="l00077"></a>00077 <span class="comment"> * data has been received.</span>
98 <a name="l00078"></a>00078 <span class="comment"> *</span>
99 <a name="l00079"></a>00079 <span class="comment"> * This function must be implemented by the module…
100 <a name="l00080"></a>00080 <span class="comment"> * webclient code. The function is called from the…
101 <a name="l00081"></a>00081 <span class="comment"> * when HTTP data has been received. The function …
102 <a name="l00082"></a>00082 <span class="comment"> * HTTP headers are received, only for the actual …
103 <a name="l00083"></a>00083 <span class="comment"> *</span>
104 <a name="l00084"></a>00084 <span class="comment"> * \note This function is called many times, repet…
105 <a name="l00085"></a>00085 <span class="comment"> * being received, and not once when all data has …
106 <a name="l00086"></a>00086 <span class="comment"> *</span>
107 <a name="l00087"></a>00087 <span class="comment"> * \param data A pointer to the data that has been…
108 <a name="l00088"></a>00088 <span class="comment"> * \param len The length of the data that has been…
109 <a name="l00089"></a>00089 <span class="comment"> */</span>
110 …a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
111 <a name="l00091"></a>00091 <span class="comment"></span>
112 <a name="l00092"></a>00092 <span class="comment">/**</span>
113 <a name="l00093"></a>00093 <span class="comment"> * Callback function that is called from the webcl…
114 <a name="l00094"></a>00094 <span class="comment"> * HTTP connection has been connected to the web s…
115 <a name="l00095"></a>00095 <span class="comment"> *</span>
116 <a name="l00096"></a>00096 <span class="comment"> * This function must be implemented by the module…
117 <a name="l00097"></a>00097 <span class="comment"> * webclient code.</span>
118 <a name="l00098"></a>00098 <span class="comment"> */</span>
119 …a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
120 <a name="l00100"></a>00100 <span class="comment"></span>
121 <a name="l00101"></a>00101 <span class="comment">/**</span>
122 <a name="l00102"></a>00102 <span class="comment"> * Callback function that is called from the webcl…
123 <a name="l00103"></a>00103 <span class="comment"> * HTTP connection to the web server has timed out…
124 <a name="l00104"></a>00104 <span class="comment"> *</span>
125 <a name="l00105"></a>00105 <span class="comment"> * This function must be implemented by the module…
126 <a name="l00106"></a>00106 <span class="comment"> * webclient code.</span>
127 <a name="l00107"></a>00107 <span class="comment"> */</span>
128 …a name="l00108"></a>00108 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
129 <a name="l00109"></a>00109 <span class="comment"></span>
130 <a name="l00110"></a>00110 <span class="comment">/**</span>
131 <a name="l00111"></a>00111 <span class="comment"> * Callback function that is called from the webcl…
132 <a name="l00112"></a>00112 <span class="comment"> * HTTP connection to the web server has been abor…
133 <a name="l00113"></a>00113 <span class="comment"> * server.</span>
134 <a name="l00114"></a>00114 <span class="comment"> *</span>
135 <a name="l00115"></a>00115 <span class="comment"> * This function must be implemented by the module…
136 <a name="l00116"></a>00116 <span class="comment"> * webclient code.</span>
137 <a name="l00117"></a>00117 <span class="comment"> */</span>
138 …a name="l00118"></a>00118 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
139 <a name="l00119"></a>00119 <span class="comment"></span>
140 <a name="l00120"></a>00120 <span class="comment">/**</span>
141 <a name="l00121"></a>00121 <span class="comment"> * Callback function that is called from the webcl…
142 <a name="l00122"></a>00122 <span class="comment"> * HTTP connection to the web server has been clos…
143 <a name="l00123"></a>00123 <span class="comment"> *</span>
144 <a name="l00124"></a>00124 <span class="comment"> * This function must be implemented by the module…
145 <a name="l00125"></a>00125 <span class="comment"> * webclient code.</span>
146 <a name="l00126"></a>00126 <span class="comment"> */</span>
147 …a name="l00127"></a>00127 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
148 <a name="l00128"></a>00128
149 <a name="l00129"></a>00129
150 <a name="l00130"></a>00130 <span class="comment"></span>
151 <a name="l00131"></a>00131 <span class="comment">/**</span>
152 <a name="l00132"></a>00132 <span class="comment"> * Initialize the webclient module.</span>
153 <a name="l00133"></a>00133 <span class="comment"> */</span>
154 <a name="l00134"></a>00134 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
155 <a name="l00135"></a>00135 <span class="comment"></span>
156 <a name="l00136"></a>00136 <span class="comment">/**</span>
157 <a name="l00137"></a>00137 <span class="comment"> * Open an HTTP connection to a web server and ask…
158 <a name="l00138"></a>00138 <span class="comment"> * the GET method.</span>
159 <a name="l00139"></a>00139 <span class="comment"> *</span>
160 <a name="l00140"></a>00140 <span class="comment"> * This function opens an HTTP connection to the s…
161 <a name="l00141"></a>00141 <span class="comment"> * and requests the specified file using the GET m…
162 <a name="l00142"></a>00142 <span class="comment"> * connection has been connected, the webclient_co…
163 <a name="l00143"></a>00143 <span class="comment"> * function is called and when the HTTP data arriv…
164 <a name="l00144"></a>00144 <span class="comment"> * webclient_datahandler() callback function is ca…
165 <a name="l00145"></a>00145 <span class="comment"> *</span>
166 <a name="l00146"></a>00146 <span class="comment"> * The callback function webclient_timedout() is c…
167 <a name="l00147"></a>00147 <span class="comment"> * server could not be contacted, and the webclien…
168 <a name="l00148"></a>00148 <span class="comment"> * function is called if the HTTP connection is ab…
169 <a name="l00149"></a>00149 <span class="comment"> * server.</span>
170 <a name="l00150"></a>00150 <span class="comment"> *</span>
171 <a name="l00151"></a>00151 <span class="comment"> * When the HTTP request has been completed and th…
172 <a name="l00152"></a>00152 <span class="comment"> * closed, the webclient_closed() callback functio…
173 <a name="l00153"></a>00153 <span class="comment"> *</span>
174 <a name="l00154"></a>00154 <span class="comment"> * \note If the function is passed a host name, it…
175 <a name="l00155"></a>00155 <span class="comment"> * the resolver cache in order for the function to…
176 <a name="l00156"></a>00156 <span class="comment"> * server. It is therefore up to the calling modul…
177 <a name="l00157"></a>00157 <span class="comment"> * resolver calls and the signal handler used for …
178 <a name="l00158"></a>00158 <span class="comment"> * query answer.</span>
179 <a name="l00159"></a>00159 <span class="comment"> *</span>
180 <a name="l00160"></a>00160 <span class="comment"> * \param host A pointer to a string containing ei…
181 <a name="l00161"></a>00161 <span class="comment"> * a numerical IP address in dotted decimal notati…
182 <a name="l00162"></a>00162 <span class="comment"> *</span>
183 <a name="l00163"></a>00163 <span class="comment"> * \param port The port number to which to connect…
184 <a name="l00164"></a>00164 <span class="comment"> *</span>
185 <a name="l00165"></a>00165 <span class="comment"> * \param file A pointer to the name of the file t…
186 <a name="l00166"></a>00166 <span class="comment"> *</span>
187 <a name="l00167"></a>00167 <span class="comment"> * \retval 0 if the host name could not be found i…
188 <a name="l00168"></a>00168 <span class="comment"> * if a TCP connection could not be created.</span>
189 <a name="l00169"></a>00169 <span class="comment"> *</span>
190 <a name="l00170"></a>00170 <span class="comment"> * \retval 1 if the connection was initiated.</spa…
191 <a name="l00171"></a>00171 <span class="comment"> */</span>
192 …a name="l00172"></a>00172 <span class="keywordtype">unsigned</span> <span class="keywordtype">char…
193 <a name="l00173"></a>00173 <span class="comment"></span>
194 <a name="l00174"></a>00174 <span class="comment">/**</span>
195 <a name="l00175"></a>00175 <span class="comment"> * Close the currently open HTTP connection.</span>
196 <a name="l00176"></a>00176 <span class="comment"> */</span>
197 <a name="l00177"></a>00177 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
198 …a name="l00178"></a>00178 <span class="keywordtype">void</span> <a class="code" href="a00163.html#…
199 <a name="l00179"></a>00179 <span class="comment"></span>
200 <a name="l00180"></a>00180 <span class="comment">/**</span>
201 <a name="l00181"></a>00181 <span class="comment"> * Obtain the MIME type of the current HTTP data s…
202 <a name="l00182"></a>00182 <span class="comment"> *</span>
203 <a name="l00183"></a>00183 <span class="comment"> * \return A pointer to a string contaning the MIM…
204 <a name="l00184"></a>00184 <span class="comment"> * may be empty if no MIME type was reported by th…
205 <a name="l00185"></a>00185 <span class="comment"> */</span>
206 …a name="l00186"></a>00186 <span class="keywordtype">char</span> *<a class="code" href="a00163.html…
207 <a name="l00187"></a>00187 <span class="comment"></span>
208 <a name="l00188"></a>00188 <span class="comment">/**</span>
209 <a name="l00189"></a>00189 <span class="comment"> * Obtain the filename of the current HTTP data st…
210 <a name="l00190"></a>00190 <span class="comment"> *</span>
211 <a name="l00191"></a>00191 <span class="comment"> * The filename of an HTTP request may be changed …
212 <a name="l00192"></a>00192 <span class="comment"> * and may therefore not be the same as when the o…
213 <a name="l00193"></a>00193 <span class="comment"> * was made with webclient_get(). This function is…
214 <a name="l00194"></a>00194 <span class="comment"> * the current filename.</span>
215 <a name="l00195"></a>00195 <span class="comment"> *</span>
216 <a name="l00196"></a>00196 <span class="comment"> * \return A pointer to the current filename.</spa…
217 <a name="l00197"></a>00197 <span class="comment"> */</span>
218 …a name="l00198"></a>00198 <span class="keywordtype">char</span> *<a class="code" href="a00163.html…
219 <a name="l00199"></a>00199 <span class="comment"></span>
220 <a name="l00200"></a>00200 <span class="comment">/**</span>
221 <a name="l00201"></a>00201 <span class="comment"> * Obtain the hostname of the current HTTP data st…
222 <a name="l00202"></a>00202 <span class="comment"> *</span>
223 <a name="l00203"></a>00203 <span class="comment"> * The hostname of the web server of an HTTP reque…
224 <a name="l00204"></a>00204 <span class="comment"> * by the web server, and may therefore not be the…
225 <a name="l00205"></a>00205 <span class="comment"> * original GET request was made with webclient_ge…
226 <a name="l00206"></a>00206 <span class="comment"> * is used for obtaining the current hostname.</sp…
227 <a name="l00207"></a>00207 <span class="comment"> *</span>
228 <a name="l00208"></a>00208 <span class="comment"> * \return A pointer to the current hostname.</spa…
229 <a name="l00209"></a>00209 <span class="comment"> */</span>
230 …a name="l00210"></a>00210 <span class="keywordtype">char</span> *<a class="code" href="a00163.html…
231 <a name="l00211"></a>00211 <span class="comment"></span>
232 <a name="l00212"></a>00212 <span class="comment">/**</span>
233 <a name="l00213"></a>00213 <span class="comment"> * Obtain the port number of the current HTTP data…
234 <a name="l00214"></a>00214 <span class="comment"> *</span>
235 <a name="l00215"></a>00215 <span class="comment"> * The port number of an HTTP request may be chang…
236 <a name="l00216"></a>00216 <span class="comment"> * server, and may therefore not be the same as wh…
237 <a name="l00217"></a>00217 <span class="comment"> * request was made with webclient_get(). This fun…
238 <a name="l00218"></a>00218 <span class="comment"> * obtaining the current port number.</span>
239 <a name="l00219"></a>00219 <span class="comment"> *</span>
240 <a name="l00220"></a>00220 <span class="comment"> * \return The port number of the current HTTP dat…
241 <a name="l00221"></a>00221 <span class="comment"> */</span>
242 …a name="l00222"></a>00222 <span class="keywordtype">unsigned</span> <span class="keywordtype">shor…
243 <a name="l00223"></a>00223
244 <a name="l00224"></a>00224
245 <a name="l00225"></a>00225
246 <a name="l00226"></a>00226 <span class="preprocessor">#endif </span><span class="comment">/* __WEBC…
247 <a name="l00227"></a>00227 <span class="comment"></span>
248 <a name="l00228"></a>00228 <span class="comment">/** @} */</span>
250 <a href="http://www.doxygen.org/index.html">
251 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>