Rob Dobson / RdWebServer

A simple web server mainly based on ideas from Jasper Schuurmans Netduino web server

Dependents:   RdBlindsServer SpideyWallWeb RdGasUseMonitor

A fast and reliable web server for MBED! http://robdobson.com/2015/08/a-reliable-mbed-webserver/

It has a very neat way to implement REST commands and can serve files from local storage (on LPC1768 for instance) and from SD cards. It also has a caching facility which is particularly useful for serving files from local storage.

The server can be run in the main() thread (and has a sub-2ms response time if this is done) or in a mbed-rtos thread which increases the response time to (a still respectable) 30ms or so.

The latest project that uses this is here - https://developer.mbed.org/users/Bobty/code/SpideyWallWeb/

int main (void)
{
    // Ethernet interface
    EthernetInterface::init();

    // Connect ethernet
    EthernetInterface::connect();

    // Init the web server
    pc.printf("Starting web server\r\n");
    char* baseWebFolder = "/sd/";  // should be /sd/ for SDcard files - not used for local file system
    RdWebServer webServer;
    
    // Add commands to handle the home page and favicon
    webServer.addCommand("", RdWebServerCmdDef::CMD_LOCALFILE, NULL, "index.htm", true);
    webServer.addCommand("favicon.ico", RdWebServerCmdDef::CMD_LOCALFILE, NULL, NULL, true);
    
    // Add the lightwall control commands
    webServer.addCommand("name", RdWebServerCmdDef::CMD_CALLBACK, &lightwallGetSystemName);
    webServer.addCommand("clear", RdWebServerCmdDef::CMD_CALLBACK, &lightwallClear);
    webServer.addCommand("rawfill", RdWebServerCmdDef::CMD_CALLBACK, &lightwallRawFill);
    webServer.addCommand("fill", RdWebServerCmdDef::CMD_CALLBACK, &lightwallFill);
    webServer.addCommand("showleds", RdWebServerCmdDef::CMD_CALLBACK, &lightwallShowLeds);
    
    // Start the server
    webServer.init(WEBPORT, &led4, baseWebFolder);
    webServer.run();

}

// Get system name - No arguments required
char* lightwallGetSystemName(int method, char*cmdStr, char* argStr, char* msgBuffer, int msgLen, 
                int contentLen, unsigned char* pPayload, int payloadLen, int splitPayloadPos)
{
    // Perform any required actions here ....

    // ...

    // Return the system name
    return systemName;
}

This server was originally based on a Netduino web server from Jasper Schuurmans but has been optimised for speed.

Diff: RdWebServer.h

Revision:
15:0865fa4b046a
Parent:
14:4b83670854f0
Child:
17:080f2bed8b36
diff -r 4b83670854f0 -r 0865fa4b046a RdWebServer.h
--- a/RdWebServer.h	Tue May 05 15:05:44 2015 +0000
+++ b/RdWebServer.h	Tue May 05 20:27:33 2015 +0000
@@ -1,5 +1,5 @@
 /* RdWebServer.h
-   Rob Dobson 2013
+   Rob Dobson 2013-2015
    Inspired by Jasper Schuurmans multi-threaded web server for Netduino http://www.schuurmans.cc/multi-threaded-web-server-for-netduino-plus
 */
 #ifndef RD_WEB_SERVER
@@ -52,9 +52,12 @@
 
 //#define SUPPORT_LOCAL_FILESYSTEM 1
 //#define SUPPORT_FOLDER_VIEW 1
+//#define SUPPORT_LOCAL_FILE_CACHE 1
 
 extern RawSerial pc;
 
+#ifdef SUPPORT_LOCAL_FILE_CACHE
+
 class RdFileCacheEntry
 {
     public:
@@ -78,6 +81,8 @@
         int _nFileLen;
 };
 
+#endif
+
 typedef char* (*CmdCallbackType)(int method, char*cmdStr, char* argStr);
 
 class RdWebServerCmdDef
@@ -86,23 +91,27 @@
         static const int CMD_LOCALFILE = 1;
         static const int CMD_CALLBACK = 2;
         static const int CMD_SDORUSBFILE = 3;
-        RdWebServerCmdDef(char* pStr, int cmdType, CmdCallbackType callback, char* substFileName, bool bCacheIfPossible)
+        RdWebServerCmdDef(char* pStr, int cmdType, CmdCallbackType callback, char* subst8dot3FileName = NULL, bool bCacheIfPossible = false)
         {
             _pCmdStr = pStr;
             _cmdType = cmdType;
             _callback = callback;
-            _substFileName[0] = '\0';
-            if (substFileName != NULL)
+#ifdef SUPPORT_LOCAL_FILE_CACHE
+            _subst8dot3FileName[0] = '\0';
+            if (subst8dot3FileName != NULL)
             {
-                strncpy(_substFileName, substFileName, RdFileCacheEntry::CACHE_MAX_FNAME_LEN);
-                _substFileName[RdFileCacheEntry::CACHE_MAX_FNAME_LEN-1] = '\0';
+                strncpy(_subst8dot3FileName, subst8dot3FileName, RdFileCacheEntry::CACHE_MAX_FNAME_LEN);
+                _subst8dot3FileName[RdFileCacheEntry::CACHE_MAX_FNAME_LEN-1] = '\0';
             }
+#endif
             _bCacheIfPossible = bCacheIfPossible;
         };
         char* _pCmdStr;
         int _cmdType;
         CmdCallbackType _callback;
-        char _substFileName[RdFileCacheEntry::CACHE_MAX_FNAME_LEN];
+#ifdef SUPPORT_LOCAL_FILE_CACHE
+        char _subst8dot3FileName[RdFileCacheEntry::CACHE_MAX_FNAME_LEN];
+#endif
         bool _bCacheIfPossible;
 };
 
@@ -120,20 +129,17 @@
         
         bool init(int port, DigitalOut* pStatusLed, char* pBaseWebFolder);
         void run();
-        bool isListening()
-        {
-            return _serverIsListening;
-        };
-        
         void addCommand(char* pCmdStr, int cmdType, CmdCallbackType callback = NULL, char* substFileName = NULL, bool cacheIfPossible = false);
         
     private :
         int _port;
         DigitalOut* _pStatusLed;
-        TCPSocketServer _socketSrv;
-        bool _serverIsListening;
+        TCPSocketServer _serverSocket;
+        bool _initOk;
         std::vector<RdWebServerCmdDef*> _commands;
+#ifdef SUPPORT_LOCAL_FILE_CACHE
         std::vector<RdFileCacheEntry*> _cachedFiles;
+#endif
         bool extractCmdArgs(char* buf, char* pCmdStr, int maxCmdStrLen, char* pArgStr, int maxArgStrLen);
         char* _pBaseWebFolder;
         char _httpHeader[HTTPD_MAX_HDR_LENGTH+1];
@@ -142,7 +148,9 @@
         void handleLocalFileRequest(char* cmdStr, char* argStr, TCPSocketConnection &client, char* httpHeader, bool bCacheIfPossible);
         bool handleSDFileRequest(char* cmdStr, char* argStr, TCPSocketConnection &client, char* httpHeader);
         void handleCGIRequest(char* pUriStr, char* pQueryStr);
+#ifdef SUPPORT_LOCAL_FILE_CACHE
         void sendFromCache(RdFileCacheEntry* pCacheEntry, TCPSocketConnection &client, char* httpHeader);
+#endif
         bool handleReceivedHttp(TCPSocketConnection &client);
 
 };