raf vervoort / HTTPServer

Team E1

Fork of HTTPServer by Sam Kirsch

HTTPServer.h@14:011edcd33e86, 2013-08-17 (annotated)

Committer:
leihen
Date:
Sat Aug 17 12:12:13 2013 +0000
Revision:
14:011edcd33e86
Parent:
13:aa5338a5e452 
Changed behaviour, so that now an EthernetInterface can be provided by user of the library as an alternative to having the HTTPServer being the owner.

; Example documentation Extended.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
leihen 0:7a2421e63e74 1 /* HTTPServer.cpp */
leihen 3:d6224049b3bf 2 /*
leihen 3:d6224049b3bf 3 Copyright (c) 2013 Henry Leinen (henry[dot]leinen [at] online [dot] de)
leihen 3:d6224049b3bf 4
leihen 3:d6224049b3bf 5 Permission is hereby granted, free of charge, to any person obtaining a copy
leihen 3:d6224049b3bf 6 of this software and associated documentation files (the "Software"), to deal
leihen 3:d6224049b3bf 7 in the Software without restriction, including without limitation the rights
leihen 3:d6224049b3bf 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
leihen 3:d6224049b3bf 9 copies of the Software, and to permit persons to whom the Software is
leihen 3:d6224049b3bf 10 furnished to do so, subject to the following conditions:
leihen 3:d6224049b3bf 11
leihen 3:d6224049b3bf 12 The above copyright notice and this permission notice shall be included in
leihen 3:d6224049b3bf 13 all copies or substantial portions of the Software.
leihen 3:d6224049b3bf 14
leihen 3:d6224049b3bf 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
leihen 3:d6224049b3bf 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
leihen 3:d6224049b3bf 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
leihen 3:d6224049b3bf 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
leihen 3:d6224049b3bf 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
leihen 3:d6224049b3bf 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
leihen 3:d6224049b3bf 21 THE SOFTWARE.
leihen 3:d6224049b3bf 22 */
leihen 0:7a2421e63e74 23 #ifndef __HTTPSERVER_H__
leihen 0:7a2421e63e74 24 #define __HTTPSERVER_H__
leihen 0:7a2421e63e74 25 #include "mbed.h"
leihen 13:aa5338a5e452 26 #include "EthernetInterface.h"
leihen 0:7a2421e63e74 27 #include "HTTPConnection.h"
leihen 1:6b7472d5e9ee 28 #include "HTTPRequestHandler.h"
leihen 1:6b7472d5e9ee 29
leihen 1:6b7472d5e9ee 30 #include <map>
leihen 1:6b7472d5e9ee 31 using std::map;
leihen 1:6b7472d5e9ee 32 #include <string>
leihen 1:6b7472d5e9ee 33 using std::string;
leihen 0:7a2421e63e74 34
leihen 0:7a2421e63e74 35 #include <TCPSocketConnection.h>
leihen 0:7a2421e63e74 36 #include <TCPSocketServer.h>
leihen 0:7a2421e63e74 37
leihen 3:d6224049b3bf 38 /** Typedefinition for a handler function
leihen 3:d6224049b3bf 39 */
leihen 3:d6224049b3bf 40 typedef void (*HTTPRequestHandlerFunction)(HTTPConnection::HTTPMessage&, TCPSocketConnection&);
leihen 3:d6224049b3bf 41
leihen 1:6b7472d5e9ee 42
leihen 3:d6224049b3bf 43 /** Class HTTPServer for use with <a href="http://mbed.org/users/samux/code/WiflyInterface/">WiflyInterface</a>.
leihen 3:d6224049b3bf 44 * This class is a simple implementation of an HTTP Server for use with the WiFly interface.
leihen 3:d6224049b3bf 45 * The class will listen for incoming connections on the (configurable) HTTP port. For each
leihen 3:d6224049b3bf 46 * incoming connection, one request will be processed.
leihen 3:d6224049b3bf 47 * After instantiating this class, add all required handlers using the \c addHandler function,
leihen 3:d6224049b3bf 48 * replace the default error handler using \c addErrorHandler if needed and call the \c start
leihen 3:d6224049b3bf 49 * method to initialize the class.
leihen 3:d6224049b3bf 50 * You need to continuously poll for any new incoming connections after one request has been
leihen 3:d6224049b3bf 51 * served using the \c poll member function.
leihen 3:d6224049b3bf 52 *
leihen 3:d6224049b3bf 53 * \b Example:
leihen 3:d6224049b3bf 54 * @code
leihen 3:d6224049b3bf 55 * #include "mbed.h"
leihen 3:d6224049b3bf 56 * #include "HTTPServer.h"
leihen 3:d6224049b3bf 57 * #include "LocalFileSystem.h"
leihen 3:d6224049b3bf 58 *
leihen 3:d6224049b3bf 59 * LocalFileSystem local("local");
leihen 3:d6224049b3bf 60 *
leihen 3:d6224049b3bf 61 * void main(void)
leihen 3:d6224049b3bf 62 * {
leihen 3:d6224049b3bf 63 * HTTPServer svr;
leihen 14:011edcd33e86 64 * svr.mount("/local/", "/");
leihen 3:d6224049b3bf 65 * svr.addHandler<HTTPFsRequestHandler>( "/" );
leihen 3:d6224049b3bf 66 * svr.start();
leihen 3:d6224049b3bf 67 * while(1)
leihen 3:d6224049b3bf 68 * {
leihen 3:d6224049b3bf 69 * if (svr.poll() < 0)
leihen 3:d6224049b3bf 70 * exit(0);
leihen 3:d6224049b3bf 71 * }
leihen 3:d6224049b3bf 72 * }
leihen 3:d6224049b3bf 73 * @endcode
leihen 14:011edcd33e86 74 *
leihen 14:011edcd33e86 75 * An alternate approach e.g. if you need to perform additional tasks using the EthernetInterface
leihen 14:011edcd33e86 76 * there is the possibility to provide the EthernetInterface object in an initialized and connected
leihen 14:011edcd33e86 77 * state. __NOTE: You should choose this scenario for compatibility reasons.___
leihen 14:011edcd33e86 78 *
leihen 14:011edcd33e86 79 * \b Example2:
leihen 14:011edcd33e86 80 * @code
leihen 14:011edcd33e86 81 * #include "mbed.h"
leihen 14:011edcd33e86 82 * #include "HTTPServer.h"
leihen 14:011edcd33e86 83 * #include "EthernetInterface.h"
leihen 14:011edcd33e86 84 * #include "LocalFileSystem.h"
leihen 14:011edcd33e86 85 *
leihen 14:011edcd33e86 86 * LocalFileSystem local("local");
leihen 14:011edcd33e86 87 * EthernetInterface eth;
leihen 14:011edcd33e86 88 *
leihen 14:011edcd33e86 89 * void main(void)
leihen 14:011edcd33e86 90 * {
leihen 14:011edcd33e86 91 * HTTPServer svr;
leihen 14:011edcd33e86 92 * // Initialize the ethernet interface
leihen 14:011edcd33e86 93 * if (eth.init() != 0) {
leihen 14:011edcd33e86 94 * printf("Initialization of EthernetInterface failed !");
leihen 14:011edcd33e86 95 * exit(0);
leihen 14:011edcd33e86 96 * }
leihen 14:011edcd33e86 97 * // Connect using DHCP
leihen 14:011edcd33e86 98 * if (eth.connect() !=0) {
leihen 14:011edcd33e86 99 * printf("Failed to connect using DHCP !");
leihen 14:011edcd33e86 100 * exit(0);
leihen 14:011edcd33e86 101 * }
leihen 14:011edcd33e86 102 *
leihen 14:011edcd33e86 103 * // Moint the local file system and provide a handler for 'root'.
leihen 14:011edcd33e86 104 * svr.mount("/local/", "/");
leihen 14:011edcd33e86 105 * svr.addHandler<HTTPFsRequestHandler>( "/" );
leihen 14:011edcd33e86 106 * // Start the server on port 80, providing our own ethernet interface object.
leihen 14:011edcd33e86 107 * svr.start(80, &eth);
leihen 14:011edcd33e86 108 * while(1)
leihen 14:011edcd33e86 109 * {
leihen 14:011edcd33e86 110 * if (svr.poll() < 0)
leihen 14:011edcd33e86 111 * exit(0);
leihen 14:011edcd33e86 112 * }
leihen 14:011edcd33e86 113 * }
leihen 14:011edcd33e86 114 * @endcode
leihen 14:011edcd33e86 115 *
leihen 3:d6224049b3bf 116 */
leihen 3:d6224049b3bf 117 class HTTPServer
leihen 3:d6224049b3bf 118 {
leihen 13:aa5338a5e452 119 TCPSocketServer m_Svr;
leihen 4:d065642c32cc 120 bool m_bServerListening;
leihen 14:011edcd33e86 121 EthernetInterface* m_pEthernet;
leihen 14:011edcd33e86 122
leihen 0:7a2421e63e74 123 public:
leihen 3:d6224049b3bf 124 /** Constructor for HTTPServer objects.
leihen 3:d6224049b3bf 125 */
leihen 13:aa5338a5e452 126 HTTPServer();
leihen 3:d6224049b3bf 127
leihen 3:d6224049b3bf 128 /** Destructor for HTTPServer objects.
leihen 3:d6224049b3bf 129 */
leihen 0:7a2421e63e74 130 ~HTTPServer();
leihen 1:6b7472d5e9ee 131
leihen 4:d065642c32cc 132 /**
leihen 4:d065642c32cc 133 * Structure which will allow to order the stored handlers according to their associated path.
leihen 4:d065642c32cc 134 */
leihen 0:7a2421e63e74 135 struct handlersComp //Used to order handlers in the right way
leihen 0:7a2421e63e74 136 {
leihen 0:7a2421e63e74 137 bool operator() (const string& handler1, const string& handler2) const
leihen 0:7a2421e63e74 138 {
leihen 3:d6224049b3bf 139 //The first handler is longer than the second one
leihen 3:d6224049b3bf 140 if (handler1.length() > handler2.length())
leihen 3:d6224049b3bf 141 return true; //Returns true if handler1 is to appear before handler2
leihen 3:d6224049b3bf 142 else if (handler1.length() < handler2.length())
leihen 3:d6224049b3bf 143 return false;
leihen 3:d6224049b3bf 144 else //To avoid the == case, sort now by address
leihen 3:d6224049b3bf 145 return ((&handler1)>(&handler2));
leihen 0:7a2421e63e74 146 }
leihen 0:7a2421e63e74 147 };
leihen 1:6b7472d5e9ee 148
leihen 0:7a2421e63e74 149 /**
leihen 4:d065642c32cc 150 * Adds a request handler to the handlers list. You will have to use one of the existing implementations.
leihen 4:d065642c32cc 151 * With each handler a \c uri or \c path is associated. Whenever a request is received the server will
leihen 4:d065642c32cc 152 * walk through all registered handlers and check which \c path is matching.
leihen 4:d065642c32cc 153 * @param T : class which will be instanciated to serve these requests for the associated \b path.
leihen 4:d065642c32cc 154 * @param path : request uri starting with this \c path will be served using this handler.
leihen 0:7a2421e63e74 155 */
leihen 3:d6224049b3bf 156 template<typename T>
leihen 3:d6224049b3bf 157 void addHandler(const char* path)
leihen 3:d6224049b3bf 158 { m_lpHandlers[path] = &T::create; }
leihen 2:8653bbcf7e58 159
leihen 3:d6224049b3bf 160 /**
leihen 4:d065642c32cc 161 * Replaces the standard error Handler. The error Handler will be called everytime a request is not
leihen 4:d065642c32cc 162 * matching any of the registered \c paths or \c uris.
leihen 4:d065642c32cc 163 * @param hdlFunc: User specified handler function which will be used in error conditions.
leihen 3:d6224049b3bf 164 */
leihen 2:8653bbcf7e58 165 void addErrorHandler(HTTPRequestHandlerFunction hdlFunc)
leihen 2:8653bbcf7e58 166 { m_pErrorHandler = hdlFunc!=NULL ?hdlFunc : StdErrorHandler; }
leihen 3:d6224049b3bf 167
leihen 3:d6224049b3bf 168 /** Binds server to a specific port and starts listening. This member prepares the internal variables and the server socket
leihen 3:d6224049b3bf 169 * and terminates after successfull initialization
leihen 3:d6224049b3bf 170 * @param port : port on which to listen for incoming connections
leihen 14:011edcd33e86 171 * @param pEthernet : a pointer to an existing EthernetInterface object or NULL if the HTTPServer shall allocate the object. _Please note that for compatibility reasons
leihen 14:011edcd33e86 172 * your should consider to create the EthernetInterface as a static variable. Otherwise the the object will be created on the heap._
leihen 14:011edcd33e86 173 * @returns : false if an unrecoverable error occured or if the ethernet interface was not set or not initialized correctly, or true if everything was ok.
leihen 0:7a2421e63e74 174 */
leihen 14:011edcd33e86 175 bool start(int port = 80, EthernetInterface* pEthernet = NULL);
leihen 0:7a2421e63e74 176
leihen 3:d6224049b3bf 177 /** Performs the regular polling of the server component. Needs to be called cyclically.
leihen 3:d6224049b3bf 178 * The function will internally check whether new connections are requested by a client and will also poll all existing client connections.
leihen 6:fe661fa9d18a 179 * @param blocking : if true,
leihen 4:d065642c32cc 180 * @returns -1 if there was a problem. If 0 is returned, the latest request was served successfully and the server is
leihen 4:d065642c32cc 181 * ready for processing the next request. Simply call \c poll as long as you want to serve new incoming requests.
leihen 0:7a2421e63e74 182 */
leihen 6:fe661fa9d18a 183 int poll(bool blocking = true);
leihen 14:011edcd33e86 184
leihen 4:d065642c32cc 185 private:
leihen 14:011edcd33e86 186
leihen 4:d065642c32cc 187 /** The standard error handler function.
leihen 4:d065642c32cc 188 * @param msg : Request message data.
leihen 4:d065642c32cc 189 * @param tcp : Socket to be used for responding.
leihen 4:d065642c32cc 190 */
leihen 4:d065642c32cc 191 static void StdErrorHandler(HTTPConnection::HTTPMessage& msg, TCPSocketConnection& tcp);
leihen 0:7a2421e63e74 192
leihen 4:d065642c32cc 193 /** Internal function which processes a request and which will try to find the matching handler function
leihen 4:d065642c32cc 194 * for the given request. Please note that the function will search through the list of handlers, iterating
leihen 4:d065642c32cc 195 * from longest to shortest \c paths. If the registered \c path is a subset of the request the associated
leihen 4:d065642c32cc 196 * handler is considered as being a match.
leihen 4:d065642c32cc 197 * @param msg : Request message data. Contains the requested logical \c uri.
leihen 4:d065642c32cc 198 * @param tcp : Socket to be used for communication with the client.
leihen 4:d065642c32cc 199 */
leihen 4:d065642c32cc 200 void HandleRequest(HTTPConnection::HTTPMessage& msg, TCPSocketConnection& tcp);
leihen 2:8653bbcf7e58 201
leihen 4:d065642c32cc 202 /** Map of handler objects. Can be any object derived from \ref HTTPRequestHeader. Use the \ref addHandler function
leihen 4:d065642c32cc 203 * to register new handler objects.
leihen 4:d065642c32cc 204 */
leihen 3:d6224049b3bf 205 map<string, HTTPRequestHandler* (*)(const char*, const char*, HTTPConnection::HTTPMessage&, TCPSocketConnection&), handlersComp> m_lpHandlers;
leihen 3:d6224049b3bf 206 HTTPRequestHandlerFunction m_pErrorHandler;
leihen 3:d6224049b3bf 207
leihen 0:7a2421e63e74 208 };
leihen 0:7a2421e63e74 209
leihen 0:7a2421e63e74 210 #endif //__HTTPSERVER_H__