Lines Matching full:the
8 * Header file for the HTTP client.
17 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials provided
24 * with the distribution.
25 * 3. The name of the author may not be used to endorse or promote
29 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
30 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
32 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
38 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 * This file is part of the uIP TCP/IP stack.
76 * Callback function that is called from the webclient code when HTTP
79 * This function must be implemented by the module that uses the
80 * webclient code. The function is called from the webclient module
81 * when HTTP data has been received. The function is not called when
82 * HTTP headers are received, only for the actual data.
87 * \param data A pointer to the data that has been received.
88 * \param len The length of the data that has been received.
93 * Callback function that is called from the webclient code when the
94 * HTTP connection has been connected to the web server.
96 * This function must be implemented by the module that uses the
102 * Callback function that is called from the webclient code if the
103 * HTTP connection to the web server has timed out.
105 * This function must be implemented by the module that uses the
111 * Callback function that is called from the webclient code if the
112 * HTTP connection to the web server has been aborted by the web
115 * This function must be implemented by the module that uses the
121 * Callback function that is called from the webclient code when the
122 * HTTP connection to the web server has been closed.
124 * This function must be implemented by the module that uses the
132 * Initialize the webclient module.
138 * the GET method.
140 * This function opens an HTTP connection to the specified web server
141 * and requests the specified file using the GET method. When the HTTP
142 * connection has been connected, the webclient_connected() callback
143 * function is called and when the HTTP data arrives the
146 * The callback function webclient_timedout() is called if the web
147 * server could not be contacted, and the webclient_aborted() callback
148 * function is called if the HTTP connection is aborted by the web
151 * When the HTTP request has been completed and the HTTP connection is
152 * closed, the webclient_closed() callback function will be called.
154 * \note If the function is passed a host name, it must already be in
155 * the resolver cache in order for the function to connect to the web
156 * server. It is therefore up to the calling module to implement the
157 * resolver calls and the signal handler used for reporting a resolv
163 * \param port The port number to which to connect, in host byte order.
165 * \param file A pointer to the name of the file to get.
167 * \retval 0 if the host name could not be found in the cache, or
170 * \retval 1 if the connection was initiated.
175 * Close the currently open HTTP connection.
181 * Obtain the MIME type of the current HTTP data stream.
183 * \return A pointer to a string contaning the MIME type. The string
184 * may be empty if no MIME type was reported by the web server.
189 * Obtain the filename of the current HTTP data stream.
191 * The filename of an HTTP request may be changed by the web server,
192 * and may therefore not be the same as when the original GET request
194 * the current filename.
196 * \return A pointer to the current filename.
201 * Obtain the hostname of the current HTTP data stream.
203 * The hostname of the web server of an HTTP request may be changed
204 * by the web server, and may therefore not be the same as when the
206 * is used for obtaining the current hostname.
208 * \return A pointer to the current hostname.
213 * Obtain the port number of the current HTTP data stream.
215 * The port number of an HTTP request may be changed by the web
216 * server, and may therefore not be the same as when the original GET
218 * obtaining the current port number.
220 * \return The port number of the current HTTP data stream, in host byte order.