doc

CHANGELOG.md

@@ -1,8 +1,9 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## [unreleased] - 2019-06-09
+## [5.0.0] - 2019-06-23
 ### Changed
+- New HTTP server / still very early. ws gained a new command, httpd can run a simple webserver serving local files.
 - IXDNSLookup. Uses weak pointer + smart_ptr + shared_from_this instead of static sets + mutex to handle object going away before dns lookup has resolved
 - cobra_to_sentry / backtraces are reversed and line number is not extracted correctly
 - mbedtls and zlib are searched with find_package, and we use the vendored version if nothing is found

README.md

@@ -4,7 +4,7 @@
 
 ## Introduction
 
-[*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex and bi-directionnal communication channels over a single TCP connection. *IXWebSocket* is a C++ library for client and server Websocket communication, and for client HTTP communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient) and from the [Satori C SDK](https://github.com/satori-com/satori-rtm-sdk-c). It has been tested on the following platforms.
+[*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex and bi-directionnal communication channels over a single TCP connection. *IXWebSocket* is a C++ library for client and server Websocket communication, and for client and server HTTP communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient) and from the [Satori C SDK](https://github.com/satori-com/satori-rtm-sdk-c). It has been tested on the following platforms.
 
 * macOS
 * iOS
@@ -117,7 +117,7 @@ server.wait();
 
 ```
 
-Here is what the HTTP client API looks like. Note that HTTP client support is very recent and subject to changes.
+Here is what the HTTP client API looks like.
 
 ```
 //
@@ -196,6 +196,44 @@ bool ok = httpClient.performRequest(args, [](const HttpResponsePtr& response)
 // ok will be false if your httpClient is not async
 ```
 
+Here is what the HTTP server API looks like. Note that HTTP server support is very, very recent and subject to changes.
+
+```
+ix::HttpServer server(port, hostname);
+
+auto res = server.listen();
+if (!res.first)
+{
+    std::cerr << res.second << std::endl;
+    return 1;
+}
+
+server.start();
+server.wait();
+```
+
+If you want to handle how requests are processed, implement the setOnConnectionCallback callback, which takes an HttpRequestPtr as input, and returns an HttpResponsePtr. You can look at HttpServer::setDefaultConnectionCallback for a slightly more advanced callback example.
+
+```
+setOnConnectionCallback(
+    [this](HttpRequestPtr request,
+           std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
+    {
+        // Build a string for the response
+        std::stringstream ss;
+        ss << request->method 
+           << " "
+           << request->uri;
+
+        std::string content = ss.str();
+
+        return std::make_shared<HttpResponse>(200, "OK",
+                                              HttpErrorCode::Ok,
+                                              WebSocketHttpHeaders(),
+                                              content);
+}
+```
+
 ## Build
 
 CMakefiles for the library and the examples are available. This library has few dependencies, so it is possible to just add the source files into your project. Otherwise the usual way will suffice.

ixwebsocket/IXHttpServer.cpp

@@ -110,7 +110,13 @@ namespace ix
             [this](HttpRequestPtr request,
                    std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
             {
-                std::string path("." + request->uri);
+                std::string uri(request->uri);
+                if (uri.empty() || uri == "/")
+                {
+                    uri = "/index.html";
+                }
+
+                std::string path("." + uri);
                 auto res = readAsString(path);
                 bool found = res.first;
                 if (!found)
@@ -133,7 +139,8 @@ namespace ix
                 logInfo(ss.str());
 
                 WebSocketHttpHeaders headers;
-                headers["Content-Type"] = "application/octet-stream";
+                // FIXME: check extensions to set the content type
+                // headers["Content-Type"] = "application/octet-stream";
                 headers["Accept-Ranges"] = "none";
 
                 for (auto&& it : request->headers)
@@ -143,7 +150,7 @@ namespace ix
 
                 return std::make_shared<HttpResponse>(200, "OK",
                                                       HttpErrorCode::Ok,
-                                                      WebSocketHttpHeaders(),
+                                                      headers,
                                                       content);
             }
         );