raf vervoort / HTTPServer

Team E1

Fork of HTTPServer by Sam Kirsch

HTTPServer.h@6:fe661fa9d18a, 2013-06-01 (annotated)

Committer:
leihen
Date:
Sat Jun 01 16:49:17 2013 +0000
Revision:
6:fe661fa9d18a
Parent:
4:d065642c32cc
Child:
9:c2a1462b9b71
Added DEBUG preprocessor constant to each file.

; Added non-blocking polling function.

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 0:7a2421e63e74 26 #include "HTTPConnection.h"
leihen 1:6b7472d5e9ee 27 #include "HTTPRequestHandler.h"
leihen 1:6b7472d5e9ee 28
leihen 1:6b7472d5e9ee 29 #include <map>
leihen 1:6b7472d5e9ee 30 using std::map;
leihen 1:6b7472d5e9ee 31 #include <string>
leihen 1:6b7472d5e9ee 32 using std::string;
leihen 0:7a2421e63e74 33
leihen 0:7a2421e63e74 34 #include <TCPSocketConnection.h>
leihen 0:7a2421e63e74 35 #include <TCPSocketServer.h>
leihen 0:7a2421e63e74 36
leihen 3:d6224049b3bf 37 /** Typedefinition for a handler function
leihen 3:d6224049b3bf 38 */
leihen 3:d6224049b3bf 39 typedef void (*HTTPRequestHandlerFunction)(HTTPConnection::HTTPMessage&, TCPSocketConnection&);
leihen 3:d6224049b3bf 40
leihen 1:6b7472d5e9ee 41
leihen 3:d6224049b3bf 42 /** Class HTTPServer for use with <a href="http://mbed.org/users/samux/code/WiflyInterface/">WiflyInterface</a>.
leihen 3:d6224049b3bf 43 * This class is a simple implementation of an HTTP Server for use with the WiFly interface.
leihen 3:d6224049b3bf 44 * The class will listen for incoming connections on the (configurable) HTTP port. For each
leihen 3:d6224049b3bf 45 * incoming connection, one request will be processed.
leihen 3:d6224049b3bf 46 * After instantiating this class, add all required handlers using the \c addHandler function,
leihen 3:d6224049b3bf 47 * replace the default error handler using \c addErrorHandler if needed and call the \c start
leihen 3:d6224049b3bf 48 * method to initialize the class.
leihen 3:d6224049b3bf 49 * You need to continuously poll for any new incoming connections after one request has been
leihen 3:d6224049b3bf 50 * served using the \c poll member function.
leihen 3:d6224049b3bf 51 *
leihen 3:d6224049b3bf 52 * \b Example:
leihen 3:d6224049b3bf 53 * @code
leihen 3:d6224049b3bf 54 * #include "mbed.h"
leihen 3:d6224049b3bf 55 * #include "HTTPServer.h"
leihen 3:d6224049b3bf 56 * #include "LocalFileSystem.h"
leihen 3:d6224049b3bf 57 *
leihen 3:d6224049b3bf 58 * LocalFileSystem local("local");
leihen 3:d6224049b3bf 59 * WiflyInterface wifly(p9, p10, p25, p26, "<your access point>", "<your password>", WPA);
leihen 3:d6224049b3bf 60 *
leihen 3:d6224049b3bf 61 * void main(void)
leihen 3:d6224049b3bf 62 * {
leihen 3:d6224049b3bf 63 * HTTPServer svr;
leihen 3:d6224049b3bf 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 3:d6224049b3bf 74 */
leihen 3:d6224049b3bf 75 class HTTPServer
leihen 3:d6224049b3bf 76 {
leihen 4:d065642c32cc 77
leihen 4:d065642c32cc 78 TCPSocketServer* m_pSvr;
leihen 4:d065642c32cc 79 bool m_bServerListening;
leihen 4:d065642c32cc 80 Serial* m_pDbg;
leihen 4:d065642c32cc 81
leihen 0:7a2421e63e74 82 public:
leihen 3:d6224049b3bf 83 /** Constructor for HTTPServer objects.
leihen 3:d6224049b3bf 84 */
leihen 3:d6224049b3bf 85 HTTPServer(Serial* dbg = NULL);
leihen 3:d6224049b3bf 86
leihen 3:d6224049b3bf 87 /** Destructor for HTTPServer objects.
leihen 3:d6224049b3bf 88 */
leihen 0:7a2421e63e74 89 ~HTTPServer();
leihen 1:6b7472d5e9ee 90
leihen 4:d065642c32cc 91 /**
leihen 4:d065642c32cc 92 * Structure which will allow to order the stored handlers according to their associated path.
leihen 4:d065642c32cc 93 */
leihen 0:7a2421e63e74 94 struct handlersComp //Used to order handlers in the right way
leihen 0:7a2421e63e74 95 {
leihen 0:7a2421e63e74 96 bool operator() (const string& handler1, const string& handler2) const
leihen 0:7a2421e63e74 97 {
leihen 3:d6224049b3bf 98 //The first handler is longer than the second one
leihen 3:d6224049b3bf 99 if (handler1.length() > handler2.length())
leihen 3:d6224049b3bf 100 return true; //Returns true if handler1 is to appear before handler2
leihen 3:d6224049b3bf 101 else if (handler1.length() < handler2.length())
leihen 3:d6224049b3bf 102 return false;
leihen 3:d6224049b3bf 103 else //To avoid the == case, sort now by address
leihen 3:d6224049b3bf 104 return ((&handler1)>(&handler2));
leihen 0:7a2421e63e74 105 }
leihen 0:7a2421e63e74 106 };
leihen 1:6b7472d5e9ee 107
leihen 0:7a2421e63e74 108 /**
leihen 4:d065642c32cc 109 * Adds a request handler to the handlers list. You will have to use one of the existing implementations.
leihen 4:d065642c32cc 110 * With each handler a \c uri or \c path is associated. Whenever a request is received the server will
leihen 4:d065642c32cc 111 * walk through all registered handlers and check which \c path is matching.
leihen 4:d065642c32cc 112 * @param T : class which will be instanciated to serve these requests for the associated \b path.
leihen 4:d065642c32cc 113 * @param path : request uri starting with this \c path will be served using this handler.
leihen 0:7a2421e63e74 114 */
leihen 3:d6224049b3bf 115 template<typename T>
leihen 3:d6224049b3bf 116 void addHandler(const char* path)
leihen 3:d6224049b3bf 117 { m_lpHandlers[path] = &T::create; }
leihen 2:8653bbcf7e58 118
leihen 3:d6224049b3bf 119 /**
leihen 4:d065642c32cc 120 * Replaces the standard error Handler. The error Handler will be called everytime a request is not
leihen 4:d065642c32cc 121 * matching any of the registered \c paths or \c uris.
leihen 4:d065642c32cc 122 * @param hdlFunc: User specified handler function which will be used in error conditions.
leihen 3:d6224049b3bf 123 */
leihen 2:8653bbcf7e58 124 void addErrorHandler(HTTPRequestHandlerFunction hdlFunc)
leihen 2:8653bbcf7e58 125 { m_pErrorHandler = hdlFunc!=NULL ?hdlFunc : StdErrorHandler; }
leihen 3:d6224049b3bf 126
leihen 3:d6224049b3bf 127 /** Binds server to a specific port and starts listening. This member prepares the internal variables and the server socket
leihen 3:d6224049b3bf 128 * and terminates after successfull initialization
leihen 3:d6224049b3bf 129 * @param port : port on which to listen for incoming connections
leihen 3:d6224049b3bf 130 * @returns : -1 if an unrecoverable error occured, or 0 if everything was ok.
leihen 0:7a2421e63e74 131 */
leihen 0:7a2421e63e74 132 int start(int port = 80);
leihen 0:7a2421e63e74 133
leihen 3:d6224049b3bf 134 /** Performs the regular polling of the server component. Needs to be called cyclically.
leihen 3:d6224049b3bf 135 * The function will internally check whether new connections are requested by a client and will also poll all existing client connections.
leihen 6:fe661fa9d18a 136 * @param blocking : if true,
leihen 4:d065642c32cc 137 * @returns -1 if there was a problem. If 0 is returned, the latest request was served successfully and the server is
leihen 4:d065642c32cc 138 * ready for processing the next request. Simply call \c poll as long as you want to serve new incoming requests.
leihen 0:7a2421e63e74 139 */
leihen 6:fe661fa9d18a 140 int poll(bool blocking = true);
leihen 0:7a2421e63e74 141
leihen 4:d065642c32cc 142 private:
leihen 4:d065642c32cc 143 /** The standard error handler function.
leihen 4:d065642c32cc 144 * @param msg : Request message data.
leihen 4:d065642c32cc 145 * @param tcp : Socket to be used for responding.
leihen 4:d065642c32cc 146 */
leihen 4:d065642c32cc 147 static void StdErrorHandler(HTTPConnection::HTTPMessage& msg, TCPSocketConnection& tcp);
leihen 0:7a2421e63e74 148
leihen 4:d065642c32cc 149 /** Internal function which processes a request and which will try to find the matching handler function
leihen 4:d065642c32cc 150 * for the given request. Please note that the function will search through the list of handlers, iterating
leihen 4:d065642c32cc 151 * from longest to shortest \c paths. If the registered \c path is a subset of the request the associated
leihen 4:d065642c32cc 152 * handler is considered as being a match.
leihen 4:d065642c32cc 153 * @param msg : Request message data. Contains the requested logical \c uri.
leihen 4:d065642c32cc 154 * @param tcp : Socket to be used for communication with the client.
leihen 4:d065642c32cc 155 */
leihen 4:d065642c32cc 156 void HandleRequest(HTTPConnection::HTTPMessage& msg, TCPSocketConnection& tcp);
leihen 2:8653bbcf7e58 157
leihen 4:d065642c32cc 158 /** Map of handler objects. Can be any object derived from \ref HTTPRequestHeader. Use the \ref addHandler function
leihen 4:d065642c32cc 159 * to register new handler objects.
leihen 4:d065642c32cc 160 */
leihen 3:d6224049b3bf 161 map<string, HTTPRequestHandler* (*)(const char*, const char*, HTTPConnection::HTTPMessage&, TCPSocketConnection&), handlersComp> m_lpHandlers;
leihen 3:d6224049b3bf 162 HTTPRequestHandlerFunction m_pErrorHandler;
leihen 3:d6224049b3bf 163
leihen 0:7a2421e63e74 164 };
leihen 0:7a2421e63e74 165
leihen 0:7a2421e63e74 166 #endif //__HTTPSERVER_H__