raf vervoort / HTTPServer

Team E1

Fork of HTTPServer by Sam Kirsch

HTTPServer.h@3:d6224049b3bf, 2013-05-28 (annotated)

Committer:
leihen
Date:
Tue May 28 01:56:14 2013 +0000
Revision:
3:d6224049b3bf
Parent:
2:8653bbcf7e58
Child:
4:d065642c32cc
First beta version

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 0:7a2421e63e74 77 public:
leihen 3:d6224049b3bf 78 /** Constructor for HTTPServer objects.
leihen 3:d6224049b3bf 79 */
leihen 3:d6224049b3bf 80 HTTPServer(Serial* dbg = NULL);
leihen 3:d6224049b3bf 81
leihen 3:d6224049b3bf 82 /** Destructor for HTTPServer objects.
leihen 3:d6224049b3bf 83 */
leihen 0:7a2421e63e74 84 ~HTTPServer();
leihen 1:6b7472d5e9ee 85
leihen 0:7a2421e63e74 86 struct handlersComp //Used to order handlers in the right way
leihen 0:7a2421e63e74 87 {
leihen 0:7a2421e63e74 88 bool operator() (const string& handler1, const string& handler2) const
leihen 0:7a2421e63e74 89 {
leihen 3:d6224049b3bf 90 //The first handler is longer than the second one
leihen 3:d6224049b3bf 91 if (handler1.length() > handler2.length())
leihen 3:d6224049b3bf 92 return true; //Returns true if handler1 is to appear before handler2
leihen 3:d6224049b3bf 93 else if (handler1.length() < handler2.length())
leihen 3:d6224049b3bf 94 return false;
leihen 3:d6224049b3bf 95 else //To avoid the == case, sort now by address
leihen 3:d6224049b3bf 96 return ((&handler1)>(&handler2));
leihen 0:7a2421e63e74 97 }
leihen 0:7a2421e63e74 98 };
leihen 1:6b7472d5e9ee 99
leihen 0:7a2421e63e74 100 ///Adds a handler
leihen 0:7a2421e63e74 101 /**
leihen 0:7a2421e63e74 102 Appends a handler to the handlers list
leihen 0:7a2421e63e74 103 @param T : class which will be instanciated to serve these requests
leihen 0:7a2421e63e74 104 @param path : requests starting with this path will be served using this handler
leihen 0:7a2421e63e74 105 */
leihen 3:d6224049b3bf 106 template<typename T>
leihen 3:d6224049b3bf 107 void addHandler(const char* path)
leihen 3:d6224049b3bf 108 { m_lpHandlers[path] = &T::create; }
leihen 2:8653bbcf7e58 109
leihen 3:d6224049b3bf 110 /**
leihen 3:d6224049b3bf 111 Replaces the standard error Handler. The error Handler will be called everytime a request is not
leihen 3:d6224049b3bf 112 handled by a handler from the handler list.
leihen 3:d6224049b3bf 113 @param hdlFunc: Handler which serves an error condition.
leihen 3:d6224049b3bf 114 */
leihen 2:8653bbcf7e58 115 void addErrorHandler(HTTPRequestHandlerFunction hdlFunc)
leihen 2:8653bbcf7e58 116 { m_pErrorHandler = hdlFunc!=NULL ?hdlFunc : StdErrorHandler; }
leihen 3:d6224049b3bf 117
leihen 3:d6224049b3bf 118 /** Binds server to a specific port and starts listening. This member prepares the internal variables and the server socket
leihen 3:d6224049b3bf 119 * and terminates after successfull initialization
leihen 3:d6224049b3bf 120 * @param port : port on which to listen for incoming connections
leihen 3:d6224049b3bf 121 * @returns : -1 if an unrecoverable error occured, or 0 if everything was ok.
leihen 0:7a2421e63e74 122 */
leihen 0:7a2421e63e74 123 int start(int port = 80);
leihen 0:7a2421e63e74 124
leihen 3:d6224049b3bf 125 /** Performs the regular polling of the server component. Needs to be called cyclically.
leihen 3:d6224049b3bf 126 * The function will internally check whether new connections are requested by a client and will also poll all existing client connections.
leihen 0:7a2421e63e74 127 */
leihen 0:7a2421e63e74 128 int poll();
leihen 0:7a2421e63e74 129
leihen 3:d6224049b3bf 130 private:
leihen 3:d6224049b3bf 131 static void StdErrorHandler(HTTPConnection::HTTPMessage&, TCPSocketConnection&);
leihen 0:7a2421e63e74 132
leihen 3:d6224049b3bf 133 TCPSocketServer* m_pSvr;
leihen 3:d6224049b3bf 134 bool m_bServerListening;
leihen 3:d6224049b3bf 135
leihen 3:d6224049b3bf 136 Serial* m_pDbg;
leihen 3:d6224049b3bf 137 void HandleRequest(HTTPConnection::HTTPMessage& con, TCPSocketConnection&);
leihen 2:8653bbcf7e58 138
leihen 3:d6224049b3bf 139 map<string, HTTPRequestHandler* (*)(const char*, const char*, HTTPConnection::HTTPMessage&, TCPSocketConnection&), handlersComp> m_lpHandlers;
leihen 3:d6224049b3bf 140 HTTPRequestHandlerFunction m_pErrorHandler;
leihen 3:d6224049b3bf 141
leihen 0:7a2421e63e74 142 };
leihen 0:7a2421e63e74 143
leihen 0:7a2421e63e74 144 #endif //__HTTPSERVER_H__