97 lines
9.4 KiB
HTML
97 lines
9.4 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 File Reference</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 File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
|
||
|
|
Header file for the HTTP client.
|
||
|
|
<p>
|
||
|
|
<dl compact><dt><b>Author:</b></dt><dd>Adam Dunkels <<a href="mailto:adam@dunkels.com">adam@dunkels.com</a>> </dd></dl>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
Definition in file <a class="el" href="a00181.html">webclient.h</a>.
|
||
|
|
<p>
|
||
|
|
<code>#include "webclient-strings.h"</code><br>
|
||
|
|
<code>#include "<a class="el" href="a00206.html">uipopt.h</a>"</code><br>
|
||
|
|
|
||
|
|
<p>
|
||
|
|
<a href="a00181.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
|
||
|
|
<tr><td></td></tr>
|
||
|
|
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g5a5bfd7e9060903893481db90645187b"></a><!-- doxytag: member="webclient.h::WEBCLIENT_CONF_MAX_URLLEN" ref="g5a5bfd7e9060903893481db90645187b" args="" -->
|
||
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g5a5bfd7e9060903893481db90645187b">WEBCLIENT_CONF_MAX_URLLEN</a> 100</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ge28f6cb60e86088d8886d0f804b4f37c"></a><!-- doxytag: member="webclient.h::UIP_APPCALL" ref="ge28f6cb60e86088d8886d0f804b4f37c" args="" -->
|
||
|
|
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#ge28f6cb60e86088d8886d0f804b4f37c">UIP_APPCALL</a> webclient_appcall</td></tr>
|
||
|
|
|
||
|
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdc5aec3587b2c55b714a6c2f37b56cba"></a><!-- doxytag: member="webclient.h::uip_tcp_appstate_t" ref="gdc5aec3587b2c55b714a6c2f37b56cba" args="" -->
|
||
|
|
typedef <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>
|
||
|
|
|
||
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#gc4b119801e50cc1824498a1cdf9adc37"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#g6b942c1ef22f8cd1a726ef3364c9fbea"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#g23705efb9077187881f094fc9be13bde"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#gf11d9915ec12a8cdd9fdcbb5e8fcd5c7"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#gf8f12c820cc08da32aa62898bfc02db3"></a><br></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g3caacabb2fe1c71921e1a471719ccbd2"></a><!-- doxytag: member="webclient.h::webclient_init" ref="g3caacabb2fe1c71921e1a471719ccbd2" args="(void)" -->
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g3caacabb2fe1c71921e1a471719ccbd2">webclient_init</a> (void)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the webclient module. <br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<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="a00163.html#gf9385ef9ecc74c7d53ff2f15e62bfde3"></a><br></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g1d34be506a61db90dd7829117efdf8cf"></a><!-- doxytag: member="webclient.h::webclient_close" ref="g1d34be506a61db90dd7829117efdf8cf" args="(void)" -->
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g1d34be506a61db90dd7829117efdf8cf">webclient_close</a> (void)</td></tr>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Close the currently open HTTP connection. <br></td></tr>
|
||
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g9e6d2864f390a4ba1ac60dc65e2b9815"></a><!-- doxytag: member="webclient.h::webclient_appcall" ref="g9e6d2864f390a4ba1ac60dc65e2b9815" args="(void)" -->
|
||
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00163.html#g9e6d2864f390a4ba1ac60dc65e2b9815">webclient_appcall</a> (void)</td></tr>
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the MIME type of the current HTTP data stream. <a href="a00163.html#g4433d3af16ea083a81576d0f18ba57c9"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the filename of the current HTTP data stream. <a href="a00163.html#g41e616d3fcc17e0aabfe8ab45ef0d30f"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the hostname of the current HTTP data stream. <a href="a00163.html#g0e0ea5f24b77f124ba33bcbc7ede5bfb"></a><br></td></tr>
|
||
|
|
<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>
|
||
|
|
|
||
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Obtain the port number of the current HTTP data stream. <a href="a00163.html#g2a939aa4fcffabbce1dc1f784a7e0ad3"></a><br></td></tr>
|
||
|
|
</table>
|
||
|
|
<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>
|