A simple web server that can be bound to either the EthernetInterface or the WiflyInterface.
Dependents: Smart-WiFly-WebServer WattEye X10Svr SSDP_Server
SW_HTTPServer.h@39:0427544a5c08, 2014-09-01 (annotated)
- Committer:
- WiredHome
- Date:
- Mon Sep 01 20:53:19 2014 +0000
- Revision:
- 39:0427544a5c08
- Parent:
- 38:c8fa31e6fe02
- Child:
- 40:02c49fadbb94
Removed requirement for WiFly module - permitting any Ethernet compatible interface.; Improved the processing of POST method.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
WiredHome | 1:54353af0d20a | 1 | |
WiredHome | 1:54353af0d20a | 2 | #ifndef SW_HTTPSERVER_H |
WiredHome | 1:54353af0d20a | 3 | #define SW_HTTPSERVER_H |
WiredHome | 1:54353af0d20a | 4 | #include "mbed.h" |
WiredHome | 1:54353af0d20a | 5 | #include "TCPSocketServer.h" |
WiredHome | 1:54353af0d20a | 6 | #include "TCPSocketConnection.h" |
WiredHome | 1:54353af0d20a | 7 | |
WiredHome | 1:54353af0d20a | 8 | #ifdef MODSERIAL_H |
WiredHome | 1:54353af0d20a | 9 | #define PC MODSERIAL |
WiredHome | 1:54353af0d20a | 10 | #else |
WiredHome | 36:1bb5fa6b109c | 11 | #define PC RawSerial |
WiredHome | 1:54353af0d20a | 12 | #endif |
WiredHome | 1:54353af0d20a | 13 | |
WiredHome | 9:2ea342765c9d | 14 | /// This is the default buffer size used to send files. You might size |
WiredHome | 9:2ea342765c9d | 15 | /// this to be equal or less than the payload size of 1460 bytes. |
WiredHome | 9:2ea342765c9d | 16 | /// See User Manual 3.6.1. |
WiredHome | 9:2ea342765c9d | 17 | #define FILESEND_BUF_SIZE 1460 |
WiredHome | 3:17928786bdb5 | 18 | |
WiredHome | 3:17928786bdb5 | 19 | |
WiredHome | 12:109bf1558300 | 20 | /// MAX_HEADER_SIZE is the default size to contain the largest header. |
WiredHome | 9:2ea342765c9d | 21 | /// This is the size of the URL and query string, and also all the |
WiredHome | 3:17928786bdb5 | 22 | /// other header information about the client. This can be |
WiredHome | 12:109bf1558300 | 23 | /// a couple of K, larger if you have big forms as it includes the |
WiredHome | 3:17928786bdb5 | 24 | /// form data that is submitted. |
WiredHome | 3:17928786bdb5 | 25 | #define MAX_HEADER_SIZE 1000 |
WiredHome | 3:17928786bdb5 | 26 | |
WiredHome | 9:2ea342765c9d | 27 | |
WiredHome | 39:0427544a5c08 | 28 | /// HTTPServer is a simple web server leveraging a network interface. |
WiredHome | 12:109bf1558300 | 29 | /// |
WiredHome | 3:17928786bdb5 | 30 | /// While simple, it is a capable, web server. The basic mode |
WiredHome | 3:17928786bdb5 | 31 | /// of operation is for it to serve static web pages from an available |
WiredHome | 3:17928786bdb5 | 32 | /// file system. |
WiredHome | 12:109bf1558300 | 33 | /// |
WiredHome | 3:17928786bdb5 | 34 | /// The default page is index.htm (compile time defined) |
WiredHome | 3:17928786bdb5 | 35 | /// standard support to serve a number of standard file types; |
WiredHome | 3:17928786bdb5 | 36 | /// gif, jpg, jpeg, ico, png, zip, gz, tar, txt, pdf, htm, html |
WiredHome | 3:17928786bdb5 | 37 | /// (this list is also compile time defined) |
WiredHome | 3:17928786bdb5 | 38 | /// |
WiredHome | 3:17928786bdb5 | 39 | /// It can also serve dynamically generated pages, and therefore |
WiredHome | 3:17928786bdb5 | 40 | /// respond to form submission. Through the dynamic interface it is |
WiredHome | 3:17928786bdb5 | 41 | /// then quite easy to interact with the hardware, reading the inputs |
WiredHome | 3:17928786bdb5 | 42 | /// or signaling outputs. |
WiredHome | 3:17928786bdb5 | 43 | /// |
WiredHome | 3:17928786bdb5 | 44 | /// @code |
WiredHome | 39:0427544a5c08 | 45 | /// HTTPServer svr(HTTP_SERVER_PORT, "/local", 15, 30, 10, &pc); |
WiredHome | 3:17928786bdb5 | 46 | /// svr.RegisterHandler("/dyn1", SimpleDynamicPage); |
WiredHome | 3:17928786bdb5 | 47 | /// while (true) |
WiredHome | 3:17928786bdb5 | 48 | /// { |
WiredHome | 3:17928786bdb5 | 49 | /// svr.Poll(); // this is non blocking process, but variable execution |
WiredHome | 3:17928786bdb5 | 50 | /// } |
WiredHome | 3:17928786bdb5 | 51 | /// @endcode |
WiredHome | 3:17928786bdb5 | 52 | /// |
WiredHome | 3:17928786bdb5 | 53 | /// This web server used nweb as a starting point, but expanded well beyond there. |
WiredHome | 0:729320f63c5c | 54 | /// http://www.ibm.com/developerworks/systems/library/es-nweb/sidefile1.html |
WiredHome | 0:729320f63c5c | 55 | /// |
WiredHome | 3:17928786bdb5 | 56 | /// Given: scheme://server:port/path?query_string#fragment_id |
WiredHome | 0:729320f63c5c | 57 | /// @li scheme is "http" |
WiredHome | 3:17928786bdb5 | 58 | /// @li server is whatever IP the server has |
WiredHome | 0:729320f63c5c | 59 | /// @li port is the registered port |
WiredHome | 0:729320f63c5c | 60 | /// @li /path is the reference to the file (actual or logical) on the server |
WiredHome | 0:729320f63c5c | 61 | /// @li query_string is any combination of name=value pairs |
WiredHome | 0:729320f63c5c | 62 | /// @li fragment_id is a reference to an anchor on the page |
WiredHome | 0:729320f63c5c | 63 | /// |
WiredHome | 3:17928786bdb5 | 64 | /// Features: |
WiredHome | 3:17928786bdb5 | 65 | /// @li Serves static pages from a file system. Many normal filetypes are |
WiredHome | 3:17928786bdb5 | 66 | /// supported. |
WiredHome | 3:17928786bdb5 | 67 | /// @li Compile time configurable for the "default" file, typically index.htm. |
WiredHome | 3:17928786bdb5 | 68 | /// @li Provides a registration interface for dynamically generated pages that |
WiredHome | 3:17928786bdb5 | 69 | /// can then interact with other hardware. |
WiredHome | 3:17928786bdb5 | 70 | /// @li Revised to be Non-blocking, however the execution time is variable |
WiredHome | 7:99ad7a67f05e | 71 | /// depending on the actions being performed and can span hundreds of msec. |
WiredHome | 3:17928786bdb5 | 72 | /// |
WiredHome | 3:17928786bdb5 | 73 | /// Limitations: |
WiredHome | 39:0427544a5c08 | 74 | /// @li When used with Wifly network interface it supports only a single |
WiredHome | 39:0427544a5c08 | 75 | /// connection at a time. A web page with served objects (img src=...) |
WiredHome | 39:0427544a5c08 | 76 | /// is rarely served properly. It might trace to forcing the connection to |
WiredHome | 39:0427544a5c08 | 77 | /// close, but not yet sure. Explore "Set Uart Rx Data Buffer" in |
WiredHome | 39:0427544a5c08 | 78 | /// WiFly manual 2.3.65. This is a limitation of the Wifly module. |
WiredHome | 39:0427544a5c08 | 79 | /// No solution is forthcoming, so a crude workaround is to use javascript |
WiredHome | 39:0427544a5c08 | 80 | /// to load the images after the page loads. |
WiredHome | 3:17928786bdb5 | 81 | /// @li Rapid requests for page objects (e.g. embedded images) are lost. Still |
WiredHome | 3:17928786bdb5 | 82 | /// working to understand this issue. |
WiredHome | 3:17928786bdb5 | 83 | /// |
WiredHome | 18:6199558632c0 | 84 | /// Improvements: |
WiredHome | 39:0427544a5c08 | 85 | /// @li removed the relationship to the Wifly module, which caused an API change |
WiredHome | 39:0427544a5c08 | 86 | /// in the constructor by elimination of the first parameter. |
WiredHome | 18:6199558632c0 | 87 | /// @li hunted down several lengthy operations - the speed of the file system |
WiredHome | 18:6199558632c0 | 88 | /// and the "close" operation which requires <delay 0.25s>$$$<delay>close\r. |
WiredHome | 18:6199558632c0 | 89 | /// @li parses the header similar to the query string, and then makes |
WiredHome | 18:6199558632c0 | 90 | /// those parameters accessible. |
WiredHome | 18:6199558632c0 | 91 | /// @li Added basic password capability to dynamic web pages. |
WiredHome | 18:6199558632c0 | 92 | /// |
WiredHome | 3:17928786bdb5 | 93 | /// ToDo: |
WiredHome | 3:17928786bdb5 | 94 | /// @li move part of the POST method handler to the registered handler, so |
WiredHome | 0:729320f63c5c | 95 | /// it can decide if it should allocate the needed memory. |
WiredHome | 3:17928786bdb5 | 96 | /// @li transform the pc serial interface to a log interface, which might |
WiredHome | 0:729320f63c5c | 97 | /// be more useful. |
WiredHome | 3:17928786bdb5 | 98 | /// @li Add ability to put WiFly in AP mode and then configuration pages |
WiredHome | 2:a29c32190037 | 99 | /// to find and join a network. |
WiredHome | 3:17928786bdb5 | 100 | /// @li Add ability to change/update SW in the WiFly module |
WiredHome | 3:17928786bdb5 | 101 | /// @li Add ability to upload a new application to the mbed |
WiredHome | 2:a29c32190037 | 102 | /// |
WiredHome | 2:a29c32190037 | 103 | /// History: |
WiredHome | 2:a29c32190037 | 104 | /// @li 20130530 Initial version |
WiredHome | 2:a29c32190037 | 105 | /// @li 20130601 Renamed ip_process to Poll |
WiredHome | 3:17928786bdb5 | 106 | /// @li 20130617 Cleaned up some of the documentation changes |
WiredHome | 3:17928786bdb5 | 107 | /// @li 20130623 Make it non-blocking. "Poll" takes a variable amount |
WiredHome | 3:17928786bdb5 | 108 | /// of time, based on whether it is idle, or how much it |
WiredHome | 3:17928786bdb5 | 109 | /// has to do. |
WiredHome | 18:6199558632c0 | 110 | /// @li 20130911 Lots of incremental changes along this way, this update |
WiredHome | 18:6199558632c0 | 111 | /// refreshes the documentation. |
WiredHome | 0:729320f63c5c | 112 | /// |
WiredHome | 0:729320f63c5c | 113 | /// @note Copyright © 2013 by Smartware Computing, all rights reserved. |
WiredHome | 0:729320f63c5c | 114 | /// Individuals may use this application for evaluation or non-commercial |
WiredHome | 0:729320f63c5c | 115 | /// purposes. Within this restriction, changes may be made to this application |
WiredHome | 0:729320f63c5c | 116 | /// as long as this copyright notice is retained. The user shall make |
WiredHome | 0:729320f63c5c | 117 | /// clear that their work is a derived work, and not the original. |
WiredHome | 0:729320f63c5c | 118 | /// Users of this application and sources accept this application "as is" and |
WiredHome | 0:729320f63c5c | 119 | /// shall hold harmless Smartware Computing, for any undesired results while |
WiredHome | 0:729320f63c5c | 120 | /// using this application - whether real or imagined. |
WiredHome | 0:729320f63c5c | 121 | /// |
WiredHome | 0:729320f63c5c | 122 | /// @author David Smart, Smartware Computing |
WiredHome | 0:729320f63c5c | 123 | /// |
WiredHome | 0:729320f63c5c | 124 | class HTTPServer |
WiredHome | 0:729320f63c5c | 125 | { |
WiredHome | 0:729320f63c5c | 126 | public: |
WiredHome | 0:729320f63c5c | 127 | /** |
WiredHome | 3:17928786bdb5 | 128 | * name-value pairs for parameters |
WiredHome | 0:729320f63c5c | 129 | */ |
WiredHome | 3:17928786bdb5 | 130 | typedef struct NAMEVALUE { |
WiredHome | 0:729320f63c5c | 131 | char * name; |
WiredHome | 0:729320f63c5c | 132 | char * value; |
WiredHome | 0:729320f63c5c | 133 | } namevalue; |
WiredHome | 12:109bf1558300 | 134 | |
WiredHome | 2:a29c32190037 | 135 | /** |
WiredHome | 3:17928786bdb5 | 136 | * Indicates the purpose of the Handler callback |
WiredHome | 3:17928786bdb5 | 137 | * |
WiredHome | 12:109bf1558300 | 138 | * Application code in a dynamic page uses this to determine the state |
WiredHome | 3:17928786bdb5 | 139 | * and therefore the needed operation to be performed. |
WiredHome | 3:17928786bdb5 | 140 | * |
WiredHome | 3:17928786bdb5 | 141 | * @code |
WiredHome | 13:8975d7928678 | 142 | * bool SimpleDynamicPage(HTTPServer *svr, HTTPServer::CallBackType type, |
WiredHome | 13:8975d7928678 | 143 | * const char * path, const HTTPServer::namevalue *queryParams, |
WiredHome | 13:8975d7928678 | 144 | * int queryParamCount) { |
WiredHome | 3:17928786bdb5 | 145 | * char buf[100]; |
WiredHome | 3:17928786bdb5 | 146 | * bool ret = false; |
WiredHome | 12:109bf1558300 | 147 | * |
WiredHome | 3:17928786bdb5 | 148 | * switch (type) { |
WiredHome | 3:17928786bdb5 | 149 | * case HTTPServer::SEND_PAGE: |
WiredHome | 3:17928786bdb5 | 150 | * svr->header(200, "OK", "Content-Type: text/html\r\n"); |
WiredHome | 3:17928786bdb5 | 151 | * svr->send("<html><head><title>Dynamic Page</title></head>\r\n"); |
WiredHome | 3:17928786bdb5 | 152 | * svr->send("<body>\r\n"); |
WiredHome | 3:17928786bdb5 | 153 | * svr->send("This page was generated dynamically. Create your own name=value pairs on the URL " |
WiredHome | 3:17928786bdb5 | 154 | * "which uses the GET method.<br/>\r\n"); |
WiredHome | 13:8975d7928678 | 155 | * sprintf(buf, "%d parameters passed to {%s}:<br/>\r\n", queryParamCount, path); |
WiredHome | 3:17928786bdb5 | 156 | * svr->send(buf); |
WiredHome | 13:8975d7928678 | 157 | * for (int i=0; i<queryParamCount; i++) { |
WiredHome | 13:8975d7928678 | 158 | * sprintf(buf, "%d: %s = %s<br/>\r\n", i, queryParams[i].name, queryParams[i].value); |
WiredHome | 3:17928786bdb5 | 159 | * svr->send(buf); |
WiredHome | 3:17928786bdb5 | 160 | * } |
WiredHome | 3:17928786bdb5 | 161 | * svr->send("<br/><a href='/'>back to main</a></body></html>\r\n"); |
WiredHome | 3:17928786bdb5 | 162 | * ret = true; |
WiredHome | 3:17928786bdb5 | 163 | * break; |
WiredHome | 3:17928786bdb5 | 164 | * case HTTPServer::CONTENT_LENGTH_REQUEST: |
WiredHome | 3:17928786bdb5 | 165 | * ret = true; |
WiredHome | 3:17928786bdb5 | 166 | * break; |
WiredHome | 3:17928786bdb5 | 167 | * case HTTPServer::DATA_TRANSFER: |
WiredHome | 3:17928786bdb5 | 168 | * ret = true; |
WiredHome | 3:17928786bdb5 | 169 | * break; |
WiredHome | 3:17928786bdb5 | 170 | * default: |
WiredHome | 3:17928786bdb5 | 171 | * ret = false; |
WiredHome | 3:17928786bdb5 | 172 | * break; |
WiredHome | 3:17928786bdb5 | 173 | * } |
WiredHome | 3:17928786bdb5 | 174 | * return ret; |
WiredHome | 3:17928786bdb5 | 175 | * } |
WiredHome | 3:17928786bdb5 | 176 | * @endcode |
WiredHome | 2:a29c32190037 | 177 | */ |
WiredHome | 3:17928786bdb5 | 178 | typedef enum CALLBACKTYPE { |
WiredHome | 14:19c5f6151319 | 179 | CONTENT_LENGTH_REQUEST, ///< ask the client if they wish to accept the data, typically from a POST event |
WiredHome | 27:90a1f5a5392f | 180 | DATA_TRANSFER, ///< used when submitting a file via a form |
WiredHome | 33:ef165a67ab22 | 181 | DATA_TRANSFER_END, ///< used when all data has been given to the client (may be used to close the file) |
WiredHome | 3:17928786bdb5 | 182 | SEND_PAGE, ///< the activated method should now send the page |
WiredHome | 2:a29c32190037 | 183 | } CallBackType; |
WiredHome | 0:729320f63c5c | 184 | |
WiredHome | 28:f93ef41b78e1 | 185 | typedef enum CALLBACKRESULTS { |
WiredHome | 28:f93ef41b78e1 | 186 | ACCEPT_ERROR, ///< client not accepting the request. |
WiredHome | 28:f93ef41b78e1 | 187 | ACCEPT_COMPLETE, ///< client accepted the request, the work is done. |
WiredHome | 28:f93ef41b78e1 | 188 | ACCEPT_CONTINUE, ///< client accepted the request, additional transactions to complete. |
WiredHome | 28:f93ef41b78e1 | 189 | } CallBackResults; |
WiredHome | 28:f93ef41b78e1 | 190 | |
WiredHome | 12:109bf1558300 | 191 | /** |
WiredHome | 3:17928786bdb5 | 192 | * This is the prototype for custom handlers that are activated via a callback |
WiredHome | 0:729320f63c5c | 193 | * |
WiredHome | 37:0cb2774e2410 | 194 | * This callback gets overloaded for a few purposes, which can be identified by the |
WiredHome | 37:0cb2774e2410 | 195 | * \see CallBackType parameter. |
WiredHome | 37:0cb2774e2410 | 196 | * |
WiredHome | 27:90a1f5a5392f | 197 | * @li CONTENT_LENGTH_REQUEST - the server is asking the callback if it wants to receive the message, |
WiredHome | 27:90a1f5a5392f | 198 | * which may require significant memory. If the request is accepted, true should be returned. |
WiredHome | 27:90a1f5a5392f | 199 | * If the request is denied, false should be returned. |
WiredHome | 27:90a1f5a5392f | 200 | * @li DATA_TRANSFER - the server is handing off a large body of data, which was accepted based |
WiredHome | 27:90a1f5a5392f | 201 | * on the CONTENT_LENGTH_REQUEST callback. The data is now available for processing. |
WiredHome | 27:90a1f5a5392f | 202 | * The callback should return true to continue the processing. |
WiredHome | 12:109bf1558300 | 203 | * @li SEND_PAGE - the callback should now send the html page, using as many svr->send() as needed. |
WiredHome | 29:00116fc9da74 | 204 | * When the callback returns, it should always indicate true that it has sent the page. |
WiredHome | 27:90a1f5a5392f | 205 | * |
WiredHome | 27:90a1f5a5392f | 206 | * @note The queryParams pointer purpose depends on the callback type. |
WiredHome | 33:ef165a67ab22 | 207 | * For CONTENT_LENGTH_REQUEST, the pointer points to the name=value pairs from the |
WiredHome | 27:90a1f5a5392f | 208 | * header. |
WiredHome | 33:ef165a67ab22 | 209 | * For DATA_TRANSFER, the pointer points to the start of the actual data. |
WiredHome | 29:00116fc9da74 | 210 | * For SEND_PAGE, ... <to be determined> |
WiredHome | 12:109bf1558300 | 211 | * |
WiredHome | 0:729320f63c5c | 212 | * @param svr is a handle to this class, so the callback has access to member functions |
WiredHome | 33:ef165a67ab22 | 213 | * @param type is the callback type @see CallBackType |
WiredHome | 37:0cb2774e2410 | 214 | * @param path is the pointer to a large block of information being transferred. This pointer |
WiredHome | 37:0cb2774e2410 | 215 | * references a dynamically managed resource, so any information of value must be |
WiredHome | 37:0cb2774e2410 | 216 | * extracted from here, and not referenced into this memory space. |
WiredHome | 27:90a1f5a5392f | 217 | * @param queryParams is a pointer based on the callback type. |
WiredHome | 33:ef165a67ab22 | 218 | * @param count is the number of items - for type = CONTENT_LENGTH_REQUEST this is the number of |
WiredHome | 33:ef165a67ab22 | 219 | * name=value pars in the queryParams parameter, and for the DATA_TRANSFER this is the |
WiredHome | 33:ef165a67ab22 | 220 | * number of bytes being passed in the path parameters. |
WiredHome | 33:ef165a67ab22 | 221 | * @return one of the @see CallBackResults signals indicating error or successes |
WiredHome | 0:729320f63c5c | 222 | */ |
WiredHome | 37:0cb2774e2410 | 223 | typedef CallBackResults (* Handler)(HTTPServer * svr, CallBackType type, const char *path, |
WiredHome | 37:0cb2774e2410 | 224 | const namevalue *queryParams, int queryParamCount); |
WiredHome | 12:109bf1558300 | 225 | |
WiredHome | 0:729320f63c5c | 226 | /** |
WiredHome | 0:729320f63c5c | 227 | * Create the HTTPServer object. |
WiredHome | 12:109bf1558300 | 228 | * |
WiredHome | 0:729320f63c5c | 229 | * @param port is the optional parameter for the port number to use, default is 80. |
WiredHome | 27:90a1f5a5392f | 230 | * @param webroot is a file system path to the root folder for the web space. If any trailing '/' |
WiredHome | 27:90a1f5a5392f | 231 | * is included (e.g. "/web/path/") it will be removed (to "/web/path"). |
WiredHome | 37:0cb2774e2410 | 232 | * @param maxheaderParams defines the maximum number of parameters to extract from a header |
WiredHome | 37:0cb2774e2410 | 233 | * (Host: 192..\r\nConnection: keep-alive\r\n...) |
WiredHome | 37:0cb2774e2410 | 234 | * @param maxqueryParams defines the maximum number of query parameters to a dynamic function |
WiredHome | 37:0cb2774e2410 | 235 | * (and the memory to support them). |
WiredHome | 0:729320f63c5c | 236 | * @param maxdynamicpages defines the maximum number of dynamic pages that can be registered. |
WiredHome | 0:729320f63c5c | 237 | * @param pc is the serial port for debug information (I should transform this to a log interface) |
WiredHome | 3:17928786bdb5 | 238 | * @param allocforheader is the memory allocation to support the largest expected header from a client |
WiredHome | 37:0cb2774e2410 | 239 | * @param allocforfile is the memory allocation to support sending a file to the client. This is |
WiredHome | 37:0cb2774e2410 | 240 | * typically sized to fit an ethernet frame. |
WiredHome | 0:729320f63c5c | 241 | */ |
WiredHome | 39:0427544a5c08 | 242 | HTTPServer(int port = 80, const char * webroot = "/", int maxheaderParams = 15, |
WiredHome | 37:0cb2774e2410 | 243 | int maxqueryParams = 30, int maxdynamicpages = 10, |
WiredHome | 37:0cb2774e2410 | 244 | PC * pc = NULL, int _allocforheader = MAX_HEADER_SIZE, int _allocforfile = FILESEND_BUF_SIZE); |
WiredHome | 12:109bf1558300 | 245 | |
WiredHome | 0:729320f63c5c | 246 | /** |
WiredHome | 3:17928786bdb5 | 247 | * Destructor, which can clean up memory. |
WiredHome | 0:729320f63c5c | 248 | */ |
WiredHome | 0:729320f63c5c | 249 | ~HTTPServer(); |
WiredHome | 12:109bf1558300 | 250 | |
WiredHome | 0:729320f63c5c | 251 | /** |
WiredHome | 27:90a1f5a5392f | 252 | * Get the path to the webroot, for applications that need to |
WiredHome | 27:90a1f5a5392f | 253 | * reference the file system relative to that point. |
WiredHome | 24:062431453abb | 254 | * |
WiredHome | 27:90a1f5a5392f | 255 | * @note The returned value may not be exactly as set at instantiation |
WiredHome | 27:90a1f5a5392f | 256 | * as trailing '/' were removed (unless the web root == "/"). |
WiredHome | 27:90a1f5a5392f | 257 | * e.g. "/msc/web/" becomes "/msc/web" |
WiredHome | 27:90a1f5a5392f | 258 | * |
WiredHome | 27:90a1f5a5392f | 259 | * @returns pointer to the webroot string. |
WiredHome | 24:062431453abb | 260 | */ |
WiredHome | 24:062431453abb | 261 | const char * GetWebRoot() { |
WiredHome | 27:90a1f5a5392f | 262 | return (const char *)webroot; |
WiredHome | 27:90a1f5a5392f | 263 | }; |
WiredHome | 24:062431453abb | 264 | |
WiredHome | 24:062431453abb | 265 | /** |
WiredHome | 3:17928786bdb5 | 266 | * The process to call whenever there is free time, as this basically does |
WiredHome | 0:729320f63c5c | 267 | * all the work to monitor for connections and handle replies. |
WiredHome | 2:a29c32190037 | 268 | * |
WiredHome | 2:a29c32190037 | 269 | * 20130601 Renamed from ip_process to Poll |
WiredHome | 0:729320f63c5c | 270 | */ |
WiredHome | 2:a29c32190037 | 271 | void Poll(); |
WiredHome | 12:109bf1558300 | 272 | |
WiredHome | 0:729320f63c5c | 273 | /** |
WiredHome | 12:109bf1558300 | 274 | * Send typical header data, and some optional data back to the client. |
WiredHome | 3:17928786bdb5 | 275 | * |
WiredHome | 3:17928786bdb5 | 276 | * This forms and sends the typical header back to the client. It may also send |
WiredHome | 3:17928786bdb5 | 277 | * optional data (which must end with "\r\n"). It then sends the second newline |
WiredHome | 3:17928786bdb5 | 278 | * sequence that signals the end of the header. |
WiredHome | 0:729320f63c5c | 279 | * |
WiredHome | 0:729320f63c5c | 280 | * @param code is the optional return code; 200 = OK, if not provided then 404 = Not found is returned |
WiredHome | 0:729320f63c5c | 281 | * @param code_text is the text to align with the code (e.g. 404, "Not Found") |
WiredHome | 0:729320f63c5c | 282 | * @param content_type is a pointer to "Content-Type: text/html\r\n" (for example) |
WiredHome | 3:17928786bdb5 | 283 | * @param optional_text is a pointer to any other text that is part of the header, which must |
WiredHome | 3:17928786bdb5 | 284 | * have \r\n termination. |
WiredHome | 0:729320f63c5c | 285 | */ |
WiredHome | 37:0cb2774e2410 | 286 | void header(int code = 404, const char * code_text = "Not Found", const char * content_type = NULL, |
WiredHome | 37:0cb2774e2410 | 287 | const char * optional_text = NULL); |
WiredHome | 0:729320f63c5c | 288 | |
WiredHome | 0:729320f63c5c | 289 | /** |
WiredHome | 0:729320f63c5c | 290 | * Send text to the client |
WiredHome | 0:729320f63c5c | 291 | * |
WiredHome | 3:17928786bdb5 | 292 | * This sends the specified text to the client. If the number of bytes is not set, |
WiredHome | 3:17928786bdb5 | 293 | * then it calculates the number of bytes as a string. For binary transfers, the |
WiredHome | 3:17928786bdb5 | 294 | * number of bytes to send is required for proper operation. |
WiredHome | 3:17928786bdb5 | 295 | * |
WiredHome | 0:729320f63c5c | 296 | * @param msg is the text string to send |
WiredHome | 0:729320f63c5c | 297 | * @param bytes is the number of bytes to send. If not set, then strlen is calculated. |
WiredHome | 0:729320f63c5c | 298 | */ |
WiredHome | 0:729320f63c5c | 299 | void send(const char * msg, int bytes = -1); |
WiredHome | 12:109bf1558300 | 300 | |
WiredHome | 0:729320f63c5c | 301 | /** |
WiredHome | 3:17928786bdb5 | 302 | * Send a referenced file to the client, including the header |
WiredHome | 3:17928786bdb5 | 303 | * |
WiredHome | 3:17928786bdb5 | 304 | * This sends a file from the filesystem to the client. It must be of a supported type |
WiredHome | 3:17928786bdb5 | 305 | * in order to properly create the header. |
WiredHome | 0:729320f63c5c | 306 | * |
WiredHome | 0:729320f63c5c | 307 | * @param filename is the fully qualified path and filename |
WiredHome | 3:17928786bdb5 | 308 | * @param filetype is the header information (e.g. "Content-Type: application/pdf") |
WiredHome | 0:729320f63c5c | 309 | * @return true if it thinks it sent ok, false otherwise. |
WiredHome | 0:729320f63c5c | 310 | */ |
WiredHome | 0:729320f63c5c | 311 | bool SendFile(const char * filename, const char * filetype); |
WiredHome | 12:109bf1558300 | 312 | |
WiredHome | 12:109bf1558300 | 313 | /** |
WiredHome | 0:729320f63c5c | 314 | * register a handler for a specific URL. |
WiredHome | 0:729320f63c5c | 315 | * |
WiredHome | 3:17928786bdb5 | 316 | * This api lets you register a dynamic handler in the web server. This is |
WiredHome | 3:17928786bdb5 | 317 | * most useful for interactive web pages, rather than simply serving static |
WiredHome | 3:17928786bdb5 | 318 | * pages. |
WiredHome | 3:17928786bdb5 | 319 | * |
WiredHome | 3:17928786bdb5 | 320 | * @code |
WiredHome | 12:109bf1558300 | 321 | * |
WiredHome | 3:17928786bdb5 | 322 | * ... |
WiredHome | 3:17928786bdb5 | 323 | * svr.RegisterHandler("/dyn1", SimpleDynamicPage);svr.RegisterHandler("/dyn1", SimpleDynamicPage); |
WiredHome | 3:17928786bdb5 | 324 | * ... |
WiredHome | 3:17928786bdb5 | 325 | * |
WiredHome | 37:0cb2774e2410 | 326 | * bool SimpleDynamicPage(HTTPServer *svr, HTTPServer::CallBackType type, const char * path, |
WiredHome | 37:0cb2774e2410 | 327 | * const HTTPServer::namevalue *queryParams, int queryParamCount) { |
WiredHome | 3:17928786bdb5 | 328 | * char buf[100]; |
WiredHome | 3:17928786bdb5 | 329 | * bool ret = false; |
WiredHome | 12:109bf1558300 | 330 | * |
WiredHome | 3:17928786bdb5 | 331 | * switch (type) { |
WiredHome | 3:17928786bdb5 | 332 | * case HTTPServer::SEND_PAGE: |
WiredHome | 3:17928786bdb5 | 333 | * svr->header(200, "OK", "Content-Type: text/html\r\n"); |
WiredHome | 3:17928786bdb5 | 334 | * svr->send("<html><head><title>Dynamic Page</title></head>\r\n"); |
WiredHome | 3:17928786bdb5 | 335 | * svr->send("<body>\r\n"); |
WiredHome | 3:17928786bdb5 | 336 | * svr->send("This page was generated dynamically. Create your own name=value pairs on the URL " |
WiredHome | 3:17928786bdb5 | 337 | * "which uses the GET method.<br/>\r\n"); |
WiredHome | 13:8975d7928678 | 338 | * sprintf(buf, "%d parameters passed to {%s}:<br/>\r\n", queryParamCount, path); |
WiredHome | 3:17928786bdb5 | 339 | * svr->send(buf); |
WiredHome | 13:8975d7928678 | 340 | * for (int i=0; i<queryParamCount; i++) { |
WiredHome | 13:8975d7928678 | 341 | * sprintf(buf, "%d: %s = %s<br/>\r\n", i, queryParams[i].name, queryParams[i].value); |
WiredHome | 3:17928786bdb5 | 342 | * svr->send(buf); |
WiredHome | 3:17928786bdb5 | 343 | * } |
WiredHome | 3:17928786bdb5 | 344 | * svr->send("Stats:<br/>\r\n"); |
WiredHome | 3:17928786bdb5 | 345 | * sprintf(buf,"Free memory space: %d<br/>\r\n", Free()); |
WiredHome | 3:17928786bdb5 | 346 | * svr->send(buf); |
WiredHome | 3:17928786bdb5 | 347 | * sprintf(buf,"Max Header size: %d<br/>\r\n", svr->GetMaxHeaderSize()); |
WiredHome | 3:17928786bdb5 | 348 | * svr->send(buf); |
WiredHome | 3:17928786bdb5 | 349 | * svr->send("<br/><a href='/'>back to main</a></body></html>\r\n"); |
WiredHome | 3:17928786bdb5 | 350 | * ret = true; |
WiredHome | 3:17928786bdb5 | 351 | * break; |
WiredHome | 3:17928786bdb5 | 352 | * case HTTPServer::CONTENT_LENGTH_REQUEST: |
WiredHome | 3:17928786bdb5 | 353 | * ret = true; |
WiredHome | 3:17928786bdb5 | 354 | * break; |
WiredHome | 3:17928786bdb5 | 355 | * case HTTPServer::DATA_TRANSFER: |
WiredHome | 3:17928786bdb5 | 356 | * ret = true; |
WiredHome | 3:17928786bdb5 | 357 | * break; |
WiredHome | 3:17928786bdb5 | 358 | * default: |
WiredHome | 3:17928786bdb5 | 359 | * ret = false; |
WiredHome | 3:17928786bdb5 | 360 | * break; |
WiredHome | 3:17928786bdb5 | 361 | * } |
WiredHome | 3:17928786bdb5 | 362 | * return ret; |
WiredHome | 3:17928786bdb5 | 363 | * } |
WiredHome | 3:17928786bdb5 | 364 | * @endcode |
WiredHome | 3:17928786bdb5 | 365 | * |
WiredHome | 0:729320f63c5c | 366 | * @param path to register |
WiredHome | 0:729320f63c5c | 367 | * @param callback of type Handler |
WiredHome | 0:729320f63c5c | 368 | * @return true if successfully registered |
WiredHome | 0:729320f63c5c | 369 | */ |
WiredHome | 0:729320f63c5c | 370 | bool RegisterHandler(const char * path, Handler callback); |
WiredHome | 12:109bf1558300 | 371 | |
WiredHome | 0:729320f63c5c | 372 | /** |
WiredHome | 16:6ebacf2946d8 | 373 | * determine if the named file is a supported type (htm, html, jpg, etc) |
WiredHome | 0:729320f63c5c | 374 | * |
WiredHome | 3:17928786bdb5 | 375 | * if you pass in a filename, it will attempt to extract the extension |
WiredHome | 3:17928786bdb5 | 376 | * and compare that to the list of supported file types. If it finds a |
WiredHome | 3:17928786bdb5 | 377 | * match, then it will return a pointer to the content-type string. |
WiredHome | 3:17928786bdb5 | 378 | * |
WiredHome | 3:17928786bdb5 | 379 | * @code |
WiredHome | 3:17928786bdb5 | 380 | * fType = GetSupportedType("mypix.jpg"); |
WiredHome | 3:17928786bdb5 | 381 | * if (fType) { |
WiredHome | 3:17928786bdb5 | 382 | * ... |
WiredHome | 3:17928786bdb5 | 383 | * @endcode |
WiredHome | 12:109bf1558300 | 384 | * |
WiredHome | 0:729320f63c5c | 385 | * @param filename is the filename to test, based on the extension |
WiredHome | 0:729320f63c5c | 386 | * @return pointer to a Content-Type string if supported, or NULL if not. |
WiredHome | 0:729320f63c5c | 387 | */ |
WiredHome | 0:729320f63c5c | 388 | const char * GetSupportedType(const char * filename); |
WiredHome | 0:729320f63c5c | 389 | |
WiredHome | 0:729320f63c5c | 390 | /** |
WiredHome | 39:0427544a5c08 | 391 | * search the available query parameters for 'name' and if found, return the 'value' |
WiredHome | 0:729320f63c5c | 392 | * |
WiredHome | 12:109bf1558300 | 393 | * After the querystring is parsed, the server maintains an array of |
WiredHome | 3:17928786bdb5 | 394 | * name=value pairs. This Get function will search for the passed in name |
WiredHome | 3:17928786bdb5 | 395 | * and provide access to the value. |
WiredHome | 3:17928786bdb5 | 396 | * |
WiredHome | 3:17928786bdb5 | 397 | * @code |
WiredHome | 3:17928786bdb5 | 398 | * BusOut leds(LED1,LED2,LED3,LED4); |
WiredHome | 3:17928786bdb5 | 399 | * ... |
WiredHome | 3:17928786bdb5 | 400 | * leds = atoi(svr->GetParameter("leds")); |
WiredHome | 3:17928786bdb5 | 401 | * @endcode |
WiredHome | 3:17928786bdb5 | 402 | * |
WiredHome | 0:729320f63c5c | 403 | * @param name is the name to search for |
WiredHome | 0:729320f63c5c | 404 | * @return pointer to the value, or NULL |
WiredHome | 0:729320f63c5c | 405 | */ |
WiredHome | 0:729320f63c5c | 406 | const char * GetParameter(const char * name); |
WiredHome | 0:729320f63c5c | 407 | |
WiredHome | 0:729320f63c5c | 408 | /** |
WiredHome | 39:0427544a5c08 | 409 | * get a pointer to a name-value pair based on the index. |
WiredHome | 39:0427544a5c08 | 410 | * |
WiredHome | 39:0427544a5c08 | 411 | * @param index is the item being referenced |
WiredHome | 39:0427544a5c08 | 412 | * @return pointer to the namevalue, or NULL |
WiredHome | 39:0427544a5c08 | 413 | */ |
WiredHome | 39:0427544a5c08 | 414 | namevalue * GetParameter(int index); |
WiredHome | 39:0427544a5c08 | 415 | |
WiredHome | 39:0427544a5c08 | 416 | /** |
WiredHome | 39:0427544a5c08 | 417 | * Get the count of query parameters from the active transaction. |
WiredHome | 39:0427544a5c08 | 418 | * |
WiredHome | 39:0427544a5c08 | 419 | * @returns count of parameters. |
WiredHome | 39:0427544a5c08 | 420 | */ |
WiredHome | 39:0427544a5c08 | 421 | int GetParameterCount(void) |
WiredHome | 39:0427544a5c08 | 422 | { |
WiredHome | 39:0427544a5c08 | 423 | return queryParamCount; |
WiredHome | 39:0427544a5c08 | 424 | }; |
WiredHome | 39:0427544a5c08 | 425 | |
WiredHome | 39:0427544a5c08 | 426 | /** |
WiredHome | 39:0427544a5c08 | 427 | * search the available post parameters for 'name' and if found, return the 'value' |
WiredHome | 39:0427544a5c08 | 428 | * |
WiredHome | 39:0427544a5c08 | 429 | * After the post parameter string is parsed, the server maintains an array of |
WiredHome | 39:0427544a5c08 | 430 | * name=value pairs. This Get function will search for the passed in name |
WiredHome | 39:0427544a5c08 | 431 | * and provide access to the value. |
WiredHome | 39:0427544a5c08 | 432 | * |
WiredHome | 39:0427544a5c08 | 433 | * @code |
WiredHome | 39:0427544a5c08 | 434 | * BusOut leds(LED1,LED2,LED3,LED4); |
WiredHome | 39:0427544a5c08 | 435 | * ... |
WiredHome | 39:0427544a5c08 | 436 | * leds = atoi(svr->GetPostParameter("leds")); |
WiredHome | 39:0427544a5c08 | 437 | * @endcode |
WiredHome | 39:0427544a5c08 | 438 | * |
WiredHome | 39:0427544a5c08 | 439 | * @param name is the name to search for |
WiredHome | 39:0427544a5c08 | 440 | * @return pointer to the value, or NULL |
WiredHome | 39:0427544a5c08 | 441 | */ |
WiredHome | 39:0427544a5c08 | 442 | const char * GetPostParameter(const char * name); |
WiredHome | 39:0427544a5c08 | 443 | |
WiredHome | 39:0427544a5c08 | 444 | /** |
WiredHome | 39:0427544a5c08 | 445 | * get a pointer to a post parameter name-value pair based on the index. |
WiredHome | 39:0427544a5c08 | 446 | * |
WiredHome | 39:0427544a5c08 | 447 | * @param index is the item being referenced |
WiredHome | 39:0427544a5c08 | 448 | * @return pointer to the namevalue, or NULL |
WiredHome | 39:0427544a5c08 | 449 | */ |
WiredHome | 39:0427544a5c08 | 450 | namevalue * GetPostParameter(int index); |
WiredHome | 39:0427544a5c08 | 451 | |
WiredHome | 39:0427544a5c08 | 452 | /** |
WiredHome | 39:0427544a5c08 | 453 | * Get the count of post parameters from the active transaction. |
WiredHome | 39:0427544a5c08 | 454 | * |
WiredHome | 39:0427544a5c08 | 455 | * @returns count of parameters. |
WiredHome | 39:0427544a5c08 | 456 | */ |
WiredHome | 39:0427544a5c08 | 457 | int GetPostParameterCount(void) |
WiredHome | 39:0427544a5c08 | 458 | { |
WiredHome | 39:0427544a5c08 | 459 | return postParamCount; |
WiredHome | 39:0427544a5c08 | 460 | }; |
WiredHome | 39:0427544a5c08 | 461 | |
WiredHome | 39:0427544a5c08 | 462 | /** |
WiredHome | 12:109bf1558300 | 463 | * Parse the text string into name=value parameters. |
WiredHome | 3:17928786bdb5 | 464 | * |
WiredHome | 12:109bf1558300 | 465 | * This will directly modify the referenced string. If there is a |
WiredHome | 3:17928786bdb5 | 466 | * #fragment_id on the end of the string, it will be removed. |
WiredHome | 0:729320f63c5c | 467 | * |
WiredHome | 39:0427544a5c08 | 468 | * @param qP is a pointer to a namevalue set |
WiredHome | 39:0427544a5c08 | 469 | * @param qpCount is a pointer to a counter of what is in the set |
WiredHome | 39:0427544a5c08 | 470 | * @param maxP is the maximum number of parameters for which space has been allocated. |
WiredHome | 39:0427544a5c08 | 471 | * @param pName is a pointer to the string. |
WiredHome | 37:0cb2774e2410 | 472 | * @returns The total number of items that have been parsed, |
WiredHome | 37:0cb2774e2410 | 473 | * which can include a count from a url query string. |
WiredHome | 0:729320f63c5c | 474 | */ |
WiredHome | 39:0427544a5c08 | 475 | int ParseParameters(namevalue * qP, int * qpCount, int maxP, char * pName); |
WiredHome | 12:109bf1558300 | 476 | |
WiredHome | 0:729320f63c5c | 477 | /** |
WiredHome | 16:6ebacf2946d8 | 478 | * Unescape string converts a coded string "in place" into a normal string. |
WiredHome | 3:17928786bdb5 | 479 | * |
WiredHome | 3:17928786bdb5 | 480 | * A query string will have a number of characters replaced for communication |
WiredHome | 3:17928786bdb5 | 481 | * which includes spaces, quotes, question marks and more. Most of them |
WiredHome | 12:109bf1558300 | 482 | * will be replaced with a %xx format, where xx is the hex code for the |
WiredHome | 3:17928786bdb5 | 483 | * character. Since the string will only get shorter when this happens |
WiredHome | 3:17928786bdb5 | 484 | * the operation is performed in place. |
WiredHome | 3:17928786bdb5 | 485 | * |
WiredHome | 0:729320f63c5c | 486 | * this "This%20is%20a%20question%3F%20and%20an%20answer." |
WiredHome | 12:109bf1558300 | 487 | * |
WiredHome | 0:729320f63c5c | 488 | * becomes "This is a question? and an answer." |
WiredHome | 3:17928786bdb5 | 489 | * |
WiredHome | 0:729320f63c5c | 490 | * @note '+' is another form of space, so is converted to a space before the %xx |
WiredHome | 0:729320f63c5c | 491 | * |
WiredHome | 0:729320f63c5c | 492 | * @param encoded string to be converted |
WiredHome | 0:729320f63c5c | 493 | */ |
WiredHome | 0:729320f63c5c | 494 | void UnescapeString(char * encoded); |
WiredHome | 12:109bf1558300 | 495 | |
WiredHome | 12:109bf1558300 | 496 | /** |
WiredHome | 16:6ebacf2946d8 | 497 | * This is used to force a connection to close. |
WiredHome | 3:17928786bdb5 | 498 | * |
WiredHome | 3:17928786bdb5 | 499 | * This switches the module into command mode, performs the close, |
WiredHome | 3:17928786bdb5 | 500 | * then switches it back to data mode. So, this is a time-expensive |
WiredHome | 3:17928786bdb5 | 501 | * command. |
WiredHome | 7:99ad7a67f05e | 502 | * |
WiredHome | 7:99ad7a67f05e | 503 | * @returns true if successful |
WiredHome | 0:729320f63c5c | 504 | */ |
WiredHome | 7:99ad7a67f05e | 505 | bool close_connection(); |
WiredHome | 12:109bf1558300 | 506 | |
WiredHome | 3:17928786bdb5 | 507 | /** |
WiredHome | 16:6ebacf2946d8 | 508 | * Diagnostic to get the size of the largest header. |
WiredHome | 3:17928786bdb5 | 509 | * |
WiredHome | 12:109bf1558300 | 510 | * This is a diagnostic function, so you can resize the allocated |
WiredHome | 12:109bf1558300 | 511 | * buffer for your application. With proper sizing, more of the |
WiredHome | 3:17928786bdb5 | 512 | * system memory is available for your application. |
WiredHome | 3:17928786bdb5 | 513 | * |
WiredHome | 3:17928786bdb5 | 514 | * @code |
WiredHome | 3:17928786bdb5 | 515 | * sprintf(buf,"Max Header size: %d<br/>\r\n", svr->GetMaxHeaderSize()); |
WiredHome | 3:17928786bdb5 | 516 | * svr->send(buf); |
WiredHome | 3:17928786bdb5 | 517 | * @endcode |
WiredHome | 12:109bf1558300 | 518 | * |
WiredHome | 3:17928786bdb5 | 519 | * @returns size in bytes of the larger header measured. |
WiredHome | 3:17928786bdb5 | 520 | */ |
WiredHome | 3:17928786bdb5 | 521 | int GetMaxHeaderSize(); |
WiredHome | 3:17928786bdb5 | 522 | |
WiredHome | 13:8975d7928678 | 523 | /** |
WiredHome | 16:6ebacf2946d8 | 524 | * Get a value from the http header, if it exists. |
WiredHome | 13:8975d7928678 | 525 | * |
WiredHome | 13:8975d7928678 | 526 | * @param hdr is the string to search for (e.g. "Content-Length") |
WiredHome | 13:8975d7928678 | 527 | * |
WiredHome | 13:8975d7928678 | 528 | * @returns pointer to the value associated with that header. |
WiredHome | 13:8975d7928678 | 529 | * @returns NULL if the header is not found. |
WiredHome | 13:8975d7928678 | 530 | */ |
WiredHome | 13:8975d7928678 | 531 | const char * GetHeaderValue(const char * hdr); |
WiredHome | 3:17928786bdb5 | 532 | |
WiredHome | 3:17928786bdb5 | 533 | /** |
WiredHome | 3:17928786bdb5 | 534 | * Performance parameter |
WiredHome | 3:17928786bdb5 | 535 | */ |
WiredHome | 3:17928786bdb5 | 536 | typedef struct SW_PERFPARAM { |
WiredHome | 3:17928786bdb5 | 537 | unsigned long long TotalTime_us; |
WiredHome | 3:17928786bdb5 | 538 | unsigned long Samples; |
WiredHome | 3:17928786bdb5 | 539 | unsigned long MaxTime_us; |
WiredHome | 3:17928786bdb5 | 540 | } SW_PerformanceParam; |
WiredHome | 12:109bf1558300 | 541 | |
WiredHome | 3:17928786bdb5 | 542 | /** |
WiredHome | 3:17928786bdb5 | 543 | * Performance metrics |
WiredHome | 3:17928786bdb5 | 544 | */ |
WiredHome | 3:17928786bdb5 | 545 | typedef struct SW_PERFDATA { |
WiredHome | 17:69ff00ce39f4 | 546 | SW_PerformanceParam ConnectionAccepted; |
WiredHome | 17:69ff00ce39f4 | 547 | SW_PerformanceParam HeaderParsed; |
WiredHome | 17:69ff00ce39f4 | 548 | SW_PerformanceParam ResponseSent; |
WiredHome | 17:69ff00ce39f4 | 549 | SW_PerformanceParam ConnectionClosed; |
WiredHome | 3:17928786bdb5 | 550 | //SW_PerformanceParam SendFile; |
WiredHome | 3:17928786bdb5 | 551 | } SW_PerformanceData; |
WiredHome | 12:109bf1558300 | 552 | |
WiredHome | 3:17928786bdb5 | 553 | /** |
WiredHome | 3:17928786bdb5 | 554 | * Get performance metrics from the web server. |
WiredHome | 3:17928786bdb5 | 555 | * |
WiredHome | 3:17928786bdb5 | 556 | * This is a diagnostic function, and gathers data on the internal |
WiredHome | 3:17928786bdb5 | 557 | * performance of the server, as it works various actions. |
WiredHome | 3:17928786bdb5 | 558 | * |
WiredHome | 3:17928786bdb5 | 559 | * @param p is a pointer to a SW_PerformanceData structure to be populated |
WiredHome | 3:17928786bdb5 | 560 | */ |
WiredHome | 3:17928786bdb5 | 561 | void GetPerformanceData(SW_PerformanceData * p); |
WiredHome | 12:109bf1558300 | 562 | |
WiredHome | 3:17928786bdb5 | 563 | /** |
WiredHome | 3:17928786bdb5 | 564 | * Reset performance metrics. |
WiredHome | 3:17928786bdb5 | 565 | */ |
WiredHome | 3:17928786bdb5 | 566 | void ResetPerformanceData(); |
WiredHome | 17:69ff00ce39f4 | 567 | |
WiredHome | 17:69ff00ce39f4 | 568 | /** |
WiredHome | 17:69ff00ce39f4 | 569 | * Get performance clock |
WiredHome | 17:69ff00ce39f4 | 570 | */ |
WiredHome | 17:69ff00ce39f4 | 571 | unsigned int GetPerformanceClock(); |
WiredHome | 12:109bf1558300 | 572 | |
WiredHome | 0:729320f63c5c | 573 | private: |
WiredHome | 0:729320f63c5c | 574 | char * webroot; |
WiredHome | 0:729320f63c5c | 575 | PC * pc; |
WiredHome | 0:729320f63c5c | 576 | TCPSocketServer * server; |
WiredHome | 0:729320f63c5c | 577 | TCPSocketConnection client; |
WiredHome | 0:729320f63c5c | 578 | char * rewriteWithDefaultFile(char * queryString); |
WiredHome | 0:729320f63c5c | 579 | char * rewritePrependWebroot(char * queryString); |
WiredHome | 13:8975d7928678 | 580 | |
WiredHome | 13:8975d7928678 | 581 | namevalue *queryParams; // Query Parameters from the URL this=that&sky=blue&... |
WiredHome | 13:8975d7928678 | 582 | int maxqueryParams; |
WiredHome | 13:8975d7928678 | 583 | int queryParamCount; |
WiredHome | 13:8975d7928678 | 584 | |
WiredHome | 39:0427544a5c08 | 585 | namevalue *postParams; // Same as Query params, but for post method |
WiredHome | 39:0427544a5c08 | 586 | int maxPostParams; |
WiredHome | 39:0427544a5c08 | 587 | int postParamCount; |
WiredHome | 39:0427544a5c08 | 588 | |
WiredHome | 13:8975d7928678 | 589 | namevalue *headerParams; // Header params Host: 192.168...\r\nConnection: keep-alive\r\n... |
WiredHome | 13:8975d7928678 | 590 | int maxheaderParams; |
WiredHome | 13:8975d7928678 | 591 | int headerParamCount; |
WiredHome | 13:8975d7928678 | 592 | |
WiredHome | 3:17928786bdb5 | 593 | int maxheaderbytes; |
WiredHome | 3:17928786bdb5 | 594 | char * headerbuffer; |
WiredHome | 3:17928786bdb5 | 595 | int headerbuffersize; |
WiredHome | 12:109bf1558300 | 596 | |
WiredHome | 10:9c8d2c6a3469 | 597 | Timer PerformanceTimer; |
WiredHome | 3:17928786bdb5 | 598 | /** |
WiredHome | 3:17928786bdb5 | 599 | * Records performance data |
WiredHome | 12:109bf1558300 | 600 | * |
WiredHome | 3:17928786bdb5 | 601 | * This will take a pointer to a SW_PerformanceParam, and it will |
WiredHome | 3:17928786bdb5 | 602 | * take the time when the performance measurement started. It locally |
WiredHome | 3:17928786bdb5 | 603 | * accesses the current time to measure the elapsed. |
WiredHome | 3:17928786bdb5 | 604 | * |
WiredHome | 3:17928786bdb5 | 605 | * @param param is the performance parameter to update |
WiredHome | 3:17928786bdb5 | 606 | * @param value is the reference time. |
WiredHome | 3:17928786bdb5 | 607 | * @returns the current time which may be used as the reference time |
WiredHome | 3:17928786bdb5 | 608 | * for further measurements. |
WiredHome | 3:17928786bdb5 | 609 | */ |
WiredHome | 16:6ebacf2946d8 | 610 | unsigned int RecordPerformanceData(SW_PerformanceParam * param, unsigned int value); |
WiredHome | 3:17928786bdb5 | 611 | SW_PerformanceData perfData; |
WiredHome | 12:109bf1558300 | 612 | |
WiredHome | 3:17928786bdb5 | 613 | typedef struct HANDLER { |
WiredHome | 0:729320f63c5c | 614 | char * path; |
WiredHome | 0:729320f63c5c | 615 | Handler callback; |
WiredHome | 0:729320f63c5c | 616 | } handler; |
WiredHome | 0:729320f63c5c | 617 | int maxdynamicpages; |
WiredHome | 0:729320f63c5c | 618 | handler *handlers; |
WiredHome | 0:729320f63c5c | 619 | int handlercount; |
WiredHome | 3:17928786bdb5 | 620 | |
WiredHome | 3:17928786bdb5 | 621 | char * queryType; |
WiredHome | 39:0427544a5c08 | 622 | char * queryString; // the query string [and 'GET' data] passed on the URL (e.g. ?name1=value1&name2=value2...) |
WiredHome | 39:0427544a5c08 | 623 | char * postQueryString; // the post data |
WiredHome | 12:109bf1558300 | 624 | |
WiredHome | 0:729320f63c5c | 625 | /** |
WiredHome | 8:262583f054f6 | 626 | * Extract the parameter from the record, by searching for the needle in the haystack. |
WiredHome | 8:262583f054f6 | 627 | * |
WiredHome | 8:262583f054f6 | 628 | * The parameter of interest follows the needle, and may be ' ' delimited |
WiredHome | 0:729320f63c5c | 629 | * Can damage haystack while processing it. |
WiredHome | 0:729320f63c5c | 630 | * |
WiredHome | 0:729320f63c5c | 631 | * @param haystack is the record to search |
WiredHome | 0:729320f63c5c | 632 | * @param needle is the text to search for, which precedes the text to return |
WiredHome | 0:729320f63c5c | 633 | * @param string is the text following the needle |
WiredHome | 0:729320f63c5c | 634 | * @return true if it extracted something successfully |
WiredHome | 0:729320f63c5c | 635 | */ |
WiredHome | 0:729320f63c5c | 636 | bool Extract(char * rec, char * needle, char ** string); |
WiredHome | 0:729320f63c5c | 637 | |
WiredHome | 3:17928786bdb5 | 638 | void SendResponse(); |
WiredHome | 29:00116fc9da74 | 639 | HTTPServer::CallBackResults ParseHeader(char * bPtr); |
WiredHome | 3:17928786bdb5 | 640 | bool CheckDynamicHandlers(); |
WiredHome | 3:17928786bdb5 | 641 | |
WiredHome | 0:729320f63c5c | 642 | int HexCharToInt(char c); |
WiredHome | 0:729320f63c5c | 643 | char HexPairToChar(char * p); |
WiredHome | 29:00116fc9da74 | 644 | |
WiredHome | 29:00116fc9da74 | 645 | #ifdef DEBUG |
WiredHome | 29:00116fc9da74 | 646 | void * MyMalloc(int x, int y); |
WiredHome | 29:00116fc9da74 | 647 | char toP(void * x); |
WiredHome | 29:00116fc9da74 | 648 | #endif |
WiredHome | 0:729320f63c5c | 649 | }; |
WiredHome | 0:729320f63c5c | 650 | #endif //SW_HTTPSERVER_H |
WiredHome | 4:f34642902056 | 651 | |
WiredHome | 7:99ad7a67f05e | 652 |