1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3<title>uIP 1.0: Web client</title> 4<link href="doxygen.css" rel="stylesheet" type="text/css"> 5<link href="tabs.css" rel="stylesheet" type="text/css"> 6</head><body> 7<!-- Generated by Doxygen 1.4.6 --> 8<div class="tabs"> 9 <ul> 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><a href="files.html"><span>Files</span></a></li> 14 <li><a href="examples.html"><span>Examples</span></a></li> 15 </ul></div> 16<h1>Web client<br> 17<small> 18[<a class="el" href="a00143.html">Applications</a>]</small> 19</h1><hr><a name="_details"></a><h2>Detailed Description</h2> 20This example shows a HTTP client that is able to download web pages and files from web servers. 21<p> 22It requires a number of callback functions to be implemented by the module that utilizes the code: <a class="el" href="a00163.html#gc4b119801e50cc1824498a1cdf9adc37">webclient_datahandler()</a>, <a class="el" href="a00163.html#g6b942c1ef22f8cd1a726ef3364c9fbea">webclient_connected()</a>, <a class="el" href="a00163.html#g23705efb9077187881f094fc9be13bde">webclient_timedout()</a>, <a class="el" href="a00163.html#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7">webclient_aborted()</a>, <a class="el" href="a00163.html#gf8f12c820cc08da32aa62898bfc02db3">webclient_closed()</a>. 23<p> 24<table border="0" cellpadding="0" cellspacing="0"> 25<tr><td></td></tr> 26<tr><td colspan="2"><br><h2>Files</h2></td></tr> 27<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00111.html">webclient.h</a></td></tr> 28 29<tr><td class="mdescLeft"> </td><td class="mdescRight">Header file for the HTTP client. <br></td></tr> 30 31<p> 32<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="a00110.html">webclient.c</a></td></tr> 33 34<tr><td class="mdescLeft"> </td><td class="mdescRight">Implementation of the HTTP client. <br></td></tr> 35 36<p> 37<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr> 38<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="a00097.html">webclient_state</a></td></tr> 39 40<tr><td colspan="2"><br><h2>Defines</h2></td></tr> 41<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a5bfd7e9060903893481db90645187b"></a><!-- doxytag: member="webclient::WEBCLIENT_CONF_MAX_URLLEN" ref="g5a5bfd7e9060903893481db90645187b" args="" --> 42#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g5a5bfd7e9060903893481db90645187b">WEBCLIENT_CONF_MAX_URLLEN</a> 100</td></tr> 43 44<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge28f6cb60e86088d8886d0f804b4f37c"></a><!-- doxytag: member="webclient::UIP_APPCALL" ref="ge28f6cb60e86088d8886d0f804b4f37c" args="" --> 45#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#ge28f6cb60e86088d8886d0f804b4f37c">UIP_APPCALL</a> webclient_appcall</td></tr> 46 47<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g31be289fd8ec3fe09b0088165d13976d"></a><!-- doxytag: member="webclient::WEBCLIENT_TIMEOUT" ref="g31be289fd8ec3fe09b0088165d13976d" args="" --> 48#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g31be289fd8ec3fe09b0088165d13976d">WEBCLIENT_TIMEOUT</a> 100</td></tr> 49 50<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g8714af98a550f10dc814db92b08d1b0d"></a><!-- doxytag: member="webclient::WEBCLIENT_STATE_STATUSLINE" ref="g8714af98a550f10dc814db92b08d1b0d" args="" --> 51#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g8714af98a550f10dc814db92b08d1b0d">WEBCLIENT_STATE_STATUSLINE</a> 0</td></tr> 52 53<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gc4357cec23abca29d2bb885803625a6a"></a><!-- doxytag: member="webclient::WEBCLIENT_STATE_HEADERS" ref="gc4357cec23abca29d2bb885803625a6a" args="" --> 54#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gc4357cec23abca29d2bb885803625a6a">WEBCLIENT_STATE_HEADERS</a> 1</td></tr> 55 56<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g4d457c50e6f2cef57167c3804ce8bf7c"></a><!-- doxytag: member="webclient::WEBCLIENT_STATE_DATA" ref="g4d457c50e6f2cef57167c3804ce8bf7c" args="" --> 57#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g4d457c50e6f2cef57167c3804ce8bf7c">WEBCLIENT_STATE_DATA</a> 2</td></tr> 58 59<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g863c94b0ed4a76997e53a3ccd5d0b6c3"></a><!-- doxytag: member="webclient::WEBCLIENT_STATE_CLOSE" ref="g863c94b0ed4a76997e53a3ccd5d0b6c3" args="" --> 60#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g863c94b0ed4a76997e53a3ccd5d0b6c3">WEBCLIENT_STATE_CLOSE</a> 3</td></tr> 61 62<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g40fb1fb2d990ce04ae9bbee275627c03"></a><!-- doxytag: member="webclient::HTTPFLAG_NONE" ref="g40fb1fb2d990ce04ae9bbee275627c03" args="" --> 63#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g40fb1fb2d990ce04ae9bbee275627c03">HTTPFLAG_NONE</a> 0</td></tr> 64 65<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gda99954e0f6905091885934e86c278cc"></a><!-- doxytag: member="webclient::HTTPFLAG_OK" ref="gda99954e0f6905091885934e86c278cc" args="" --> 66#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gda99954e0f6905091885934e86c278cc">HTTPFLAG_OK</a> 1</td></tr> 67 68<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gd895686859ae7d178d31be04eb0a1a97"></a><!-- doxytag: member="webclient::HTTPFLAG_MOVED" ref="gd895686859ae7d178d31be04eb0a1a97" args="" --> 69#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gd895686859ae7d178d31be04eb0a1a97">HTTPFLAG_MOVED</a> 2</td></tr> 70 71<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g38af81a4c9884ce89803fc3e52383112"></a><!-- doxytag: member="webclient::HTTPFLAG_ERROR" ref="g38af81a4c9884ce89803fc3e52383112" args="" --> 72#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g38af81a4c9884ce89803fc3e52383112">HTTPFLAG_ERROR</a> 3</td></tr> 73 74<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3212e70c55244608ac16316888c354f0"></a><!-- doxytag: member="webclient::ISO_nl" ref="g3212e70c55244608ac16316888c354f0" args="" --> 75#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g3212e70c55244608ac16316888c354f0">ISO_nl</a> 0x0a</td></tr> 76 77<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6cda47c85ce1b58b501b44ac9cccc50e"></a><!-- doxytag: member="webclient::ISO_cr" ref="g6cda47c85ce1b58b501b44ac9cccc50e" args="" --> 78#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g6cda47c85ce1b58b501b44ac9cccc50e">ISO_cr</a> 0x0d</td></tr> 79 80<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g71e1b022f7b7fa3a154f19372b239935"></a><!-- doxytag: member="webclient::ISO_space" ref="g71e1b022f7b7fa3a154f19372b239935" args="" --> 81#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g71e1b022f7b7fa3a154f19372b239935">ISO_space</a> 0x20</td></tr> 82 83<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> 84<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc5aec3587b2c55b714a6c2f37b56cba"></a><!-- doxytag: member="webclient::uip_tcp_appstate_t" ref="gdc5aec3587b2c55b714a6c2f37b56cba" args="" --> 85typedef <a class="el" href="a00097.html">webclient_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gdc5aec3587b2c55b714a6c2f37b56cba">uip_tcp_appstate_t</a></td></tr> 86 87<tr><td colspan="2"><br><h2>Functions</h2></td></tr> 88<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gc4b119801e50cc1824498a1cdf9adc37">webclient_datahandler</a> (char *data, <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> len)</td></tr> 89 90<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called from the webclient code when HTTP data has been received. <a href="#gc4b119801e50cc1824498a1cdf9adc37"></a><br></td></tr> 91<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g6b942c1ef22f8cd1a726ef3364c9fbea">webclient_connected</a> (void)</td></tr> 92 93<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called from the webclient code when the HTTP connection has been connected to the web server. <a href="#g6b942c1ef22f8cd1a726ef3364c9fbea"></a><br></td></tr> 94<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g23705efb9077187881f094fc9be13bde">webclient_timedout</a> (void)</td></tr> 95 96<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called from the webclient code if the HTTP connection to the web server has timed out. <a href="#g23705efb9077187881f094fc9be13bde"></a><br></td></tr> 97<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7">webclient_aborted</a> (void)</td></tr> 98 99<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called from the webclient code if the HTTP connection to the web server has been aborted by the web server. <a href="#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7"></a><br></td></tr> 100<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gf8f12c820cc08da32aa62898bfc02db3">webclient_closed</a> (void)</td></tr> 101 102<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function that is called from the webclient code when the HTTP connection to the web server has been closed. <a href="#gf8f12c820cc08da32aa62898bfc02db3"></a><br></td></tr> 103<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3caacabb2fe1c71921e1a471719ccbd2"></a><!-- doxytag: member="webclient::webclient_init" ref="g3caacabb2fe1c71921e1a471719ccbd2" args="(void)" --> 104void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g3caacabb2fe1c71921e1a471719ccbd2">webclient_init</a> (void)</td></tr> 105 106<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the webclient module. <br></td></tr> 107<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3">webclient_get</a> (char *host, <a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> port, char *file)</td></tr> 108 109<tr><td class="mdescLeft"> </td><td class="mdescRight">Open an HTTP connection to a web server and ask for a file using the GET method. <a href="#gf9385ef9ecc74c7d53ff2f15e62bfde3"></a><br></td></tr> 110<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1d34be506a61db90dd7829117efdf8cf"></a><!-- doxytag: member="webclient::webclient_close" ref="g1d34be506a61db90dd7829117efdf8cf" args="(void)" --> 111void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g1d34be506a61db90dd7829117efdf8cf">webclient_close</a> (void)</td></tr> 112 113<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the currently open HTTP connection. <br></td></tr> 114<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9e6d2864f390a4ba1ac60dc65e2b9815"></a><!-- doxytag: member="webclient::webclient_appcall" ref="g9e6d2864f390a4ba1ac60dc65e2b9815" args="(void)" --> 115void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g9e6d2864f390a4ba1ac60dc65e2b9815">webclient_appcall</a> (void)</td></tr> 116 117<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g4433d3af16ea083a81576d0f18ba57c9">webclient_mimetype</a> (void)</td></tr> 118 119<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the MIME type of the current HTTP data stream. <a href="#g4433d3af16ea083a81576d0f18ba57c9"></a><br></td></tr> 120<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g41e616d3fcc17e0aabfe8ab45ef0d30f">webclient_filename</a> (void)</td></tr> 121 122<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the filename of the current HTTP data stream. <a href="#g41e616d3fcc17e0aabfe8ab45ef0d30f"></a><br></td></tr> 123<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g0e0ea5f24b77f124ba33bcbc7ede5bfb">webclient_hostname</a> (void)</td></tr> 124 125<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the hostname of the current HTTP data stream. <a href="#g0e0ea5f24b77f124ba33bcbc7ede5bfb"></a><br></td></tr> 126<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned short </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g2a939aa4fcffabbce1dc1f784a7e0ad3">webclient_port</a> (void)</td></tr> 127 128<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the port number of the current HTTP data stream. <a href="#g2a939aa4fcffabbce1dc1f784a7e0ad3"></a><br></td></tr> 129</table> 130<hr><h2>Function Documentation</h2> 131<a class="anchor" name="gf11d9915ec12a8cdd9fdcbb5e8fcd5c7"></a><!-- doxytag: member="webclient.h::webclient_aborted" ref="gf11d9915ec12a8cdd9fdcbb5e8fcd5c7" args="(void)" --><p> 132<table class="mdTable" cellpadding="2" cellspacing="0"> 133 <tr> 134 <td class="mdRow"> 135 <table cellpadding="0" cellspacing="0" border="0"> 136 <tr> 137 <td class="md" nowrap valign="top">void webclient_aborted </td> 138 <td class="md" valign="top">( </td> 139 <td class="md" nowrap valign="top">void </td> 140 <td class="mdname1" valign="top" nowrap> </td> 141 <td class="md" valign="top"> ) </td> 142 <td class="md" nowrap></td> 143 </tr> 144 </table> 145 </td> 146 </tr> 147</table> 148<table cellspacing="5" cellpadding="0" border="0"> 149 <tr> 150 <td> 151 152 </td> 153 <td> 154 155<p> 156Callback function that is called from the webclient code if the HTTP connection to the web server has been aborted by the web server. 157<p> 158This function must be implemented by the module that uses the webclient code. <dl compact><dt><b>Examples: </b></dt><dd> 159<a class="el" href="a00040.html#a286">webclient.c</a>, and <a class="el" href="a00041.html#a321">webclient.h</a>.</dl> 160<p> 161Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 162 </tr> 163</table> 164<a class="anchor" name="gf8f12c820cc08da32aa62898bfc02db3"></a><!-- doxytag: member="webclient.h::webclient_closed" ref="gf8f12c820cc08da32aa62898bfc02db3" args="(void)" --><p> 165<table class="mdTable" cellpadding="2" cellspacing="0"> 166 <tr> 167 <td class="mdRow"> 168 <table cellpadding="0" cellspacing="0" border="0"> 169 <tr> 170 <td class="md" nowrap valign="top">void webclient_closed </td> 171 <td class="md" valign="top">( </td> 172 <td class="md" nowrap valign="top">void </td> 173 <td class="mdname1" valign="top" nowrap> </td> 174 <td class="md" valign="top"> ) </td> 175 <td class="md" nowrap></td> 176 </tr> 177 </table> 178 </td> 179 </tr> 180</table> 181<table cellspacing="5" cellpadding="0" border="0"> 182 <tr> 183 <td> 184 185 </td> 186 <td> 187 188<p> 189Callback function that is called from the webclient code when the HTTP connection to the web server has been closed. 190<p> 191This function must be implemented by the module that uses the webclient code. <dl compact><dt><b>Examples: </b></dt><dd> 192<a class="el" href="a00040.html#a296">webclient.c</a>, and <a class="el" href="a00041.html#a322">webclient.h</a>.</dl> 193<p> 194Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 195 </tr> 196</table> 197<a class="anchor" name="g6b942c1ef22f8cd1a726ef3364c9fbea"></a><!-- doxytag: member="webclient.h::webclient_connected" ref="g6b942c1ef22f8cd1a726ef3364c9fbea" args="(void)" --><p> 198<table class="mdTable" cellpadding="2" cellspacing="0"> 199 <tr> 200 <td class="mdRow"> 201 <table cellpadding="0" cellspacing="0" border="0"> 202 <tr> 203 <td class="md" nowrap valign="top">void webclient_connected </td> 204 <td class="md" valign="top">( </td> 205 <td class="md" nowrap valign="top">void </td> 206 <td class="mdname1" valign="top" nowrap> </td> 207 <td class="md" valign="top"> ) </td> 208 <td class="md" nowrap></td> 209 </tr> 210 </table> 211 </td> 212 </tr> 213</table> 214<table cellspacing="5" cellpadding="0" border="0"> 215 <tr> 216 <td> 217 218 </td> 219 <td> 220 221<p> 222Callback function that is called from the webclient code when the HTTP connection has been connected to the web server. 223<p> 224This function must be implemented by the module that uses the webclient code. <dl compact><dt><b>Examples: </b></dt><dd> 225<a class="el" href="a00040.html#a295">webclient.c</a>, and <a class="el" href="a00041.html#a319">webclient.h</a>.</dl> 226<p> 227Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 228 </tr> 229</table> 230<a class="anchor" name="gc4b119801e50cc1824498a1cdf9adc37"></a><!-- doxytag: member="webclient.h::webclient_datahandler" ref="gc4b119801e50cc1824498a1cdf9adc37" args="(char *data, u16_t len)" --><p> 231<table class="mdTable" cellpadding="2" cellspacing="0"> 232 <tr> 233 <td class="mdRow"> 234 <table cellpadding="0" cellspacing="0" border="0"> 235 <tr> 236 <td class="md" nowrap valign="top">void webclient_datahandler </td> 237 <td class="md" valign="top">( </td> 238 <td class="md" nowrap valign="top">char * </td> 239 <td class="mdname" nowrap> <em>data</em>, </td> 240 </tr> 241 <tr> 242 <td class="md" nowrap align="right"></td> 243 <td class="md"></td> 244 <td class="md" nowrap><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 245 <td class="mdname" nowrap> <em>len</em></td> 246 </tr> 247 <tr> 248 <td class="md"></td> 249 <td class="md">) </td> 250 <td class="md" colspan="2"></td> 251 </tr> 252 </table> 253 </td> 254 </tr> 255</table> 256<table cellspacing="5" cellpadding="0" border="0"> 257 <tr> 258 <td> 259 260 </td> 261 <td> 262 263<p> 264Callback function that is called from the webclient code when HTTP data has been received. 265<p> 266This function must be implemented by the module that uses the webclient code. The function is called from the webclient module when HTTP data has been received. The function is not called when HTTP headers are received, only for the actual data.<p> 267<dl compact><dt><b>Note:</b></dt><dd>This function is called many times, repetedly, when data is being received, and not once when all data has been received.</dd></dl> 268<dl compact><dt><b>Parameters:</b></dt><dd> 269 <table border="0" cellspacing="2" cellpadding="0"> 270 <tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>A pointer to the data that has been received. </td></tr> 271 <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The length of the data that has been received. </td></tr> 272 </table> 273</dl> 274<dl compact><dt><b>Examples: </b></dt><dd> 275<a class="el" href="a00040.html#a291">webclient.c</a>, and <a class="el" href="a00041.html#a318">webclient.h</a>.</dl> 276<p> 277Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 278 </tr> 279</table> 280<a class="anchor" name="g41e616d3fcc17e0aabfe8ab45ef0d30f"></a><!-- doxytag: member="webclient.h::webclient_filename" ref="g41e616d3fcc17e0aabfe8ab45ef0d30f" args="(void)" --><p> 281<table class="mdTable" cellpadding="2" cellspacing="0"> 282 <tr> 283 <td class="mdRow"> 284 <table cellpadding="0" cellspacing="0" border="0"> 285 <tr> 286 <td class="md" nowrap valign="top">char * webclient_filename </td> 287 <td class="md" valign="top">( </td> 288 <td class="md" nowrap valign="top">void </td> 289 <td class="mdname1" valign="top" nowrap> </td> 290 <td class="md" valign="top"> ) </td> 291 <td class="md" nowrap></td> 292 </tr> 293 </table> 294 </td> 295 </tr> 296</table> 297<table cellspacing="5" cellpadding="0" border="0"> 298 <tr> 299 <td> 300 301 </td> 302 <td> 303 304<p> 305Obtain the filename of the current HTTP data stream. 306<p> 307The filename of an HTTP request may be changed by the web server, and may therefore not be the same as when the original GET request was made with <a class="el" href="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3">webclient_get()</a>. This function is used for obtaining the current filename.<p> 308<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the current filename. </dd></dl> 309<dl compact><dt><b>Examples: </b></dt><dd> 310<a class="el" href="a00040.html#a254">webclient.c</a>, and <a class="el" href="a00041.html#a328">webclient.h</a>.</dl> 311<p> 312Definition at line <a class="el" href="a00180.html#l00093">93</a> of file <a class="el" href="a00180.html">webclient.c</a>. 313<p> 314References <a class="el" href="a00181.html#l00062">webclient_state::file</a>. </td> 315 </tr> 316</table> 317<a class="anchor" name="gf9385ef9ecc74c7d53ff2f15e62bfde3"></a><!-- doxytag: member="webclient.h::webclient_get" ref="gf9385ef9ecc74c7d53ff2f15e62bfde3" args="(char *host, u16_t port, char *file)" --><p> 318<table class="mdTable" cellpadding="2" cellspacing="0"> 319 <tr> 320 <td class="mdRow"> 321 <table cellpadding="0" cellspacing="0" border="0"> 322 <tr> 323 <td class="md" nowrap valign="top">unsigned char webclient_get </td> 324 <td class="md" valign="top">( </td> 325 <td class="md" nowrap valign="top">char * </td> 326 <td class="mdname" nowrap> <em>host</em>, </td> 327 </tr> 328 <tr> 329 <td class="md" nowrap align="right"></td> 330 <td class="md"></td> 331 <td class="md" nowrap><a class="el" href="a00153.html#g77570ac4fcab86864fa1916e55676da2">u16_t</a> </td> 332 <td class="mdname" nowrap> <em>port</em>, </td> 333 </tr> 334 <tr> 335 <td class="md" nowrap align="right"></td> 336 <td class="md"></td> 337 <td class="md" nowrap>char * </td> 338 <td class="mdname" nowrap> <em>file</em></td> 339 </tr> 340 <tr> 341 <td class="md"></td> 342 <td class="md">) </td> 343 <td class="md" colspan="2"></td> 344 </tr> 345 </table> 346 </td> 347 </tr> 348</table> 349<table cellspacing="5" cellpadding="0" border="0"> 350 <tr> 351 <td> 352 353 </td> 354 <td> 355 356<p> 357Open an HTTP connection to a web server and ask for a file using the GET method. 358<p> 359This function opens an HTTP connection to the specified web server and requests the specified file using the GET method. When the HTTP connection has been connected, the <a class="el" href="a00163.html#g6b942c1ef22f8cd1a726ef3364c9fbea">webclient_connected()</a> callback function is called and when the HTTP data arrives the <a class="el" href="a00163.html#gc4b119801e50cc1824498a1cdf9adc37">webclient_datahandler()</a> callback function is called.<p> 360The callback function <a class="el" href="a00163.html#g23705efb9077187881f094fc9be13bde">webclient_timedout()</a> is called if the web server could not be contacted, and the <a class="el" href="a00163.html#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7">webclient_aborted()</a> callback function is called if the HTTP connection is aborted by the web server.<p> 361When the HTTP request has been completed and the HTTP connection is closed, the <a class="el" href="a00163.html#gf8f12c820cc08da32aa62898bfc02db3">webclient_closed()</a> callback function will be called.<p> 362<dl compact><dt><b>Note:</b></dt><dd>If the function is passed a host name, it must already be in the resolver cache in order for the function to connect to the web server. It is therefore up to the calling module to implement the resolver calls and the signal handler used for reporting a resolv query answer.</dd></dl> 363<dl compact><dt><b>Parameters:</b></dt><dd> 364 <table border="0" cellspacing="2" cellpadding="0"> 365 <tr><td valign="top"></td><td valign="top"><em>host</em> </td><td>A pointer to a string containing either a host name or a numerical IP address in dotted decimal notation (e.g., 192.168.23.1).</td></tr> 366 <tr><td valign="top"></td><td valign="top"><em>port</em> </td><td>The port number to which to connect, in host byte order.</td></tr> 367 <tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>A pointer to the name of the file to get.</td></tr> 368 </table> 369</dl> 370<dl compact><dt><b>Return values:</b></dt><dd> 371 <table border="0" cellspacing="2" cellpadding="0"> 372 <tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>if the host name could not be found in the cache, or if a TCP connection could not be created.</td></tr> 373 <tr><td valign="top"></td><td valign="top"><em>1</em> </td><td>if the connection was initiated. </td></tr> 374 </table> 375</dl> 376<dl compact><dt><b>Examples: </b></dt><dd> 377<a class="el" href="a00040.html#a268">webclient.c</a>, and <a class="el" href="a00041.html#a324">webclient.h</a>.</dl> 378<p> 379Definition at line <a class="el" href="a00180.html#l00140">140</a> of file <a class="el" href="a00180.html">webclient.c</a>. 380<p> 381References <a class="el" href="a00181.html#l00062">webclient_state::file</a>, <a class="el" href="a00181.html#l00061">webclient_state::host</a>, <a class="el" href="a00201.html#l01882">htons()</a>, <a class="el" href="a00172.html#l00069">NULL</a>, <a class="el" href="a00181.html#l00060">webclient_state::port</a>, <a class="el" href="a00172.html#l00396">resolv_lookup()</a>, and <a class="el" href="a00201.html#l00407">uip_connect()</a>. 382<p> 383Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 384 </tr> 385</table> 386<a class="anchor" name="g0e0ea5f24b77f124ba33bcbc7ede5bfb"></a><!-- doxytag: member="webclient.h::webclient_hostname" ref="g0e0ea5f24b77f124ba33bcbc7ede5bfb" args="(void)" --><p> 387<table class="mdTable" cellpadding="2" cellspacing="0"> 388 <tr> 389 <td class="mdRow"> 390 <table cellpadding="0" cellspacing="0" border="0"> 391 <tr> 392 <td class="md" nowrap valign="top">char * webclient_hostname </td> 393 <td class="md" valign="top">( </td> 394 <td class="md" nowrap valign="top">void </td> 395 <td class="mdname1" valign="top" nowrap> </td> 396 <td class="md" valign="top"> ) </td> 397 <td class="md" nowrap></td> 398 </tr> 399 </table> 400 </td> 401 </tr> 402</table> 403<table cellspacing="5" cellpadding="0" border="0"> 404 <tr> 405 <td> 406 407 </td> 408 <td> 409 410<p> 411Obtain the hostname of the current HTTP data stream. 412<p> 413The hostname of the web server of an HTTP request may be changed by the web server, and may therefore not be the same as when the original GET request was made with <a class="el" href="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3">webclient_get()</a>. This function is used for obtaining the current hostname.<p> 414<dl compact><dt><b>Returns:</b></dt><dd>A pointer to the current hostname. </dd></dl> 415<dl compact><dt><b>Examples: </b></dt><dd> 416<a class="el" href="a00040.html#a256">webclient.c</a>, and <a class="el" href="a00041.html#a329">webclient.h</a>.</dl> 417<p> 418Definition at line <a class="el" href="a00180.html#l00099">99</a> of file <a class="el" href="a00180.html">webclient.c</a>. 419<p> 420References <a class="el" href="a00181.html#l00061">webclient_state::host</a>. </td> 421 </tr> 422</table> 423<a class="anchor" name="g4433d3af16ea083a81576d0f18ba57c9"></a><!-- doxytag: member="webclient.h::webclient_mimetype" ref="g4433d3af16ea083a81576d0f18ba57c9" args="(void)" --><p> 424<table class="mdTable" cellpadding="2" cellspacing="0"> 425 <tr> 426 <td class="mdRow"> 427 <table cellpadding="0" cellspacing="0" border="0"> 428 <tr> 429 <td class="md" nowrap valign="top">char * webclient_mimetype </td> 430 <td class="md" valign="top">( </td> 431 <td class="md" nowrap valign="top">void </td> 432 <td class="mdname1" valign="top" nowrap> </td> 433 <td class="md" valign="top"> ) </td> 434 <td class="md" nowrap></td> 435 </tr> 436 </table> 437 </td> 438 </tr> 439</table> 440<table cellspacing="5" cellpadding="0" border="0"> 441 <tr> 442 <td> 443 444 </td> 445 <td> 446 447<p> 448Obtain the MIME type of the current HTTP data stream. 449<p> 450<dl compact><dt><b>Returns:</b></dt><dd>A pointer to a string contaning the MIME type. The string may be empty if no MIME type was reported by the web server. </dd></dl> 451<dl compact><dt><b>Examples: </b></dt><dd> 452<a class="el" href="a00040.html#a252">webclient.c</a>, and <a class="el" href="a00041.html#a327">webclient.h</a>.</dl> 453<p> 454Definition at line <a class="el" href="a00180.html#l00087">87</a> of file <a class="el" href="a00180.html">webclient.c</a>. 455<p> 456References <a class="el" href="a00181.html#l00069">webclient_state::mimetype</a>. </td> 457 </tr> 458</table> 459<a class="anchor" name="g2a939aa4fcffabbce1dc1f784a7e0ad3"></a><!-- doxytag: member="webclient.h::webclient_port" ref="g2a939aa4fcffabbce1dc1f784a7e0ad3" args="(void)" --><p> 460<table class="mdTable" cellpadding="2" cellspacing="0"> 461 <tr> 462 <td class="mdRow"> 463 <table cellpadding="0" cellspacing="0" border="0"> 464 <tr> 465 <td class="md" nowrap valign="top">unsigned short webclient_port </td> 466 <td class="md" valign="top">( </td> 467 <td class="md" nowrap valign="top">void </td> 468 <td class="mdname1" valign="top" nowrap> </td> 469 <td class="md" valign="top"> ) </td> 470 <td class="md" nowrap></td> 471 </tr> 472 </table> 473 </td> 474 </tr> 475</table> 476<table cellspacing="5" cellpadding="0" border="0"> 477 <tr> 478 <td> 479 480 </td> 481 <td> 482 483<p> 484Obtain the port number of the current HTTP data stream. 485<p> 486The port number of an HTTP request may be changed by the web server, and may therefore not be the same as when the original GET request was made with <a class="el" href="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3">webclient_get()</a>. This function is used for obtaining the current port number.<p> 487<dl compact><dt><b>Returns:</b></dt><dd>The port number of the current HTTP data stream, in host byte order. </dd></dl> 488<dl compact><dt><b>Examples: </b></dt><dd> 489<a class="el" href="a00040.html#a258">webclient.c</a>, and <a class="el" href="a00041.html#a330">webclient.h</a>.</dl> 490<p> 491Definition at line <a class="el" href="a00180.html#l00105">105</a> of file <a class="el" href="a00180.html">webclient.c</a>. 492<p> 493References <a class="el" href="a00181.html#l00060">webclient_state::port</a>. </td> 494 </tr> 495</table> 496<a class="anchor" name="g23705efb9077187881f094fc9be13bde"></a><!-- doxytag: member="webclient.h::webclient_timedout" ref="g23705efb9077187881f094fc9be13bde" args="(void)" --><p> 497<table class="mdTable" cellpadding="2" cellspacing="0"> 498 <tr> 499 <td class="mdRow"> 500 <table cellpadding="0" cellspacing="0" border="0"> 501 <tr> 502 <td class="md" nowrap valign="top">void webclient_timedout </td> 503 <td class="md" valign="top">( </td> 504 <td class="md" nowrap valign="top">void </td> 505 <td class="mdname1" valign="top" nowrap> </td> 506 <td class="md" valign="top"> ) </td> 507 <td class="md" nowrap></td> 508 </tr> 509 </table> 510 </td> 511 </tr> 512</table> 513<table cellspacing="5" cellpadding="0" border="0"> 514 <tr> 515 <td> 516 517 </td> 518 <td> 519 520<p> 521Callback function that is called from the webclient code if the HTTP connection to the web server has timed out. 522<p> 523This function must be implemented by the module that uses the webclient code. <dl compact><dt><b>Examples: </b></dt><dd> 524<a class="el" href="a00040.html#a299">webclient.c</a>, and <a class="el" href="a00041.html#a320">webclient.h</a>.</dl> 525<p> 526Referenced by <a class="el" href="a00180.html#l00378">webclient_appcall()</a>. </td> 527 </tr> 528</table> 529<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:02 2006 for uIP 1.0 by 530<a href="http://www.doxygen.org/index.html"> 531<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> 532</body> 533</html> 534
