LRSD stephane / Mbed 2 deprecated WEBserverv3

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

lwip/HTTPClient/HTTPClient.h@0:9cf1d79ebe04, 2011-09-08 (annotated)

Committer:
geiineuville
Date:
Thu Sep 08 08:57:21 2011 +0000
Revision:
0:9cf1d79ebe04
v0 v1 v2   \"v3\"

Who changed what in which revision?

UserRevisionLine numberNew contents of line
geiineuville 0:9cf1d79ebe04 1 #ifndef HTTPCLIENT_H
geiineuville 0:9cf1d79ebe04 2 #define HTTPCLIENT_H
geiineuville 0:9cf1d79ebe04 3
geiineuville 0:9cf1d79ebe04 4 #include "TCPConnection.h"
geiineuville 0:9cf1d79ebe04 5 #include "NetServer.h"
geiineuville 0:9cf1d79ebe04 6 #include "iputil.h"
geiineuville 0:9cf1d79ebe04 7
geiineuville 0:9cf1d79ebe04 8 /* Class: HTTPClient
geiineuville 0:9cf1d79ebe04 9 * A simple Class to fetch HTTP Pages.
geiineuville 0:9cf1d79ebe04 10 */
geiineuville 0:9cf1d79ebe04 11 class HTTPClient : public TCPConnection {
geiineuville 0:9cf1d79ebe04 12 public:
geiineuville 0:9cf1d79ebe04 13 /* Constructor: HTTPClient
geiineuville 0:9cf1d79ebe04 14 * Creates an HTTPClient object. You might want to initialise the network server befor.
geiineuville 0:9cf1d79ebe04 15 * If you dont do it it will be happen by the first post or get request you make.
geiineuville 0:9cf1d79ebe04 16 *
geiineuville 0:9cf1d79ebe04 17 * To initialize the network server on creation of the HTTPClient object it's possible to parse some arguments.
geiineuville 0:9cf1d79ebe04 18 *
geiineuville 0:9cf1d79ebe04 19 * Variables:
geiineuville 0:9cf1d79ebe04 20 * hostname - A host name for the device. Might take a while to appear in the network,
geiineuville 0:9cf1d79ebe04 21 * depends on the network infrastructure. Furthermore in most cases you have
geiineuville 0:9cf1d79ebe04 22 * to add your domainname after the host name to address the device.
geiineuville 0:9cf1d79ebe04 23 * Default is NULL.
geiineuville 0:9cf1d79ebe04 24 * ip - The device ipaddress or ip_addr_any for dhcp. Default is ip_addr_any
geiineuville 0:9cf1d79ebe04 25 * nm - The device netmask or ip_addr_any for dhcp. Default is ip_addr_any.
geiineuville 0:9cf1d79ebe04 26 * gw - The device gateway or ip_addr_any for dhcp. Default is ip_addr_any.
geiineuville 0:9cf1d79ebe04 27 * dns - The device first dns server ip or ip_addr_any for dhcp. Default is ip_addr_any.
geiineuville 0:9cf1d79ebe04 28 *
geiineuville 0:9cf1d79ebe04 29 * Example:
geiineuville 0:9cf1d79ebe04 30 * > HTTPClient http; // Simple DHCP, brings up the TCP/IP stack on first get/post reguest.
geiineuville 0:9cf1d79ebe04 31 *
geiineuville 0:9cf1d79ebe04 32 * > HTTPClient http("worf"); // Brings up the device with DHCP and sets the host name "worf"
geiineuville 0:9cf1d79ebe04 33 * > // The device will be available under worf.<your local domain>
geiineuville 0:9cf1d79ebe04 34 * > // for example worf.1-2-3-4.dynamic.sky.com
geiineuville 0:9cf1d79ebe04 35 *
geiineuville 0:9cf1d79ebe04 36 * > HTTPClient http("wolf", // Brings up the device with static IP address and domain name.
geiineuville 0:9cf1d79ebe04 37 * > IPv4(192,168,0,44), // IPv4 is a helper function which allows to rtype ipaddresses direct
geiineuville 0:9cf1d79ebe04 38 * > IPv4(255,255,255,0), // as numbers in C++.
geiineuville 0:9cf1d79ebe04 39 * > IPv4(192,168,0,1), // the device address is set to 192.168.0.44, netmask 255.255.255.0
geiineuville 0:9cf1d79ebe04 40 * > IPv4(192,168,0,1)); // default gateway is 192.168.0.1 and dns to 192.168.0.1 as well.
geiineuville 0:9cf1d79ebe04 41 * >
geiineuville 0:9cf1d79ebe04 42 */
geiineuville 0:9cf1d79ebe04 43 HTTPClient(const char *hostname = NULL, struct ip_addr ip = ip_addr_any, struct ip_addr nm = ip_addr_any, struct ip_addr gw = ip_addr_any, struct ip_addr dns = ip_addr_any);
geiineuville 0:9cf1d79ebe04 44
geiineuville 0:9cf1d79ebe04 45 /* Destructor: ~HTTPClient
geiineuville 0:9cf1d79ebe04 46 * Destroys the HTTPClient class.
geiineuville 0:9cf1d79ebe04 47 */
geiineuville 0:9cf1d79ebe04 48 virtual ~HTTPClient() {
geiineuville 0:9cf1d79ebe04 49 if(_auth) {
geiineuville 0:9cf1d79ebe04 50 delete _auth;
geiineuville 0:9cf1d79ebe04 51 _auth = NULL;
geiineuville 0:9cf1d79ebe04 52 }
geiineuville 0:9cf1d79ebe04 53 }
geiineuville 0:9cf1d79ebe04 54
geiineuville 0:9cf1d79ebe04 55 /* Function: headers
geiineuville 0:9cf1d79ebe04 56 * Add header additional Information to the next post or get requests.
geiineuville 0:9cf1d79ebe04 57 * Somtimes it is useful to add further header information. For example an auth field.
geiineuville 0:9cf1d79ebe04 58 * Each time you call this function it will be replace the header fields given by an
geiineuville 0:9cf1d79ebe04 59 * prior call.
geiineuville 0:9cf1d79ebe04 60 *
geiineuville 0:9cf1d79ebe04 61 * It will not free your data.
geiineuville 0:9cf1d79ebe04 62 * Variables:
geiineuville 0:9cf1d79ebe04 63 * fields - A string containing all fields you want to add. Seperated by "\\r\\n".
geiineuville 0:9cf1d79ebe04 64 *
geiineuville 0:9cf1d79ebe04 65 */
geiineuville 0:9cf1d79ebe04 66 void headers(const char *fields);
geiineuville 0:9cf1d79ebe04 67
geiineuville 0:9cf1d79ebe04 68 /* Function: auth
geiineuville 0:9cf1d79ebe04 69 * Enables basic authentication. Just enter username and password
geiineuville 0:9cf1d79ebe04 70 * and they will be used for all requests.
geiineuville 0:9cf1d79ebe04 71 * If you want to lean your username and passwort just insert NULL, NULL.
geiineuville 0:9cf1d79ebe04 72 *
geiineuville 0:9cf1d79ebe04 73 * Variables:
geiineuville 0:9cf1d79ebe04 74 * user - Username for ure auth or NULL.
geiineuville 0:9cf1d79ebe04 75 * password - Password for auth or NULL.
geiineuville 0:9cf1d79ebe04 76 */
geiineuville 0:9cf1d79ebe04 77 void auth(const char *user, const char *password);
geiineuville 0:9cf1d79ebe04 78
geiineuville 0:9cf1d79ebe04 79 /* Function: get
geiineuville 0:9cf1d79ebe04 80 * A simple get-request just insert the url.
geiineuville 0:9cf1d79ebe04 81 * But if you want you can get the result back as a string.
geiineuville 0:9cf1d79ebe04 82 * Sometimes you want get a large result, more than 64 Bytes
geiineuville 0:9cf1d79ebe04 83 * than define your size.
geiineuville 0:9cf1d79ebe04 84 *
geiineuville 0:9cf1d79ebe04 85 * Variables:
geiineuville 0:9cf1d79ebe04 86 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 87 * result - The answere to your request, by default you have not to take it. But if you want it, it has a default length from 64 Bytes.
geiineuville 0:9cf1d79ebe04 88 * rsize - The maximum size of your result. By default 64 Bytes.
geiineuville 0:9cf1d79ebe04 89 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 90 */
geiineuville 0:9cf1d79ebe04 91 unsigned int get(const char *url, char *result = NULL, int rsize = 64);
geiineuville 0:9cf1d79ebe04 92
geiineuville 0:9cf1d79ebe04 93 /* Function: get
geiineuville 0:9cf1d79ebe04 94 * A simple get-request just insert the url and a FILE Pointer.
geiineuville 0:9cf1d79ebe04 95 * This get request will save yor result to an file. Very helpful if you demat a big bunch of data.
geiineuville 0:9cf1d79ebe04 96 *
geiineuville 0:9cf1d79ebe04 97 * Variables:
geiineuville 0:9cf1d79ebe04 98 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 99 * result - The FILE Pointer in which you want to store the result.
geiineuville 0:9cf1d79ebe04 100 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 101 */
geiineuville 0:9cf1d79ebe04 102 unsigned int get(const char *url, FILE *result);
geiineuville 0:9cf1d79ebe04 103
geiineuville 0:9cf1d79ebe04 104 /* Function: post
geiineuville 0:9cf1d79ebe04 105 * A simple post-request just insert the url.
geiineuville 0:9cf1d79ebe04 106 * You can send data if you want but they should be NULL-Terminated.
geiineuville 0:9cf1d79ebe04 107 * If you want you can get the result back as a string.
geiineuville 0:9cf1d79ebe04 108 * Sometimes you want get a large result, more than 64 Bytes
geiineuville 0:9cf1d79ebe04 109 * than define your size.
geiineuville 0:9cf1d79ebe04 110 *
geiineuville 0:9cf1d79ebe04 111 * Variables:
geiineuville 0:9cf1d79ebe04 112 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 113 * data - A char array of the data you might want to send.
geiineuville 0:9cf1d79ebe04 114 * result - The answere to your request, by default you have not to take it. But if you want it, it has a default length from 64 Bytes.
geiineuville 0:9cf1d79ebe04 115 * rsize - The maximum size of your result. By default 64 Bytes.
geiineuville 0:9cf1d79ebe04 116 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 117 */
geiineuville 0:9cf1d79ebe04 118 unsigned int post(const char *url, const char *data = NULL, char *result = NULL, int rsize = 64);
geiineuville 0:9cf1d79ebe04 119
geiineuville 0:9cf1d79ebe04 120 /* Function: post
geiineuville 0:9cf1d79ebe04 121 * A simple get-request just insert the url and a FILE Pointer.
geiineuville 0:9cf1d79ebe04 122 * You can send data if you want but they should be NULL-Terminated.
geiineuville 0:9cf1d79ebe04 123 * This get request will save yor result to an file. Very helpful if you demat a big bunch of data.
geiineuville 0:9cf1d79ebe04 124 *
geiineuville 0:9cf1d79ebe04 125 * Variables:
geiineuville 0:9cf1d79ebe04 126 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 127 * data - A char array of the data you might want to send.
geiineuville 0:9cf1d79ebe04 128 * result - The FILE Pointer in which you want to store the result.
geiineuville 0:9cf1d79ebe04 129 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 130 */
geiineuville 0:9cf1d79ebe04 131 unsigned int post(const char *url, const char *data, FILE *result);
geiineuville 0:9cf1d79ebe04 132
geiineuville 0:9cf1d79ebe04 133 /* Function: post
geiineuville 0:9cf1d79ebe04 134 * A simple get-request just insert the url and a two FILE Pointers to send the content of the file out and store you results.
geiineuville 0:9cf1d79ebe04 135 * Your data to sent can come from a file.
geiineuville 0:9cf1d79ebe04 136 * This get request will save yor result to an file. Very helpful if you demat a big bunch of data.
geiineuville 0:9cf1d79ebe04 137 *
geiineuville 0:9cf1d79ebe04 138 * Variables:
geiineuville 0:9cf1d79ebe04 139 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 140 * data - A FILE Pointer of a file you might want to send.
geiineuville 0:9cf1d79ebe04 141 * result - The FILE Pointer in which you want to store the result.
geiineuville 0:9cf1d79ebe04 142 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 143 */
geiineuville 0:9cf1d79ebe04 144 unsigned int post(const char *url, FILE *data, FILE *result);
geiineuville 0:9cf1d79ebe04 145
geiineuville 0:9cf1d79ebe04 146 /* Function: post
geiineuville 0:9cf1d79ebe04 147 * A simple get-request just insert the url and a two FILE Pointers to send the content of the file out and store you results.
geiineuville 0:9cf1d79ebe04 148 * Your data to sent can come from a file.
geiineuville 0:9cf1d79ebe04 149 * If you want you can get the result back as a string.
geiineuville 0:9cf1d79ebe04 150 * Sometimes you want get a large result, more than 64 Bytes
geiineuville 0:9cf1d79ebe04 151 * than define your size.
geiineuville 0:9cf1d79ebe04 152 *
geiineuville 0:9cf1d79ebe04 153 * url - The requested URL.
geiineuville 0:9cf1d79ebe04 154 * data - A FILE Pointer of a file you might want to send.
geiineuville 0:9cf1d79ebe04 155 * result - The answere to your request, by default you have not to take it. But if you want it, it has a default length from 64 Bytes.
geiineuville 0:9cf1d79ebe04 156 * length - The maximum size of your result. By default 64 Bytes.
geiineuville 0:9cf1d79ebe04 157 * returns - The length of your demanted result or 1 if the request is succssesful or 0 if it failed. But it might be 0 too wether your result has 0 in length.
geiineuville 0:9cf1d79ebe04 158 */
geiineuville 0:9cf1d79ebe04 159 unsigned int post(const char *url, FILE *data = NULL, char *result = NULL, int length = 64);
geiineuville 0:9cf1d79ebe04 160
geiineuville 0:9cf1d79ebe04 161 /* Function: timeout
geiineuville 0:9cf1d79ebe04 162 * Sets the timout for a HTTP request.
geiineuville 0:9cf1d79ebe04 163 * The timout is the time wich is allowed to spent between two incomming TCP packets.
geiineuville 0:9cf1d79ebe04 164 * If the time is passed the connection will be closed.
geiineuville 0:9cf1d79ebe04 165 */
geiineuville 0:9cf1d79ebe04 166 void timeout(int value);
geiineuville 0:9cf1d79ebe04 167
geiineuville 0:9cf1d79ebe04 168 private:
geiineuville 0:9cf1d79ebe04 169 virtual void err(err_t err);
geiineuville 0:9cf1d79ebe04 170 virtual err_t poll();
geiineuville 0:9cf1d79ebe04 171 virtual err_t sent(u16_t len) {return ERR_OK;};
geiineuville 0:9cf1d79ebe04 172 virtual err_t connected(err_t err);
geiineuville 0:9cf1d79ebe04 173 virtual err_t recv(struct pbuf *q, err_t err);
geiineuville 0:9cf1d79ebe04 174 virtual void dnsreply(const char *hostname, struct ip_addr *ipaddr);
geiineuville 0:9cf1d79ebe04 175 unsigned int make(const char *);
geiineuville 0:9cf1d79ebe04 176
geiineuville 0:9cf1d79ebe04 177 char *_auth;
geiineuville 0:9cf1d79ebe04 178 bool _ready;
geiineuville 0:9cf1d79ebe04 179 char _mode;
geiineuville 0:9cf1d79ebe04 180 char _state;
geiineuville 0:9cf1d79ebe04 181 int _timeout;
geiineuville 0:9cf1d79ebe04 182 const char *_host;
geiineuville 0:9cf1d79ebe04 183 const char *_path;
geiineuville 0:9cf1d79ebe04 184 void *_result;
geiineuville 0:9cf1d79ebe04 185 void *_data;
geiineuville 0:9cf1d79ebe04 186 const char *_request;
geiineuville 0:9cf1d79ebe04 187 const char *_headerfields;
geiineuville 0:9cf1d79ebe04 188 unsigned int _hostlen;
geiineuville 0:9cf1d79ebe04 189 unsigned int _resultoff;
geiineuville 0:9cf1d79ebe04 190 unsigned int _resultleft;
geiineuville 0:9cf1d79ebe04 191 int _timeout_max;
geiineuville 0:9cf1d79ebe04 192 };
geiineuville 0:9cf1d79ebe04 193
geiineuville 0:9cf1d79ebe04 194 #endif