On error while doing a client handshake, additionally display port number next to the host name

Fix windows CI with appveyor + minor tweaks.

.clang-format

@@ -0,0 +1,47 @@
+# https://releases.llvm.org/7.0.0/tools/clang/docs/ClangFormatStyleOptions.html
+
+---
+Language: Cpp
+
+BasedOnStyle: WebKit
+
+AlignAfterOpenBracket: Align
+AlignOperands: true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: true
+AllowShortFunctionsOnASingleLine: false
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakTemplateDeclarations: true
+BinPackArguments: false
+BinPackParameters: false
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Allman
+BreakConstructorInitializersBeforeComma: true
+ColumnLimit: 100
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+Cpp11BracedListStyle: true
+FixNamespaceComments: true
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^["<](stdafx|pch)\.h[">]$'
+    Priority:        -1
+  - Regex:           '^<Windows\.h>$'
+    Priority:        3
+  - Regex:           '^<(WinIoCtl|winhttp|Shellapi)\.h>$'
+    Priority:        4
+  - Regex:           '.*'
+    Priority:        2
+IndentCaseLabels: true
+IndentWidth: 4
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 2
+NamespaceIndentation: All
+PenaltyReturnTypeOnItsOwnLine: 1000
+PointerAlignment: Left
+SpaceAfterTemplateKeyword: false
+SpaceAfterCStyleCast: true
+Standard: Cpp11
+UseTab: Never

.dockerignore

@@ -1,3 +1,4 @@
 build
 CMakeCache.txt
 ws/CMakeCache.txt
+test/build

.gitignore

@@ -1 +1,3 @@
 build
+*.pyc
+venv

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace

.travis.yml

@@ -1,17 +1,59 @@
-language: cpp
-dist: xenial
+language: bash
 
-compiler:
-  - gcc
-  - clang
-os:
-  - linux
-  - osx
+# See https://github.com/amaiorano/vectrexy/blob/master/.travis.yml
+# for ideas on installing vcpkg
 
 matrix:
-  exclude:
-    # GCC fails on recent Travis OSX images.
-    - compiler: gcc
-      os: osx
+  include:
+    # macOS
+    # - os: osx
+    #   env:
+    #     - HOMEBREW_NO_AUTO_UPDATE=1
+    #   compiler: clang
+    #   script:
+    #     - brew install redis
+    #     - brew services start redis
+    #     - brew install mbedtls
+    #     - python test/run.py
+    #     - make ws
 
-script: python test/run.py
+    Linux
+    - os: linux
+      dist: bionic
+      before_install:
+        - sudo apt-get install -y libmbedtls-dev
+        - sudo apt-get install -y redis-server
+      script: 
+      - python test/run.py
+      #  - make ws
+      env:
+        - CC=gcc
+        - CXX=g++
+
+    # Clang + Linux disabled for now
+    # - os: linux
+    #   dist: xenial
+    #   script: python test/run.py
+    #   env:
+    #     - CC=clang 
+    #     - CXX=clang++
+
+    # Windows
+    # - os: windows
+    #   env:
+    #     - CMAKE_PATH="/c/Program Files/CMake/bin"
+    #   script: 
+    #     - cd third_party/zlib
+    #     - cmake .
+    #     - cmake --build . --target install
+    #     - cd ../..
+    #     # - cd third_party/mbedtls
+    #     # - cmake .
+    #     # - cmake --build . --target install
+    #     # - cd ../..
+    #     - export PATH=$CMAKE_PATH:$PATH
+    #     - cd test
+    #     - cmake .
+    #     - cmake --build --parallel .
+    #     - ixwebsocket_unittest.exe
+    #     # - python test/run.py

CMake/FindMbedTLS.cmake

@@ -0,0 +1,13 @@
+find_path(MBEDTLS_INCLUDE_DIRS mbedtls/ssl.h)
+
+find_library(MBEDTLS_LIBRARY mbedtls)
+find_library(MBEDX509_LIBRARY mbedx509)
+find_library(MBEDCRYPTO_LIBRARY mbedcrypto)
+
+set(MBEDTLS_LIBRARIES "${MBEDTLS_LIBRARY}" "${MBEDX509_LIBRARY}" "${MBEDCRYPTO_LIBRARY}")
+
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(MBEDTLS DEFAULT_MSG
+    MBEDTLS_INCLUDE_DIRS MBEDTLS_LIBRARY MBEDX509_LIBRARY MBEDCRYPTO_LIBRARY)
+
+mark_as_advanced(MBEDTLS_INCLUDE_DIRS MBEDTLS_LIBRARY MBEDX509_LIBRARY MBEDCRYPTO_LIBRARY)

CMakeLists.txt

@@ -4,14 +4,15 @@
 #
 
 cmake_minimum_required(VERSION 3.4.1)
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMake;${CMAKE_MODULE_PATH}")
+
 project(ixwebsocket C CXX)
 
 set (CMAKE_CXX_STANDARD 14)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 
-# -Wshorten-64-to-32 does not work with clang
-if (NOT WIN32)
+if (UNIX)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 
@@ -20,56 +21,74 @@ if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
 endif()
 
 set( IXWEBSOCKET_SOURCES
+    ixwebsocket/IXCancellationRequest.cpp
+    ixwebsocket/IXConnectionState.cpp
+    ixwebsocket/IXDNSLookup.cpp
+    ixwebsocket/IXExponentialBackoff.cpp
+    ixwebsocket/IXHttp.cpp
+    ixwebsocket/IXHttpClient.cpp
+    ixwebsocket/IXHttpServer.cpp
+    ixwebsocket/IXNetSystem.cpp
+    ixwebsocket/IXSelectInterrupt.cpp
+    ixwebsocket/IXSelectInterruptFactory.cpp
     ixwebsocket/IXSocket.cpp
-    ixwebsocket/IXSocketServer.cpp
     ixwebsocket/IXSocketConnect.cpp
     ixwebsocket/IXSocketFactory.cpp
-    ixwebsocket/IXDNSLookup.cpp
-    ixwebsocket/IXCancellationRequest.cpp
-    ixwebsocket/IXNetSystem.cpp
+    ixwebsocket/IXSocketServer.cpp
+    ixwebsocket/IXUrlParser.cpp
+    ixwebsocket/IXUserAgent.cpp
     ixwebsocket/IXWebSocket.cpp
-    ixwebsocket/IXWebSocketServer.cpp
-    ixwebsocket/IXWebSocketTransport.cpp
+    ixwebsocket/IXWebSocketCloseConstants.cpp
     ixwebsocket/IXWebSocketHandshake.cpp
+    ixwebsocket/IXWebSocketHttpHeaders.cpp
+    ixwebsocket/IXWebSocketMessageQueue.cpp
     ixwebsocket/IXWebSocketPerMessageDeflate.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
-    ixwebsocket/IXWebSocketHttpHeaders.cpp
-    ixwebsocket/IXHttpClient.cpp
-    ixwebsocket/IXUrlParser.cpp
+    ixwebsocket/IXWebSocketServer.cpp
+    ixwebsocket/IXWebSocketTransport.cpp
     ixwebsocket/LUrlParser.cpp
-    ixwebsocket/IXSelectInterrupt.cpp
-    ixwebsocket/IXSelectInterruptFactory.cpp
-    ixwebsocket/IXConnectionState.cpp
 )
 
 set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXSocket.h
-    ixwebsocket/IXSocketServer.h
-    ixwebsocket/IXSocketConnect.h
-    ixwebsocket/IXSocketFactory.h
-    ixwebsocket/IXSetThreadName.h
-    ixwebsocket/IXDNSLookup.h
     ixwebsocket/IXCancellationRequest.h
+    ixwebsocket/IXConnectionState.h
+    ixwebsocket/IXDNSLookup.h
+    ixwebsocket/IXExponentialBackoff.h
+    ixwebsocket/IXHttp.h
+    ixwebsocket/IXHttpClient.h
+    ixwebsocket/IXHttpServer.h
     ixwebsocket/IXNetSystem.h
     ixwebsocket/IXProgressCallback.h
+    ixwebsocket/IXSelectInterrupt.h
+    ixwebsocket/IXSelectInterruptFactory.h
+    ixwebsocket/IXSetThreadName.h
+    ixwebsocket/IXSocket.h
+    ixwebsocket/IXSocketConnect.h
+    ixwebsocket/IXSocketFactory.h
+    ixwebsocket/IXSocketServer.h
+    ixwebsocket/IXUrlParser.h
+    ixwebsocket/IXUtf8Validator.h
+    ixwebsocket/IXUserAgent.h
     ixwebsocket/IXWebSocket.h
-    ixwebsocket/IXWebSocketServer.h
-    ixwebsocket/IXWebSocketTransport.h
-    ixwebsocket/IXWebSocketHandshake.h
-    ixwebsocket/IXWebSocketSendInfo.h
+    ixwebsocket/IXWebSocketCloseConstants.h
+    ixwebsocket/IXWebSocketCloseInfo.h
     ixwebsocket/IXWebSocketErrorInfo.h
+    ixwebsocket/IXWebSocketHandshake.h
+    ixwebsocket/IXWebSocketHttpHeaders.h
+    ixwebsocket/IXWebSocketMessage.h
+    ixwebsocket/IXWebSocketMessageQueue.h
+    ixwebsocket/IXWebSocketMessageType.h
+    ixwebsocket/IXWebSocketOpenInfo.h
     ixwebsocket/IXWebSocketPerMessageDeflate.h
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.h
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.h
-    ixwebsocket/IXWebSocketHttpHeaders.h
-    ixwebsocket/libwshandshake.hpp
-    ixwebsocket/IXHttpClient.h
-    ixwebsocket/IXUrlParser.h
+    ixwebsocket/IXWebSocketSendInfo.h
+    ixwebsocket/IXWebSocketServer.h
+    ixwebsocket/IXWebSocketTransport.h
+    ixwebsocket/IXWebSocketVersion.h
     ixwebsocket/LUrlParser.h
-    ixwebsocket/IXSelectInterrupt.h
-    ixwebsocket/IXSelectInterruptFactory.h
-    ixwebsocket/IXConnectionState.h
+    ixwebsocket/libwshandshake.hpp
 )
 
 if (UNIX)
@@ -89,11 +108,16 @@ else()
     list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSelectInterruptEventFd.h)
 endif()
 
+if (WIN32)
+  set(USE_MBED_TLS TRUE)
+endif()
+
 set(USE_OPEN_SSL FALSE)
 if (USE_TLS)
-    add_definitions(-DIXWEBSOCKET_USE_TLS)
-
-    if (APPLE)
+    if (USE_MBED_TLS)
+        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketMbedTLS.h)
+        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketMbedTLS.cpp)
+    elseif (APPLE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.cpp)
     elseif (WIN32)
@@ -111,11 +135,32 @@ add_library( ixwebsocket STATIC
     ${IXWEBSOCKET_HEADERS}
 )
 
-if (APPLE AND USE_TLS)
+if (USE_TLS)
+    target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_TLS)
+    if (USE_MBED_TLS)
+        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_MBED_TLS)
+    elseif (APPLE)
+    elseif (WIN32)
+    else()
+        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
+    endif()
+endif()
+
+if (APPLE AND USE_TLS AND NOT USE_MBED_TLS)
   target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
 endif()
 
-if (USE_OPEN_SSL)
+if (WIN32)
+  target_link_libraries(ixwebsocket wsock32 ws2_32)
+  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+endif()
+
+if (UNIX)
+  find_package(Threads)
+  target_link_libraries(ixwebsocket ${CMAKE_THREAD_LIBS_INIT})
+endif()
+
+if (USE_TLS AND USE_OPEN_SSL)
   find_package(OpenSSL REQUIRED)
   add_definitions(${OPENSSL_DEFINITIONS})
   message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
@@ -123,18 +168,28 @@ if (USE_OPEN_SSL)
   target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
 endif()
 
-if (WIN32)
+if (USE_TLS AND USE_MBED_TLS)
+  if (USE_VENDORED_THIRD_PARTY)
+    set (ENABLE_PROGRAMS OFF)
+    add_subdirectory(third_party/mbedtls)
+    include_directories(third_party/mbedtls/include)
+
+    target_link_libraries(ixwebsocket mbedtls)
+  else()
+    find_package(MbedTLS REQUIRED)
+    target_include_directories(ixwebsocket PUBLIC ${MBEDTLS_INCLUDE_DIRS})
+    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
+  endif()
+endif()
+
+find_package(ZLIB)
+if (ZLIB_FOUND)
+  include_directories(${ZLIB_INCLUDE_DIRS})
+  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
+else()
   add_subdirectory(third_party/zlib)
   include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
-  target_link_libraries(ixwebsocket zlibstatic wsock32 ws2_32)
-  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-
-else()
-  # gcc/Linux needs -pthread
-  find_package(Threads)
-
-  target_link_libraries(ixwebsocket 
-    z ${CMAKE_THREAD_LIBS_INIT})
+  target_link_libraries(ixwebsocket zlibstatic)
 endif()
 
 set( IXWEBSOCKET_INCLUDE_DIRS
@@ -146,7 +201,7 @@ if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
     target_compile_options(ixwebsocket PRIVATE /MP)
 endif()
 
-target_include_directories( ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS} )
+target_include_directories(ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS})
 
 set_target_properties(ixwebsocket PROPERTIES PUBLIC_HEADER "${IXWEBSOCKET_HEADERS}")
 
@@ -155,6 +210,15 @@ install(TARGETS ixwebsocket
         PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/
 )
 
-if (NOT WIN32)
-    add_subdirectory(ws)
+if (USE_WS OR USE_TEST)
+  add_subdirectory(ixcore)
+  add_subdirectory(ixcrypto)
+  add_subdirectory(ixcobra)
+
+  if (USE_WS)
+      add_subdirectory(ws)
+  endif()
+  if (USE_TEST)
+      add_subdirectory(test)
+  endif()
 endif()

DOCKER_VERSION

@@ -1 +1 @@
-1.4.3
+6.2.1

Dockerfile

@@ -1 +1 @@
-docker/Dockerfile.fedora
+docker/Dockerfile.alpine

README.md

@@ -1,422 +1,13 @@
-# General
+## Hello world
 
 ![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
 
-## Introduction
+IXWebSocket is a C++ library for WebSocket client and server development. It has minimal dependencies (no boost), is very simple to use and support everything you'll likely need for websocket dev (SSL, deflate compression, compiles on most platforms, etc...). HTTP client and server code is also available, but it hasn't received as much testing.
 
-[*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.
+It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android).
 
-* macOS
-* iOS
-* Linux
-* Android
-* Windows (no TLS)
+Interested ? Go read the [docs](https://machinezone.github.io/IXWebSocket/) ! If things don't work as expected, please create an issue in github, or even better a pull request if you know how to fix your problem.
 
-## Examples
+IXWebSocket is actively being developed, check out the [changelog](CHANGELOG.md) to know what's cooking. If you are looking for a real time messaging service (the chat-like 'server' your websocket code will talk to) with many features such as history, backed by Redis, look at [cobra](https://github.com/machinezone/cobra).
 
-The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage.
-
-Here is what the client API looks like.
-
-```
-ix::WebSocket webSocket;
-
-std::string url("ws://localhost:8080/");
-webSocket.setUrl(url);
-
-// Optional heart beat, sent every 45 seconds when there is not any traffic
-// to make sure that load balancers do not kill an idle connection.
-webSocket.setHeartBeatPeriod(45);
-
-// Setup a callback to be fired when a message or an event (open, close, error) is received
-webSocket.setOnMessageCallback(
-    [](ix::WebSocketMessageType messageType,
-       const std::string& str,
-       size_t wireSize,
-       const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketOpenInfo& openInfo,
-       const ix::WebSocketCloseInfo& closeInfo)
-    {
-        if (messageType == ix::WebSocket_MessageType_Message)
-        {
-            std::cout << str << std::endl;
-        }
-});
-
-// Now that our callback is setup, we can start our background thread and receive messages
-webSocket.start();
-
-// Send a message to the server (default to BINARY mode)
-webSocket.send("hello world");
-
-// The message can be sent in TEXT mode
-webSocket.sendText("hello again");
-
-// ... finally ...
-
-// Stop the connection
-webSocket.stop()
-```
-
-Here is what the server API looks like. Note that server support is very recent and subject to changes.
-
-```
-// Run a server on localhost at a given port.
-// Bound host name, max connections and listen backlog can also be passed in as parameters.
-ix::WebSocketServer server(port);
-
-server.setOnConnectionCallback(
-    [&server](std::shared_ptr<WebSocket> webSocket,
-              std::shared_ptr<ConnectionState> connectionState)
-    {
-        webSocket->setOnMessageCallback(
-            [webSocket, connectionState, &server](ix::WebSocketMessageType messageType,
-               const std::string& str,
-               size_t wireSize,
-               const ix::WebSocketErrorInfo& error,
-               const ix::WebSocketOpenInfo& openInfo,
-               const ix::WebSocketCloseInfo& closeInfo)
-            {
-                if (messageType == ix::WebSocket_MessageType_Open)
-                {
-                    std::cerr << "New connection" << std::endl;
-
-                    // A connection state object is available, and has a default id
-                    // You can subclass ConnectionState and pass an alternate factory
-                    // to override it. It is useful if you want to store custom
-                    // attributes per connection (authenticated bool flag, attributes, etc...)
-                    std::cerr << "id: " << connectionState->getId() << std::endl;
-
-                    // The uri the client did connect to.
-                    std::cerr << "Uri: " << openInfo.uri << std::endl;
-
-                    std::cerr << "Headers:" << std::endl;
-                    for (auto it : openInfo.headers)
-                    {
-                        std::cerr << it.first << ": " << it.second << std::endl;
-                    }
-                }
-                else if (messageType == ix::WebSocket_MessageType_Message)
-                {
-                    // For an echo server, we just send back to the client whatever was received by the server
-                    // All connected clients are available in an std::set. See the broadcast cpp example.
-                    webSocket->send(str);
-                }
-            }
-        );
-    }
-);
-
-auto res = server.listen();
-if (!res.first)
-{
-    // Error handling
-    return 1;
-}
-
-// Run the server in the background. Server can be stoped by calling server.stop()
-server.start();
-
-// Block until server.stop() is called.
-server.wait();
-
-```
-
-Here is what the HTTP client API looks like. Note that HTTP client support is very recent and subject to changes.
-
-```
-//
-// Preparation
-//
-HttpClient httpClient;
-HttpRequestArgs args;
-
-// Custom headers can be set
-WebSocketHttpHeaders headers;
-headers["Foo"] = "bar";
-args.extraHeaders = headers;
-
-// Timeout options
-args.connectTimeout = connectTimeout;
-args.transferTimeout = transferTimeout;
-
-// Redirect options
-args.followRedirects = followRedirects;
-args.maxRedirects = maxRedirects;
-
-// Misc
-args.compress = compress; // Enable gzip compression
-args.verbose = verbose;
-args.logger = [](const std::string& msg)
-{
-    std::cout << msg;
-};
-
-//
-// Request
-//
-HttpResponse out;
-std::string url = "https://www.google.com";
-
-// HEAD request
-out = httpClient.head(url, args);
-
-// GET request
-out = httpClient.get(url, args);
-
-// POST request with parameters
-HttpParameters httpParameters;
-httpParameters["foo"] = "bar";
-out = httpClient.post(url, httpParameters, args);
-
-// POST request with a body
-out = httpClient.post(url, std::string("foo=bar"), args);
-
-//
-// Result
-//
-auto statusCode = std::get<0>(out);
-auto errorCode = std::get<1>(out);
-auto responseHeaders = std::get<2>(out);
-auto payload = std::get<3>(out);
-auto errorMsg = std::get<4>(out);
-auto uploadSize = std::get<5>(out);
-auto downloadSize = std::get<6>(out);
-```
-
-## 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.
-
-```
-mkdir build # make a build dir so that you can build out of tree.
-cd build
-cmake ..
-make -j
-make install # will install to /usr/local on Unix, on macOS it is a good idea to sudo chown -R `whoami`:staff /usr/local
-```
-
-Headers and a static library will be installed to the target dir.
-
-A [conan](https://conan.io/) file is available at [conan-IXWebSocket](https://github.com/Zinnion/conan-IXWebSocket).
-
-There is a unittest which can be executed by typing `make test`.
-
-There is a Dockerfile for running some code on Linux. To use docker-compose you must make a docker container first.
-
-```
-$ make docker
-...
-$ docker compose up &
-...
-$ docker exec -it ixwebsocket_ws_1 bash
-app@ca2340eb9106:~$ ws --help
-ws is a websocket tool
-...
-```
-
-Finally you can build and install the `ws command line tool` with Homebrew. The homebrew version might be slightly out of date.
-
-```
-brew tap bsergean/IXWebSocket
-brew install IXWebSocket
-```
-
-## Implementation details
-
-### Per Message Deflate compression.
-
-The per message deflate compression option is supported. It can lead to very nice bandbwith savings (20x !) if your messages are similar, which is often the case for example for chat applications. All features of the spec should be supported.
-
-### TLS/SSL
-
-Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, and OpenSSL is used on Android and Linux.
-
-### Polling and background thread work
-
-No manual polling to fetch data is required. Data is sent and received instantly by using a background thread for receiving data and the select [system](http://man7.org/linux/man-pages/man2/select.2.html) call to be notified by the OS of incoming data. No timeout is used for select so that the background thread is only woken up when data is available, to optimize battery life. This is also the recommended way of using select according to the select tutorial, section [select law](https://linux.die.net/man/2/select_tut). Read and Writes to the socket are non blocking. Data is sent right away and not enqueued by writing directly to the socket, which is [possible](https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid) since system socket implementations allow concurrent read/writes. However concurrent writes need to be protected with mutex.
-
-### Automatic reconnection
-
-If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds.
-
-### Large messages
-
-Large frames are broken up into smaller chunks or messages to avoid filling up the os tcp buffers, which is permitted thanks to WebSocket [fragmentation](https://tools.ietf.org/html/rfc6455#section-5.4). Messages up to 1G were sent and received succesfully.
-
-## Limitations
-
-* No utf-8 validation is made when sending TEXT message with sendText()
-* Automatic reconnection works at the TCP socket level, and will detect remote end disconnects. However, if the device/computer network become unreachable (by turning off wifi), it is quite hard to reliably and timely detect it at the socket level using `recv` and `send` error codes. [Here](https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program) is a good discussion on the subject. This behavior is consistent with other runtimes such as node.js. One way to detect a disconnected device with low level C code is to do a name resolution with DNS but this can be expensive. Mobile devices have good and reliable API to do that.
-* The server code is using select to detect incoming data, and creates one OS thread per connection. This is not as scalable as strategies using epoll or kqueue.
-
-## C++ code organization
-
-Here is a simplistic diagram which explains how the code is structured in term of class/modules.
-
-```
-+-----------------------+ --- Public
-|                       | Start the receiving Background thread. Auto reconnection. Simple websocket Ping.
-|  IXWebSocket          | Interface used by C++ test clients. No IX dependencies.
-|                       |
-+-----------------------+
-|                       |
-|  IXWebSocketServer    | Run a server and give each connections its own WebSocket object.
-|                       | Each connection is handled in a new OS thread.
-|                       |
-+-----------------------+ --- Private
-|                       |
-|  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
-|                       |
-+-----------------------+
-|                       |
-|  IXWebSocketHandshake | Establish the connection between client and server.
-|                       |
-+-----------------------+
-|                       |
-|  IXWebSocket          | ws://  Unencrypted Socket handler
-|  IXWebSocketAppleSSL  | wss:// TLS encrypted Socket AppleSSL handler. Used on iOS and macOS
-|  IXWebSocketOpenSSL   | wss:// TLS encrypted Socket OpenSSL handler.  Used on Android and Linux
-|                       |                                               Can be used on macOS too.
-+-----------------------+
-|                       |
-|  IXSocketConnect      | Connect to the remote host (client).
-|                       |
-+-----------------------+
-|                       |
-|  IXDNSLookup          | Does DNS resolution asynchronously so that it can be interrupted.
-|                       |
-+-----------------------+
-```
-
-## API
-
-### Sending messages
-
-`websocket.send("foo")` will send a message.
-
-If the connection was closed and sending failed, the return value will be set to false.
-
-### ReadyState
-
-`getReadyState()` returns the state of the connection. There are 4 possible states.
-
-1. WebSocket_ReadyState_Connecting - The connection is not yet open.
-2. WebSocket_ReadyState_Open       - The connection is open and ready to communicate.
-3. WebSocket_ReadyState_Closing    - The connection is in the process of closing.
-4. WebSocket_MessageType_Close     - The connection is closed or could not be opened.
-
-### Open and Close notifications
-
-The onMessage event will be fired when the connection is opened or closed. This is similar to the [Javascript browser API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), which has `open` and `close` events notification that can be registered with the browser `addEventListener`.
-
-```
-webSocket.setOnMessageCallback(
-    [](ix::WebSocketMessageType messageType,
-       const std::string& str,
-       size_t wireSize,
-       const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketOpenInfo& openInfo,
-       const ix::WebSocketCloseInfo& closeInfo)
-    {
-        if (messageType == ix::WebSocket_MessageType_Open)
-        {
-            std::cout << "send greetings" << std::endl;
-
-            // Headers can be inspected (pairs of string/string)
-            std::cout << "Handshake Headers:" << std::endl;
-            for (auto it : headers)
-            {
-                std::cout << it.first << ": " << it.second << std::endl;
-            }
-        }
-        else if (messageType == ix::WebSocket_MessageType_Close)
-        {
-            std::cout << "disconnected" << std::endl;
-
-            // The server can send an explicit code and reason for closing.
-            // This data can be accessed through the closeInfo object.
-            std::cout << closeInfo.code << std::endl;
-            std::cout << closeInfo.reason << std::endl;
-        }
-    }
-);
-```
-
-### Error notification
-
-A message will be fired when there is an error with the connection. The message type will be `ix::WebSocket_MessageType_Error`. Multiple fields will be available on the event to describe the error.
-
-```
-webSocket.setOnMessageCallback(
-    [](ix::WebSocketMessageType messageType,
-       const std::string& str,
-       size_t wireSize,
-       const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketOpenInfo& openInfo,
-       const ix::WebSocketCloseInfo& closeInfo)
-    {
-        if (messageType == ix::WebSocket_MessageType_Error)
-        {
-            std::stringstream ss;
-            ss << "Error: "         << error.reason      << std::endl;
-            ss << "#retries: "      << event.retries     << std::endl;
-            ss << "Wait time(ms): " << event.wait_time   << std::endl;
-            ss << "HTTP Status: "   << event.http_status << std::endl;
-            std::cout << ss.str() << std::endl;
-        }
-    }
-);
-```
-
-### start, stop
-
-1. `websocket.start()` connect to the remote server and starts the message receiving background thread.
-2. `websocket.stop()` disconnect from the remote server and closes the background thread.
-
-### Configuring the remote url
-
-The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
-
-```
-std::string url("wss://example.com");
-websocket.configure(url);
-```
-
-### Ping/Pong support
-
-Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
-
-```
-webSocket.setOnMessageCallback(
-    [](ix::WebSocketMessageType messageType,
-       const std::string& str,
-       size_t wireSize,
-       const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketOpenInfo& openInfo,
-       const ix::WebSocketCloseInfo& closeInfo)
-    {
-        if (messageType == ix::WebSocket_MessageType_Ping ||
-            messageType == ix::WebSocket_MessageType_Pong)
-        {
-            std::cout << "pong data: " << str << std::endl;
-        }
-    }
-);
-```
-
-A ping message can be sent to the server, with an optional data string.
-
-```
-websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
-```
-
-### Heartbeat.
-
-You can configure an optional heart beat / keep-alive, sent every 45 seconds
-when there is no any traffic to make sure that load balancers do not kill an
-idle connection.
-
-```
-webSocket.setHeartBeatPeriod(45);
-```
+IXWebSocket client code is autobahn compliant beginning with the 6.0.0 version. See the current [test results](https://bsergean.github.io/IXWebSocket/autobahn/index.html). Some tests are still failing in the server code.

appveyor.yml

@@ -2,13 +2,21 @@ image:
 - Visual Studio 2017
 
 install:
-- ls -al
+- cd C:\Tools\vcpkg
+- git pull
+- .\bootstrap-vcpkg.bat
+- cd %APPVEYOR_BUILD_FOLDER%
 - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
-- cd test
+- vcpkg install zlib:x64-windows
+- vcpkg install mbedtls:x64-windows
 - mkdir build
 - cd build
-- cmake -G"NMake Makefiles" ..
+- cmake -DCMAKE_TOOLCHAIN_FILE=c:/tools/vcpkg/scripts/buildsystems/vcpkg.cmake -DUSE_WS=1 -DUSE_TEST=1 -DUSE_TLS=1 -G"NMake Makefiles" ..
 - nmake
-- ixwebsocket_unittest.exe
+- cd ..
+- cd test
+- ..\build\test\ixwebsocket_unittest.exe
+
+cache: c:\tools\vcpkg\installed\
 
 build: off

docker-compose.yml

@@ -29,5 +29,15 @@ services:
     networks:
       - ws-net
 
+  statsd:
+    image: jaconel/statsd
+    ports:
+      - "8125:8125"
+    environment:
+      - STATSD_DUMP_MSG=true
+      - GRAPHITE_HOST=127.0.0.1
+    networks:
+      - ws-net
+
 networks:
   ws-net:

docker/Dockerfile.alpine

@@ -0,0 +1,33 @@
+FROM alpine as build
+
+RUN apk add --no-cache gcc g++ musl-dev linux-headers cmake openssl-dev 
+RUN apk add --no-cache make
+RUN apk add --no-cache zlib-dev
+
+RUN addgroup -S app && adduser -S -G app app 
+RUN chown -R app:app /opt
+RUN chown -R app:app /usr/local
+
+# There is a bug in CMake where we cannot build from the root top folder
+# So we build from /opt
+COPY --chown=app:app . /opt
+WORKDIR /opt
+
+USER app
+RUN [ "make" ]
+
+FROM alpine as runtime
+
+RUN apk add --no-cache libstdc++
+
+RUN addgroup -S app && adduser -S -G app app 
+COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
+RUN chmod +x /usr/local/bin/ws
+RUN ldd /usr/local/bin/ws
+
+# Now run in usermode
+USER app
+WORKDIR /home/app
+
+ENTRYPOINT ["ws"]
+CMD ["--help"]

docker/Dockerfile.fedora

@@ -16,6 +16,7 @@ ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
 
 RUN yum install -y python
 RUN yum install -y libtsan
+RUN yum install -y zlib-devel
 
 COPY . .
 # RUN ["make", "test"]

docker/Dockerfile.ubuntu_bionic

@@ -0,0 +1,23 @@
+# Build time
+FROM ubuntu:bionic as build
+
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update 
+RUN apt-get -y install wget 
+RUN mkdir -p /tmp/cmake
+WORKDIR /tmp/cmake
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
+RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
+
+RUN apt-get -y install g++ 
+RUN apt-get -y install libssl-dev
+RUN apt-get -y install libz-dev
+RUN apt-get -y install make
+RUN apt-get -y install python
+
+COPY . .
+
+ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
+ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
+
+RUN ["make", "ws"]

docker/Dockerfile.ubuntu_disco

@@ -0,0 +1,23 @@
+# Build time
+FROM ubuntu:disco as build
+
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update 
+RUN apt-get -y install wget 
+RUN mkdir -p /tmp/cmake
+WORKDIR /tmp/cmake
+RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
+RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
+
+RUN apt-get -y install g++ 
+RUN apt-get -y install libssl-dev
+RUN apt-get -y install libz-dev
+RUN apt-get -y install make
+RUN apt-get -y install python
+
+COPY . .
+
+ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
+ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
+
+RUN ["make", "test"]

docs/CHANGELOG.md

@@ -0,0 +1,157 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [6.2.1] - 2019-09-17
+
+- On error while doing a client handshake, additionally display port number next to the host name
+
+## [6.2.0] - 2019-09-09
+
+- websocket and http server: server does not close the bound client socket in many cases
+- improve some websocket error messages
+- add a utility function with unittest to parse status line and stop using scanf which triggers warnings on Windows
+- update ws CLI11 (our command line argument parsing library) to the latest, which fix a compiler bug about optional
+
+## [6.1.0] - 2019-09-08
+
+- move poll wrapper on top of select (only used on Windows) to the ix namespace
+
+## [6.0.1] - 2019-09-05
+
+- add cobra metrics publisher + server unittest
+- add cobra client + server unittest
+- ws snake (cobra simple server) add basic support for unsubscription + subscribe send the proper subscription data + redis client subscription can be cancelled
+- IXCobraConnection / pdu handlers can crash if they receive json data which is not an object
+
+## [6.0.0] - 2019-09-04
+
+- all client autobahn test should pass !
+- zlib/deflate has a bug with windowsbits == 8, so we silently upgrade it to 9/ (fix autobahn test 13.X which uses 8 for the windows size)
+
+## [5.2.0] - 2019-09-04
+
+- Fragmentation: for sent messages which are compressed, the continuation fragments should not have the rsv1 bit set (fix all autobahn tests for zlib compression 12.X)
+- Websocket Server / do a case insensitive string search when looking for an Upgrade header whose value is websocket. (some client use WebSocket with some upper-case characters)
+
+## [5.1.9] - 2019-09-03
+
+- ws autobahn / report progress with spdlog::info to get timing info
+- ws autobahn / use condition variables for stopping test case + add more logging on errors
+
+## [5.1.8] - 2019-09-03
+
+- Per message deflate/compression: handle fragmented messages (fix autobahn test: 12.1.X and probably others)
+
+## [5.1.7] - 2019-09-03
+
+- Receiving invalid UTF-8 TEXT message should fail and close the connection (fix remaining autobahn test: 6.X UTF-8 Handling)
+
+## [5.1.6] - 2019-09-03
+
+- Sending invalid UTF-8 TEXT message should fail and close the connection (fix remaining autobahn test: 6.X UTF-8 Handling)
+- Fix failing unittest which was sending binary data in text mode with WebSocket::send to call properly call WebSocket::sendBinary instead.
+- Validate that the reason is proper utf-8. (fix autobahn test 7.5.1)
+- Validate close codes. Autobahn 7.9.*
+
+## [5.1.5] - 2019-09-03
+
+Framentation: data and continuation blocks received out of order (fix autobahn test: 5.9 through 5.20 Fragmentation)
+
+## [5.1.4] - 2019-09-03
+
+Sending invalid UTF-8 TEXT message should fail and close the connection (fix **tons** of autobahn test: 6.X UTF-8 Handling)
+
+## [5.1.3] - 2019-09-03
+
+Message type (TEXT or BINARY) is invalid for received fragmented messages (fix autobahn test: 5.3 through 5.8 Fragmentation)
+
+## [5.1.2] - 2019-09-02
+
+Ping and Pong messages cannot be fragmented (fix autobahn test: 5.1 and 5.2 Fragmentation)
+
+## [5.1.1] - 2019-09-01
+
+Close connections when reserved bits are used (fix autobahn test: 3.X Reserved Bits)
+
+## [5.1.0] - 2019-08-31
+
+- ws autobahn / Add code to test websocket client compliance with the autobahn test-suite
+- add utf-8 validation code, not hooked up properly yet
+- Ping received with a payload too large (> 125 bytes) trigger a connection closure
+- cobra / add tracking about published messages
+- cobra / publish returns a message id, that can be used when
+- cobra / new message type in the message received handler when publish/ok is received (can be used to implement an ack system).
+
+## [5.0.9] - 2019-08-30
+
+- User-Agent header is set when not specified.
+- New option to cap the max wait between reconnection attempts. Still default to 10s. (setMaxWaitBetweenReconnectionRetries).
+
+```
+ws connect --max_wait 5000 ws://example.com # will only wait 5 seconds max between reconnection attempts
+```
+
+## [5.0.7] - 2019-08-23
+- WebSocket: add new option to pass in extra HTTP headers when connecting.
+- `ws connect` add new option (-H, works like [curl](https://stackoverflow.com/questions/356705/how-to-send-a-header-using-a-http-request-through-a-curl-call)) to pass in extra HTTP headers when connecting
+
+If you run against `ws echo_server` you will see the headers being received printed in the terminal.
+```
+ws connect -H "foo: bar" -H "baz: buz" ws://127.0.0.1:8008
+```
+
+- CobraConnection: sets a unique id field for all messages sent to [cobra](https://github.com/machinezone/cobra).
+- CobraConnection: sets a counter as a field for each event published.
+
+## [5.0.6] - 2019-08-22
+- Windows: silly compile error (poll should be in the global namespace)
+
+## [5.0.5] - 2019-08-22
+- Windows: use select instead of WSAPoll, through a poll wrapper
+
+## [5.0.4] - 2019-08-20
+- Windows build fixes (there was a problem with the use of ::poll that has a different name on Windows (WSAPoll))
+
+## [5.0.3] - 2019-08-14
+- CobraMetricThreadedPublisher _enable flag is an atomic, and CobraMetricsPublisher is enabled by default
+
+## [5.0.2] - 2019-08-01
+- ws cobra_subscribe has a new -q (quiet) option
+- ws cobra_subscribe knows to and display msg stats (count and # of messages received per second)
+- ws cobra_subscribe, cobra_to_statsd and cobra_to_sentry commands have a new option, --filter to restrict the events they want to receive
+
+## [5.0.1] - 2019-07-25
+- ws connect command has a new option to send in binary mode (still default to text)
+- ws connect command has readline history thanks to libnoise-cpp. Now ws connect one can use using arrows to lookup previous sent messages and edit them
+
+## [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
+- travis CI uses g++ on Linux
+
+## [4.0.0] - 2019-06-09
+### Changed
+- WebSocket::send() sends message in TEXT mode by default
+- WebSocketMessage sets a new binary field, which tells whether the received incoming message is binary or text
+- WebSocket::send takes a third arg, binary which default to true (can be text too)
+- WebSocket callback only take one object, a const ix::WebSocketMessagePtr& msg
+- Add explicit WebSocket::sendBinary method
+- New headers + WebSocketMessage class to hold message data, still not used across the board
+- Add test/compatibility folder with small servers and clients written in different languages and different libraries to test compatibility.
+- ws echo_server has a -g option to print a greeting message on connect
+- IXSocketMbedTLS: better error handling in close and connect
+
+## [3.1.2] - 2019-06-06
+### Added
+- ws connect has a -x option to disable per message deflate
+- Add WebSocket::disablePerMessageDeflate() option.
+
+## [3.0.0] - 2019-06-xx
+### Changed
+- TLS, aka SSL works on Windows (websocket and http clients)
+- ws command line tool build on Windows
+- Async API for HttpClient
+- HttpClient API changed to use shared_ptr for response and request

docs/build.md

@@ -0,0 +1,61 @@
+## Build
+
+### CMake
+
+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.
+
+```
+mkdir build # make a build dir so that you can build out of tree.
+cd build
+cmake -DUSE_TLS=1 ..
+make -j
+make install # will install to /usr/local on Unix, on macOS it is a good idea to sudo chown -R `whoami`:staff /usr/local
+```
+
+Headers and a static library will be installed to the target dir.
+There is a unittest which can be executed by typing `make test`.
+
+Options for building:
+
+* `-DUSE_TLS=1` will enable TLS support
+* `-DUSE_MBED_TLS=1` will use [mbedlts](https://tls.mbed.org/) for the TLS support (default on Windows)
+* `-DUSE_WS=1` will build the ws interactive command line tool
+
+If you are on Windows, look at the [appveyor](https://github.com/machinezone/IXWebSocket/blob/master/appveyor.yml) file that has instructions for building dependencies.
+
+### vcpkg
+
+It is possible to get IXWebSocket through Microsoft [vcpkg](https://github.com/microsoft/vcpkg).
+
+```
+vcpkg install ixwebsocket
+```
+
+### Conan
+
+Support for building with conan was contributed by Olivia Zoe (thanks !). The package name to reference is `IXWebSocket/5.0.0@LunarWatcher/stable`. The package is in the process to be published to the official conan package repo, but in the meantime, it can be accessed by adding a new remote
+
+```
+conan remote add remote_name_here https://api.bintray.com/conan/oliviazoe0/conan-packages
+```
+
+### Docker
+
+There is a Dockerfile for running the unittest on Linux, and to run the `ws` tool. It is also available on the docker registry.
+
+```
+docker run bsergean/ws
+```
+
+To use docker-compose you must make a docker container first.
+
+```
+$ make docker
+...
+$ docker compose up &
+...
+$ docker exec -it ixwebsocket_ws_1 bash
+app@ca2340eb9106:~$ ws --help
+ws is a websocket tool
+...
+```

docs/design.md

@@ -0,0 +1,77 @@
+## Implementation details
+
+### Per Message Deflate compression.
+
+The per message deflate compression option is supported. It can lead to very nice bandbwith savings (20x !) if your messages are similar, which is often the case for example for chat applications. All features of the spec should be supported.
+
+### TLS/SSL
+
+Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, OpenSSL is used on Android and Linux, mbedTLS is used on Windows.
+
+### Polling and background thread work
+
+No manual polling to fetch data is required. Data is sent and received instantly by using a background thread for receiving data and the select [system](http://man7.org/linux/man-pages/man2/select.2.html) call to be notified by the OS of incoming data. No timeout is used for select so that the background thread is only woken up when data is available, to optimize battery life. This is also the recommended way of using select according to the select tutorial, section [select law](https://linux.die.net/man/2/select_tut). Read and Writes to the socket are non blocking. Data is sent right away and not enqueued by writing directly to the socket, which is [possible](https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid) since system socket implementations allow concurrent read/writes. However concurrent writes need to be protected with mutex.
+
+### Automatic reconnection
+
+If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds. This behavior can be disabled.
+
+### Large messages
+
+Large frames are broken up into smaller chunks or messages to avoid filling up the os tcp buffers, which is permitted thanks to WebSocket [fragmentation](https://tools.ietf.org/html/rfc6455#section-5.4). Messages up to 1G were sent and received succesfully.
+
+### Testing
+
+The library has an interactive tool which is handy for testing compatibility ith other libraries. We have tested our client against Python, Erlang, Node.js, and C++ websocket server libraries.
+
+The unittest tries to be comprehensive, and has been running on multiple platoform, with different sanitizers such as thread sanitizer to catch data races or the undefined behavior sanitizer.
+
+The regression test is running after each commit on travis.
+
+## Limitations
+
+* On Windows TLS is not setup yet to validate certificates.
+* There is no convenient way to embed a ca cert.
+* Automatic reconnection works at the TCP socket level, and will detect remote end disconnects. However, if the device/computer network become unreachable (by turning off wifi), it is quite hard to reliably and timely detect it at the socket level using `recv` and `send` error codes. [Here](https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program) is a good discussion on the subject. This behavior is consistent with other runtimes such as node.js. One way to detect a disconnected device with low level C code is to do a name resolution with DNS but this can be expensive. Mobile devices have good and reliable API to do that.
+* The server code is using select to detect incoming data, and creates one OS thread per connection. This is not as scalable as strategies using epoll or kqueue.
+
+## C++ code organization
+
+Here is a simplistic diagram which explains how the code is structured in term of class/modules.
+
+```
++-----------------------+ --- Public
+|                       | Start the receiving Background thread. Auto reconnection. Simple websocket Ping.
+|  IXWebSocket          | Interface used by C++ test clients. No IX dependencies.
+|                       |
++-----------------------+
+|                       |
+|  IXWebSocketServer    | Run a server and give each connections its own WebSocket object.
+|                       | Each connection is handled in a new OS thread.
+|                       |
++-----------------------+ --- Private
+|                       |
+|  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
+|                       |
++-----------------------+
+|                       |
+|  IXWebSocketHandshake | Establish the connection between client and server.
+|                       |
++-----------------------+
+|                       |
+|  IXWebSocket          | ws://  Unencrypted Socket handler
+|  IXWebSocketAppleSSL  | wss:// TLS encrypted Socket AppleSSL handler. Used on iOS and macOS
+|  IXWebSocketOpenSSL   | wss:// TLS encrypted Socket OpenSSL handler.  Used on Android and Linux
+|                       |                                               Can be used on macOS too.
++-----------------------+
+|                       |
+|  IXSocketConnect      | Connect to the remote host (client).
+|                       |
++-----------------------+
+|                       |
+|  IXDNSLookup          | Does DNS resolution asynchronously so that it can be interrupted.
+|                       |
++-----------------------+
+```
+
+

docs/index.md

@@ -0,0 +1,46 @@
+![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
+
+## 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 and server HTTP communication. *TLS* aka *SSL* is supported. 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
+* Linux
+* Android
+* Windows
+
+## Example code
+
+```
+# Required on Windows
+ix::initNetSystem();
+
+# Our websocket object
+ix::WebSocket webSocket;
+
+std::string url("ws://localhost:8080/");
+webSocket.setUrl(url);
+
+// Setup a callback to be fired when a message or an event (open, close, error) is received
+webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+    {
+        if (msg->type == ix::WebSocketMessageType::Message)
+        {
+            std::cout << msg->str << std::endl;
+        }
+    }
+);
+
+// Now that our callback is setup, we can start our background thread and receive messages
+webSocket.start();
+
+// Send a message to the server (default to TEXT mode)
+webSocket.send("hello world");
+```
+
+## Why another library ?
+
+There are 2 main reasons that explain why IXWebSocket got written. First, we needed a C++ cross-platform client library, which should have few dependencies. What looked like the most solid one, [websocketpp](https://github.com/zaphoyd/websocketpp) did depend on boost and this was not an option for us. Secondly, there were other available libraries with fewer dependencies (C ones), but they required calling an explicit poll routine periodically to know if a client had received data from a server, which was not elegant.
+
+We started by solving those 2 problems, then we added server websocket code, then an HTTP client, and finally a very simple HTTP server.

docs/usage.md

@@ -0,0 +1,418 @@
+# Examples
+
+The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage.
+
+## Windows note
+
+To use the network system on Windows, you need to initialize it once with *WSAStartup()* and clean it up with *WSACleanup()*. We have helpers for that which you can use, see below. This init would typically take place in your main function.
+
+```
+#include <ixwebsocket/IXNetSystem.h>
+
+int main()
+{
+    ix::initNetSystem();
+
+    ...
+
+    ix::uninitNetSystem();
+    return 0;
+}
+```
+
+## WebSocket client API
+
+```
+#include <ixwebsocket/IXWebSocket.h>
+
+...
+
+# Our websocket object
+ix::WebSocket webSocket;
+
+std::string url("ws://localhost:8080/");
+webSocket.setUrl(url);
+
+// Optional heart beat, sent every 45 seconds when there is not any traffic
+// to make sure that load balancers do not kill an idle connection.
+webSocket.setHeartBeatPeriod(45);
+
+// Per message deflate connection is enabled by default. You can tweak its parameters or disable it
+webSocket.disablePerMessageDeflate();
+
+// Setup a callback to be fired when a message or an event (open, close, error) is received
+webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+    {
+        if (msg->type == ix::WebSocketMessageType::Message)
+        {
+            std::cout << msg->str << std::endl;
+        }
+    }
+);
+
+// Now that our callback is setup, we can start our background thread and receive messages
+webSocket.start();
+
+// Send a message to the server (default to TEXT mode)
+webSocket.send("hello world");
+
+// The message can be sent in BINARY mode (useful if you send MsgPack data for example)
+webSocket.sendBinary("some serialized binary data");
+
+// ... finally ...
+
+// Stop the connection
+webSocket.stop()
+```
+
+### Sending messages
+
+`websocket.send("foo")` will send a message.
+
+If the connection was closed and sending failed, the return value will be set to false.
+
+### ReadyState
+
+`getReadyState()` returns the state of the connection. There are 4 possible states.
+
+1. ReadyState::Connecting - The connection is not yet open.
+2. ReadyState::Open       - The connection is open and ready to communicate.
+3. ReadyState::Closing    - The connection is in the process of closing.
+4. ReadyState::Closed     - The connection is closed or could not be opened.
+
+### Open and Close notifications
+
+The onMessage event will be fired when the connection is opened or closed. This is similar to the [Javascript browser API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), which has `open` and `close` events notification that can be registered with the browser `addEventListener`.
+
+```
+webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+    {
+        if (msg->type == ix::WebSocketMessageType::Open)
+        {
+            std::cout << "send greetings" << std::endl;
+
+            // Headers can be inspected (pairs of string/string)
+            std::cout << "Handshake Headers:" << std::endl;
+            for (auto it : msg->headers)
+            {
+                std::cout << it.first << ": " << it.second << std::endl;
+            }
+        }
+        else if (msg->type == ix::WebSocketMessageType::Close)
+        {
+            std::cout << "disconnected" << std::endl;
+
+            // The server can send an explicit code and reason for closing.
+            // This data can be accessed through the closeInfo object.
+            std::cout << msg->closeInfo.code << std::endl;
+            std::cout << msg->closeInfo.reason << std::endl;
+        }
+    }
+);
+```
+
+### Error notification
+
+A message will be fired when there is an error with the connection. The message type will be `ix::WebSocketMessageType::Error`. Multiple fields will be available on the event to describe the error.
+
+```
+webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+    {
+        if (msg->type == ix::WebSocketMessageType::Error)
+        {
+            std::stringstream ss;
+            ss << "Error: "         << msg->errorInfo.reason      << std::endl;
+            ss << "#retries: "      << msg->eventInfo.retries     << std::endl;
+            ss << "Wait time(ms): " << msg->eventInfo.wait_time   << std::endl;
+            ss << "HTTP Status: "   << msg->eventInfo.http_status << std::endl;
+            std::cout << ss.str() << std::endl;
+        }
+    }
+);
+```
+
+### start, stop
+
+1. `websocket.start()` connect to the remote server and starts the message receiving background thread.
+2. `websocket.stop()` disconnect from the remote server and closes the background thread.
+
+### Configuring the remote url
+
+The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
+
+```
+std::string url("wss://example.com");
+websocket.configure(url);
+```
+
+### Ping/Pong support
+
+Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
+
+```
+webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+    {
+        if (msg->type == ix::WebSocketMessageType::Ping ||
+            msg->type == ix::WebSocketMessageType::Pong)
+        {
+            std::cout << "pong data: " << msg->str << std::endl;
+        }
+    }
+);
+```
+
+A ping message can be sent to the server, with an optional data string.
+
+```
+websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
+```
+
+### Heartbeat.
+
+You can configure an optional heart beat / keep-alive, sent every 45 seconds
+when there is no any traffic to make sure that load balancers do not kill an
+idle connection.
+
+```
+webSocket.setHeartBeatPeriod(45);
+```
+
+### Supply extra HTTP headers.
+
+You can set extra HTTP headers to be sent during the WebSocket handshake.
+
+```
+WebSocketHttpHeaders headers;
+headers["foo"] = "bar";
+webSocket.setExtraHeaders(headers);
+```
+
+### Automatic reconnection
+
+Automatic reconnection kicks in when the connection is disconnected without the user consent. This feature is on by default and can be turned off.
+
+```
+webSocket.enableAutomaticReconnection();  // turn on
+webSocket.disableAutomaticReconnection(); // turn off
+bool enabled = webSocket.isAutomaticReconnectionEnabled(); // query state
+```
+
+The technique to calculate wait time is called [exponential
+backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html). Here
+are the default waiting times between attempts (from connecting with `ws connect ws://foo.com`)
+
+```
+> Connection error: Got bad status connecting to foo.com, status: 301, HTTP Status line: HTTP/1.1 301 Moved Permanently
+
+#retries: 1
+Wait time(ms): 100
+#retries: 2
+Wait time(ms): 200
+#retries: 3
+Wait time(ms): 400
+#retries: 4
+Wait time(ms): 800
+#retries: 5
+Wait time(ms): 1600
+#retries: 6
+Wait time(ms): 3200
+#retries: 7
+Wait time(ms): 6400
+#retries: 8
+Wait time(ms): 10000
+```
+
+The waiting time is capped by default at 10s between 2 attempts, but that value can be changed and queried.
+
+```
+webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s
+uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
+```
+
+## WebSocket server API
+
+```
+#include <ixwebsocket/IXWebSocketServer.h>
+
+...
+
+// Run a server on localhost at a given port.
+// Bound host name, max connections and listen backlog can also be passed in as parameters.
+ix::WebSocketServer server(port);
+
+server.setOnConnectionCallback(
+    [&server](std::shared_ptr<WebSocket> webSocket,
+              std::shared_ptr<ConnectionState> connectionState)
+    {
+        webSocket->setOnMessageCallback(
+            [webSocket, connectionState, &server](const ix::WebSocketMessagePtr msg)
+            {
+                if (msg->type == ix::WebSocketMessageType::Open)
+                {
+                    std::cerr << "New connection" << std::endl;
+
+                    // A connection state object is available, and has a default id
+                    // You can subclass ConnectionState and pass an alternate factory
+                    // to override it. It is useful if you want to store custom
+                    // attributes per connection (authenticated bool flag, attributes, etc...)
+                    std::cerr << "id: " << connectionState->getId() << std::endl;
+
+                    // The uri the client did connect to.
+                    std::cerr << "Uri: " << msg->openInfo.uri << std::endl;
+
+                    std::cerr << "Headers:" << std::endl;
+                    for (auto it : msg->openInfo.headers)
+                    {
+                        std::cerr << it.first << ": " << it.second << std::endl;
+                    }
+                }
+                else if (msg->type == ix::WebSocketMessageType::Message)
+                {
+                    // For an echo server, we just send back to the client whatever was received by the server
+                    // All connected clients are available in an std::set. See the broadcast cpp example.
+                    // Second parameter tells whether we are sending the message in binary or text mode.
+                    // Here we send it in the same mode as it was received.
+                    webSocket->send(msg->str, msg->binary);
+                }
+            }
+        );
+    }
+);
+
+auto res = server.listen();
+if (!res.first)
+{
+    // Error handling
+    return 1;
+}
+
+// Run the server in the background. Server can be stoped by calling server.stop()
+server.start();
+
+// Block until server.stop() is called.
+server.wait();
+
+```
+
+## HTTP client API
+
+```
+#include <ixwebsocket/IXHttpClient.h>
+
+...
+
+//
+// Preparation
+//
+HttpClient httpClient;
+HttpRequestArgsPtr args = httpClient.createRequest();
+
+// Custom headers can be set
+WebSocketHttpHeaders headers;
+headers["Foo"] = "bar";
+args->extraHeaders = headers;
+
+// Timeout options
+args->connectTimeout = connectTimeout;
+args->transferTimeout = transferTimeout;
+
+// Redirect options
+args->followRedirects = followRedirects;
+args->maxRedirects = maxRedirects;
+
+// Misc
+args->compress = compress; // Enable gzip compression
+args->verbose = verbose;
+args->logger = [](const std::string& msg)
+{
+    std::cout << msg;
+};
+
+//
+// Synchronous Request
+//
+HttpResponsePtr out;
+std::string url = "https://www.google.com";
+
+// HEAD request
+out = httpClient.head(url, args);
+
+// GET request
+out = httpClient.get(url, args);
+
+// POST request with parameters
+HttpParameters httpParameters;
+httpParameters["foo"] = "bar";
+out = httpClient.post(url, httpParameters, args);
+
+// POST request with a body
+out = httpClient.post(url, std::string("foo=bar"), args);
+
+//
+// Result
+//
+auto statusCode = response->statusCode; // Can be HttpErrorCode::Ok, HttpErrorCode::UrlMalformed, etc...
+auto errorCode = response->errorCode; // 200, 404, etc...
+auto responseHeaders = response->headers; // All the headers in a special case-insensitive unordered_map of (string, string)
+auto payload = response->payload; // All the bytes from the response as an std::string
+auto errorMsg = response->errorMsg; // Descriptive error message in case of failure
+auto uploadSize = response->uploadSize; // Byte count of uploaded data
+auto downloadSize = response->downloadSize; // Byte count of downloaded data
+
+//
+// Asynchronous Request
+//
+bool async = true;
+HttpClient httpClient(async);
+auto args = httpClient.createRequest(url, HttpClient::kGet);
+
+// Push the request to a queue,
+bool ok = httpClient.performRequest(args, [](const HttpResponsePtr& response)
+    {
+        // This callback execute in a background thread. Make sure you uses appropriate protection such as mutex
+        auto statusCode = response->statusCode; // acess results
+    }
+);
+
+// ok will be false if your httpClient is not async
+```
+
+## HTTP server API
+
+```
+#include <ixwebsocket/IXHttpServer.h>
+
+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);
+}
+```

docs/ws.md

@@ -0,0 +1,73 @@
+## General
+
+ws is a command line tool that should exercise most of the IXWebSocket code, and provide example code.
+
+```
+ws is a websocket tool
+Usage: ws [OPTIONS] SUBCOMMAND
+
+Options:
+  -h,--help                   Print this help message and exit
+
+Subcommands:
+  send                        Send a file
+  receive                     Receive a file
+  transfer                    Broadcasting server
+  connect                     Connect to a remote server
+  chat                        Group chat
+  echo_server                 Echo server
+  broadcast_server            Broadcasting server
+  ping                        Ping pong
+  curl                        HTTP Client
+  redis_publish               Redis publisher
+  redis_subscribe             Redis subscriber
+  cobra_subscribe             Cobra subscriber
+  cobra_publish               Cobra publisher
+  cobra_to_statsd             Cobra to statsd
+  cobra_to_sentry             Cobra to sentry
+  snake                       Snake server
+  httpd                       HTTP server
+```
+
+## File transfer
+
+```
+# Start transfer server, which is just a broadcast server at this point
+ws transfer # running on port 8080.
+
+# Start receiver first
+ws receive ws://localhost:8080
+
+# Then send a file. File will be received and written to disk by the receiver process
+ws send ws://localhost:8080 /file/to/path
+```
+
+## HTTP Client
+
+```
+$ ws curl --help
+HTTP Client
+Usage: ws curl [OPTIONS] url
+
+Positionals:
+  url TEXT REQUIRED           Connection url
+
+Options:
+  -h,--help                   Print this help message and exit
+  -d TEXT                     Form data
+  -F TEXT                     Form data
+  -H TEXT                     Header
+  --output TEXT               Output file
+  -I                          Send a HEAD request
+  -L                          Follow redirects
+  --max-redirects INT         Max Redirects
+  -v                          Verbose
+  -O                          Save output to disk
+  --compress                  Enable gzip compression
+  --connect-timeout INT       Connection timeout
+  --transfer-timeout INT      Transfer timeout
+```
+
+## Cobra Client
+
+[cobra](https://github.com/machinezone/cobra) is a real time messenging server. ws has sub-command to interacti with cobra.

ixcobra/CMakeLists.txt

@@ -0,0 +1,30 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+#
+
+set (IXCOBRA_SOURCES
+    ixcobra/IXCobraConnection.cpp
+    ixcobra/IXCobraMetricsThreadedPublisher.cpp
+    ixcobra/IXCobraMetricsPublisher.cpp
+)
+
+set (IXCOBRA_HEADERS
+    ixcobra/IXCobraConnection.h
+    ixcobra/IXCobraMetricsThreadedPublisher.h
+    ixcobra/IXCobraMetricsPublisher.h
+)
+
+add_library(ixcobra STATIC
+    ${IXCOBRA_SOURCES}
+    ${IXCOBRA_HEADERS}
+)
+
+set(IXCOBRA_INCLUDE_DIRS
+    .
+    ..
+    ../ixcore
+    ../ixcrypto
+    ../third_party)
+
+target_include_directories( ixcobra PUBLIC ${IXCOBRA_INCLUDE_DIRS} )

ixcobra/ixcobra/IXCobraConnection.cpp

@@ -13,18 +13,21 @@
 #include <cmath>
 #include <cassert>
 #include <cstring>
+#include <iostream>
 
 
 namespace ix
 {
     TrafficTrackerCallback CobraConnection::_trafficTrackerCallback = nullptr;
+    PublishTrackerCallback CobraConnection::_publishTrackerCallback = nullptr;
     constexpr size_t CobraConnection::kQueueMaxSize;
 
     CobraConnection::CobraConnection() :
         _webSocket(new WebSocket()),
         _publishMode(CobraConnection_PublishMode_Immediate),
         _authenticated(false),
-        _eventCallback(nullptr)
+        _eventCallback(nullptr),
+        _id(0)
     {
         _pdu["action"] = "rtm/publish";
 
@@ -55,6 +58,24 @@ namespace ix
         }
     }
 
+    void CobraConnection::setPublishTrackerCallback(const PublishTrackerCallback& callback)
+    {
+        _publishTrackerCallback = callback;
+    }
+
+    void CobraConnection::resetPublishTrackerCallback()
+    {
+        setPublishTrackerCallback(nullptr);
+    }
+
+    void CobraConnection::invokePublishTrackerCallback(bool sent, bool acked)
+    {
+        if (_publishTrackerCallback)
+        {
+            _publishTrackerCallback(sent, acked);
+        }
+    }
+
     void CobraConnection::setEventCallback(const EventCallback& eventCallback)
     {
         std::lock_guard<std::mutex> lock(_eventCallbackMutex);
@@ -62,19 +83,20 @@ namespace ix
     }
 
     void CobraConnection::invokeEventCallback(ix::CobraConnectionEventType eventType,
-                                               const std::string& errorMsg,
-                                               const WebSocketHttpHeaders& headers,
-                                               const std::string& subscriptionId)
+                                              const std::string& errorMsg,
+                                              const WebSocketHttpHeaders& headers,
+                                              const std::string& subscriptionId,
+                                              CobraConnection::MsgId msgId)
     {
         std::lock_guard<std::mutex> lock(_eventCallbackMutex);
         if (_eventCallback)
         {
-            _eventCallback(eventType, errorMsg, headers, subscriptionId);
+            _eventCallback(eventType, errorMsg, headers, subscriptionId, msgId);
         }
     }
 
     void CobraConnection::invokeErrorCallback(const std::string& errorMsg,
-                                               const std::string& serializedPdu)
+                                              const std::string& serializedPdu)
     {
         std::stringstream ss;
         ss << errorMsg << " : received pdu => " << serializedPdu;
@@ -90,46 +112,41 @@ namespace ix
     void CobraConnection::initWebSocketOnMessageCallback()
     {
         _webSocket->setOnMessageCallback(
-            [this](ix::WebSocketMessageType messageType,
-                   const std::string& str,
-                   size_t wireSize,
-                   const ix::WebSocketErrorInfo& error,
-                   const ix::WebSocketOpenInfo& openInfo,
-                   const ix::WebSocketCloseInfo& closeInfo)
+            [this](const ix::WebSocketMessagePtr& msg)
             {
-                CobraConnection::invokeTrafficTrackerCallback(wireSize, true);
+                CobraConnection::invokeTrafficTrackerCallback(msg->wireSize, true);
 
                 std::stringstream ss;
-                if (messageType == ix::WebSocket_MessageType_Open)
+                if (msg->type == ix::WebSocketMessageType::Open)
                 {
                     invokeEventCallback(ix::CobraConnection_EventType_Open,
                                         std::string(),
-                                        openInfo.headers);
+                                        msg->openInfo.headers);
                     sendHandshakeMessage();
                 }
-                else if (messageType == ix::WebSocket_MessageType_Close)
+                else if (msg->type == ix::WebSocketMessageType::Close)
                 {
                     _authenticated = false;
 
                     std::stringstream ss;
-                    ss << "Close code " << closeInfo.code;
-                    ss << " reason " << closeInfo.reason;
+                    ss << "Close code " << msg->closeInfo.code;
+                    ss << " reason " << msg->closeInfo.reason;
                     invokeEventCallback(ix::CobraConnection_EventType_Closed,
                                         ss.str());
                 }
-                else if (messageType == ix::WebSocket_MessageType_Message)
+                else if (msg->type == ix::WebSocketMessageType::Message)
                 {
                     Json::Value data;
                     Json::Reader reader;
-                    if (!reader.parse(str, data))
+                    if (!reader.parse(msg->str, data))
                     {
-                        invokeErrorCallback("Invalid json", str);
+                        invokeErrorCallback("Invalid json", msg->str);
                         return;
                     }
 
                     if (!data.isMember("action"))
                     {
-                        invokeErrorCallback("Missing action", str);
+                        invokeErrorCallback("Missing action", msg->str);
                         return;
                     }
 
@@ -139,12 +156,12 @@ namespace ix
                     {
                         if (!handleHandshakeResponse(data))
                         {
-                            invokeErrorCallback("Error extracting nonce from handshake response", str);
+                            invokeErrorCallback("Error extracting nonce from handshake response", msg->str);
                         }
                     }
                     else if (action == "auth/handshake/error")
                     {
-                        invokeErrorCallback("Handshake error", str);
+                        invokeErrorCallback("Handshake error", msg->str);
                     }
                     else if (action == "auth/authenticate/ok")
                     {
@@ -154,7 +171,7 @@ namespace ix
                     }
                     else if (action == "auth/authenticate/error")
                     {
-                        invokeErrorCallback("Authentication error", str);
+                        invokeErrorCallback("Authentication error", msg->str);
                     }
                     else if (action == "rtm/subscription/data")
                     {
@@ -164,36 +181,47 @@ namespace ix
                     {
                         if (!handleSubscriptionResponse(data))
                         {
-                            invokeErrorCallback("Error processing subscribe response", str);
+                            invokeErrorCallback("Error processing subscribe response", msg->str);
                         }
                     }
                     else if (action == "rtm/subscribe/error")
                     {
-                        invokeErrorCallback("Subscription error", str);
+                        invokeErrorCallback("Subscription error", msg->str);
                     }
                     else if (action == "rtm/unsubscribe/ok")
                     {
                         if (!handleUnsubscriptionResponse(data))
                         {
-                            invokeErrorCallback("Error processing subscribe response", str);
+                            invokeErrorCallback("Error processing unsubscribe response", msg->str);
                         }
                     }
                     else if (action == "rtm/unsubscribe/error")
                     {
-                        invokeErrorCallback("Unsubscription error", str);
+                        invokeErrorCallback("Unsubscription error", msg->str);
+                    }
+                    else if (action == "rtm/publish/ok")
+                    {
+                        if (!handlePublishResponse(data))
+                        {
+                            invokeErrorCallback("Error processing publish response", msg->str);
+                        }
+                    }
+                    else if (action == "rtm/publish/error")
+                    {
+                        invokeErrorCallback("Publish error", msg->str);
                     }
                     else
                     {
-                        invokeErrorCallback("Un-handled message type", str);
+                        invokeErrorCallback("Un-handled message type", msg->str);
                     }
                 }
-                else if (messageType == ix::WebSocket_MessageType_Error)
+                else if (msg->type == ix::WebSocketMessageType::Error)
                 {
                     std::stringstream ss;
-                    ss << "Connection error: " << error.reason      << std::endl;
-                    ss << "#retries: "         << error.retries     << std::endl;
-                    ss << "Wait time(ms): "    << error.wait_time   << std::endl;
-                    ss << "HTTP Status: "      << error.http_status << std::endl;
+                    ss << "Connection error: " << msg->errorInfo.reason      << std::endl;
+                    ss << "#retries: "         << msg->errorInfo.retries     << std::endl;
+                    ss << "Wait time(ms): "    << msg->errorInfo.wait_time   << std::endl;
+                    ss << "HTTP Status: "      << msg->errorInfo.http_status << std::endl;
                     invokeErrorCallback(ss.str(), std::string());
                 }
         });
@@ -249,6 +277,7 @@ namespace ix
         Json::Value pdu;
         pdu["action"] = "auth/handshake";
         pdu["body"] = body;
+        pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(pdu);
         CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
@@ -272,6 +301,8 @@ namespace ix
     //
     bool CobraConnection::handleHandshakeResponse(const Json::Value& pdu)
     {
+        if (!pdu.isObject()) return false;
+
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
@@ -311,6 +342,7 @@ namespace ix
         Json::Value pdu;
         pdu["action"] = "auth/authenticate";
         pdu["body"] = body;
+        pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(pdu);
         CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
@@ -320,6 +352,8 @@ namespace ix
 
     bool CobraConnection::handleSubscriptionResponse(const Json::Value& pdu)
     {
+        if (!pdu.isObject()) return false;
+
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
@@ -336,6 +370,8 @@ namespace ix
 
     bool CobraConnection::handleUnsubscriptionResponse(const Json::Value& pdu)
     {
+        if (!pdu.isObject()) return false;
+
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
@@ -352,6 +388,8 @@ namespace ix
 
     bool CobraConnection::handleSubscriptionData(const Json::Value& pdu)
     {
+        if (!pdu.isObject()) return false;
+
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
@@ -376,6 +414,26 @@ namespace ix
         return true;
     }
 
+    bool CobraConnection::handlePublishResponse(const Json::Value& pdu)
+    {
+        if (!pdu.isObject()) return false;
+
+        if (!pdu.isMember("id")) return false;
+        Json::Value id = pdu["id"];
+
+        if (!id.isUInt64()) return false;
+
+        uint64_t msgId = id.asUInt64();
+
+        invokeEventCallback(ix::CobraConnection_EventType_Published,
+                            std::string(), WebSocketHttpHeaders(),
+                            std::string(), msgId);
+
+        invokePublishTrackerCallback(false, true);
+
+        return true;
+    }
+
     bool CobraConnection::connect()
     {
         _webSocket->start();
@@ -384,7 +442,7 @@ namespace ix
 
     bool CobraConnection::isConnected() const
     {
-        return _webSocket->getReadyState() == ix::WebSocket_ReadyState_Open;
+        return _webSocket->getReadyState() == ix::ReadyState::Open;
     }
 
     bool CobraConnection::isAuthenticated() const
@@ -401,48 +459,55 @@ namespace ix
     //
     // publish is not thread safe as we are trying to reuse some Json objects.
     //
-    bool CobraConnection::publish(const Json::Value& channels,
-                                   const Json::Value& msg)
+    CobraConnection::MsgId CobraConnection::publish(const Json::Value& channels,
+                                                    const Json::Value& msg)
     {
+        invokePublishTrackerCallback(true, false);
+
+        CobraConnection::MsgId msgId = _id;
+
         _body["channels"] = channels;
         _body["message"] = msg;
         _pdu["body"] = _body;
+        _pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(_pdu);
 
-        if (_publishMode == CobraConnection_PublishMode_Batch)
+        //
+        // 1. When we use batch mode, we just enqueue and will do the flush explicitely
+        // 2. When we aren't authenticated yet to the cobra server, we need to enqueue
+        //    and retry later
+        // 3. If the network connection was droped (WebSocket::send will return false),
+        //    it means the message won't be sent so we need to enqueue as well.
+        //
+        // The order of the conditionals is important.
+        //
+        if (_publishMode == CobraConnection_PublishMode_Batch || !_authenticated ||
+            !publishMessage(serializedJson))
         {
             enqueue(serializedJson);
-            return true;
         }
 
-        //
-        // Fast path. We are authenticated and the publishing succeed
-        //            This should happen for 99% of the cases.
-        //
-        if (_authenticated && publishMessage(serializedJson))
-        {
-            return true;
-        }
-        else // Or else we enqueue
-             // Slow code path is when we haven't connected yet (startup),
-             // or when the connection drops for some reason.
-        {
-            enqueue(serializedJson);
-            return false;
-        }
+        return msgId;
     }
 
     void CobraConnection::subscribe(const std::string& channel,
-                                     SubscriptionCallback cb)
+                                    const std::string& filter,
+                                    SubscriptionCallback cb)
     {
         // Create and send a subscribe pdu
         Json::Value body;
         body["channel"] = channel;
 
+        if (!filter.empty())
+        {
+            body["filter"] = filter;
+        }
+
         Json::Value pdu;
         pdu["action"] = "rtm/subscribe";
         pdu["body"] = body;
+        pdu["id"] = Json::UInt64(_id++);
 
         _webSocket->send(pdu.toStyledString());
 
@@ -468,6 +533,7 @@ namespace ix
         Json::Value pdu;
         pdu["action"] = "rtm/unsubscribe";
         pdu["body"] = body;
+        pdu["id"] = Json::UInt64(_id++);
 
         _webSocket->send(pdu.toStyledString());
     }
@@ -521,7 +587,7 @@ namespace ix
     {
         auto webSocketSendInfo = _webSocket->send(serializedJson);
         CobraConnection::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize,
-                                                       false);
+                                                      false);
         return webSocketSendInfo.success;
     }
 

ixcobra/ixcobra/IXCobraConnection.h

@@ -6,16 +6,16 @@
 
 #pragma once
 
+#include <ixwebsocket/IXWebSocketHttpHeaders.h>
+#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
+#include <jsoncpp/json/json.h>
+#include <memory>
 #include <mutex>
 #include <queue>
 #include <string>
 #include <thread>
 #include <unordered_map>
-#include <memory>
-
-#include <jsoncpp/json/json.h>
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
+#include <limits>
 
 namespace ix
 {
@@ -28,7 +28,8 @@ namespace ix
         CobraConnection_EventType_Open = 2,
         CobraConnection_EventType_Closed = 3,
         CobraConnection_EventType_Subscribed = 4,
-        CobraConnection_EventType_UnSubscribed = 5
+        CobraConnection_EventType_UnSubscribed = 5,
+        CobraConnection_EventType_Published = 6
     };
 
     enum CobraConnectionPublishMode
@@ -41,12 +42,17 @@ namespace ix
     using EventCallback = std::function<void(CobraConnectionEventType,
                                              const std::string&,
                                              const WebSocketHttpHeaders&,
-                                             const std::string&)>;
+                                             const std::string&,
+                                             uint64_t msgId)>;
+
     using TrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
+    using PublishTrackerCallback = std::function<void(bool sent, bool acked)>;
 
     class CobraConnection
     {
     public:
+        using MsgId = uint64_t;
+
         CobraConnection();
         ~CobraConnection();
 
@@ -58,11 +64,18 @@ namespace ix
                        const std::string& rolesecret,
                        const WebSocketPerMessageDeflateOptions& webSocketPerMessageDeflateOptions);
 
+        /// Set the traffic tracker callback
         static void setTrafficTrackerCallback(const TrafficTrackerCallback& callback);
 
         /// Reset the traffic tracker callback to an no-op one.
         static void resetTrafficTrackerCallback();
 
+        /// Set the publish tracker callback
+        static void setPublishTrackerCallback(const PublishTrackerCallback& callback);
+
+        /// Reset the publish tracker callback to an no-op one.
+        static void resetPublishTrackerCallback();
+
         /// Set the closed callback
         void setEventCallback(const EventCallback& eventCallback);
 
@@ -72,12 +85,13 @@ namespace ix
         /// Publish a message to a channel
         ///
         /// No-op if the connection is not established
-        bool publish(const Json::Value& channels,
-                     const Json::Value& msg);
+        MsgId publish(const Json::Value& channels, const Json::Value& msg);
 
         // Subscribe to a channel, and execute a callback when an incoming
         // message arrives.
-        void subscribe(const std::string& channel, SubscriptionCallback cb);
+        void subscribe(const std::string& channel,
+                       const std::string& filter = std::string(),
+                       SubscriptionCallback cb = nullptr);
 
         /// Unsubscribe from a channel
         void unsubscribe(const std::string& channel);
@@ -111,6 +125,7 @@ namespace ix
         bool handleSubscriptionData(const Json::Value& pdu);
         bool handleSubscriptionResponse(const Json::Value& pdu);
         bool handleUnsubscriptionResponse(const Json::Value& pdu);
+        bool handlePublishResponse(const Json::Value& pdu);
 
         void initWebSocketOnMessageCallback();
 
@@ -121,13 +136,16 @@ namespace ix
         /// Invoke the traffic tracker callback
         static void invokeTrafficTrackerCallback(size_t size, bool incoming);
 
+        /// Invoke the publish tracker callback
+        static void invokePublishTrackerCallback(bool sent, bool acked);
+
         /// Invoke event callbacks
         void invokeEventCallback(CobraConnectionEventType eventType,
                                  const std::string& errorMsg = std::string(),
                                  const WebSocketHttpHeaders& headers = WebSocketHttpHeaders(),
-                                 const std::string& subscriptionId = std::string());
-        void invokeErrorCallback(const std::string& errorMsg,
-                                 const std::string& serializedPdu);
+                                 const std::string& subscriptionId = std::string(),
+                                 uint64_t msgId = std::numeric_limits<uint64_t>::max());
+        void invokeErrorCallback(const std::string& errorMsg, const std::string& serializedPdu);
 
         ///
         /// Member variables
@@ -151,6 +169,9 @@ namespace ix
         /// Traffic tracker callback
         static TrafficTrackerCallback _trafficTrackerCallback;
 
+        /// Publish tracker callback
+        static PublishTrackerCallback _publishTrackerCallback;
+
         /// Cobra events callbacks
         EventCallback _eventCallback;
         mutable std::mutex _eventCallbackMutex;
@@ -169,6 +190,9 @@ namespace ix
 
         // Cap the queue size (100 elems so far -> ~100k)
         static constexpr size_t kQueueMaxSize = 256;
+
+        // Each pdu sent should have an incremental unique id
+        std::atomic<uint64_t> _id;
     };
 
 } // namespace ix

ixcobra/ixcobra/IXCobraMetricsPublisher.cpp

@@ -13,11 +13,11 @@
 namespace ix
 {
     const int CobraMetricsPublisher::kVersion = 1;
-    const std::string CobraMetricsPublisher::kSetRateControlId = "cms_set_rate_control_id";
-    const std::string CobraMetricsPublisher::kSetBlacklistId = "cms_set_blacklist_id";
+    const std::string CobraMetricsPublisher::kSetRateControlId = "sms_set_rate_control_id";
+    const std::string CobraMetricsPublisher::kSetBlacklistId = "sms_set_blacklist_id";
 
     CobraMetricsPublisher::CobraMetricsPublisher() :
-        _enabled(false)
+        _enabled(true)
     {
     }
 
@@ -184,13 +184,26 @@ namespace ix
         msg["data"] = data;
         msg["session"] = _session;
         msg["version"] = kVersion;
-        msg["timestamp"] = getMillisecondsSinceEpoch();
+        msg["timestamp"] = Json::UInt64(getMillisecondsSinceEpoch());
 
         {
             std::lock_guard<std::mutex> lock(_device_mutex);
             msg["device"] = _device;
         }
 
+        {
+            //
+            // Bump a counter for each id
+            // This is used to make sure that we are not
+            // dropping messages, by checking that all the ids is the list of
+            // all natural numbers until the last value sent (0, 1, 2, ..., N)
+            //
+            std::lock_guard<std::mutex> lock(_device_mutex);
+            auto it = _counters.emplace(id, 0);
+            msg["per_id_counter"] = it.first->second;
+            it.first->second += 1;
+        }
+
         // Now actually enqueue the task
         _cobra_metrics_theaded_publisher.push(msg);
     }

ixcobra/ixcobra/IXCobraMetricsPublisher.h

@@ -7,12 +7,11 @@
 #pragma once
 
 #include "IXCobraMetricsThreadedPublisher.h"
-
+#include <atomic>
+#include <chrono>
 #include <jsoncpp/json/json.h>
-
 #include <string>
 #include <unordered_map>
-#include <chrono>
 
 namespace ix
 {
@@ -28,10 +27,11 @@ namespace ix
         /// to make shouldPush as fast as possible. _enabled default to false.
         ///
         /// The code that set those is ran only once at init, and
-        /// the last value to be set is _enabled, which is also the first value checked in shouldPush,
-        /// so there shouldn't be any race condition.
+        /// the last value to be set is _enabled, which is also the first value checked in
+        /// shouldPush, so there shouldn't be any race condition.
         ///
-        /// 2. The queue of messages is thread safe, so multiple metrics can be safely pushed on multiple threads
+        /// 2. The queue of messages is thread safe, so multiple metrics can be safely pushed on
+        /// multiple threads
         ///
         /// 3. Access to _last_update is protected as it needs to be read/write.
         ///
@@ -62,34 +62,32 @@ namespace ix
         void push(const std::string& id,
                   const CobraMetricsPublisher::Message& data = CobraMetricsPublisher::Message());
 
-        /// Richer interface using json, which supports types (bool, int, float) and hierarchies of elements
+        /// Richer interface using json, which supports types (bool, int, float) and hierarchies of
+        /// elements
         ///
-        /// The shouldPushTest argument should be set to false, and used in combination with the shouldPush method
-        /// for places where we want to be as lightweight as possible when collecting metrics. When set to false,
-        /// it is used so that we don't do double work when computing whether a metrics should be sent or not.
-        void push(const std::string& id,
-                  const Json::Value& data,
-                  bool shouldPushTest = true);
+        /// The shouldPushTest argument should be set to false, and used in combination with the
+        /// shouldPush method for places where we want to be as lightweight as possible when
+        /// collecting metrics. When set to false, it is used so that we don't do double work when
+        /// computing whether a metrics should be sent or not.
+        void push(const std::string& id, const Json::Value& data, bool shouldPushTest = true);
 
         /// Interface used by lua. msg is a json encoded string.
-        void push(const std::string& id,
-                  const std::string& data,
-                  bool shouldPushTest = true);
+        void push(const std::string& id, const std::string& data, bool shouldPushTest = true);
 
         /// Tells whether a metric can be pushed.
         /// A metric can be pushed if it satisfies those conditions:
         ///
         /// 1. the metrics system should be enabled
         /// 2. the metrics shouldn't be black-listed
-        /// 3. the metrics shouldn't have reached its rate control limit at this "sampling"/"calling" time
+        /// 3. the metrics shouldn't have reached its rate control limit at this
+        /// "sampling"/"calling" time
         bool shouldPush(const std::string& id) const;
 
         /// Get generic information json object
         Json::Value& getGenericAttributes();
 
         /// Set generic information values
-        void setGenericAttributes(const std::string& attrName,
-                                  const Json::Value& value);
+        void setGenericAttributes(const std::string& attrName, const Json::Value& value);
 
         /// Set a unique id for the session. A uuid can be used.
         void setSession(const std::string& session) { _session = session; }
@@ -117,7 +115,6 @@ namespace ix
         bool isAuthenticated() const;
 
     private:
-
         /// Lookup an id in our metrics to see whether it is blacklisted
         /// Complexity is logarithmic
         bool isMetricBlacklisted(const std::string& id) const;
@@ -136,8 +133,8 @@ namespace ix
         CobraMetricsThreadedPublisher _cobra_metrics_theaded_publisher;
 
         /// A boolean to enable or disable this system
-        /// push becomes a no-op when _enabled is true
-        bool _enabled;
+        /// push becomes a no-op when _enabled is false
+        std::atomic<bool> _enabled;
 
         /// A uuid used to uniquely identify a session
         std::string _session;
@@ -150,15 +147,20 @@ namespace ix
         /// Metrics control (black list + rate control)
         std::vector<std::string> _blacklist;
         std::unordered_map<std::string, int> _rate_control;
-        std::unordered_map<std::string, std::chrono::time_point<std::chrono::steady_clock>> _last_update;
+        std::unordered_map<std::string, std::chrono::time_point<std::chrono::steady_clock>>
+            _last_update;
         mutable std::mutex _last_update_mutex; // protect access to _last_update
 
+        /// Bump a counter for each metric type
+        std::unordered_map<std::string, int> _counters;
+        mutable std::mutex _counters_mutex; // protect access to _counters
+
         // const strings for internal ids
         static const std::string kSetRateControlId;
         static const std::string kSetBlacklistId;
 
-        /// Our protocol version. Can be used by subscribers who would want to be backward compatible
-        /// if we change the way we arrange data
+        /// Our protocol version. Can be used by subscribers who would want to be backward
+        /// compatible if we change the way we arrange data
         static const int kVersion;
     };
 

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.cpp

@@ -6,6 +6,7 @@
 
 #include "IXCobraMetricsThreadedPublisher.h"
 #include <ixwebsocket/IXSetThreadName.h>
+#include <ixcore/utils/IXCoreLogger.h>
 
 #include <algorithm>
 #include <stdexcept>
@@ -24,7 +25,8 @@ namespace ix
             (ix::CobraConnectionEventType eventType,
              const std::string& errMsg,
              const ix::WebSocketHttpHeaders& headers,
-             const std::string& subscriptionId)
+             const std::string& subscriptionId,
+             CobraConnection::MsgId msgId)
             {
                 std::stringstream ss;
 
@@ -57,8 +59,12 @@ namespace ix
                 {
                     ss << "Unsubscribed through subscription id: " << subscriptionId;
                 }
+                else if (eventType == ix::CobraConnection_EventType_Published)
+                {
+                    ss << "Published message " << msgId << " acked";
+                }
 
-                std::cerr << ss.str() << std::endl;
+                ix::IXCoreLogger::Log(ss.str().c_str());
         });
     }
 
@@ -98,7 +104,7 @@ namespace ix
     void CobraMetricsThreadedPublisher::pushMessage(MessageKind messageKind,
                                                     const Json::Value& msg)
     {
-        // Now actually enqueue the task
+        // Enqueue the task
         {
             // acquire lock
             std::unique_lock<std::mutex> lock(_queue_mutex);

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.h

@@ -7,16 +7,14 @@
 #pragma once
 
 #include "IXCobraConnection.h"
-
-#include <jsoncpp/json/json.h>
-
-#include <string>
-#include <queue>
-#include <mutex>
-#include <thread>
-#include <map>
 #include <atomic>
 #include <condition_variable>
+#include <jsoncpp/json/json.h>
+#include <map>
+#include <mutex>
+#include <queue>
+#include <string>
+#include <thread>
 
 namespace ix
 {
@@ -27,7 +25,6 @@ namespace ix
         ~CobraMetricsThreadedPublisher();
 
         /// Configuration / set keys, etc...
-        /// All input data but the channel name is encrypted with rc4
         void configure(const std::string& appkey,
                        const std::string& endpoint,
                        const std::string& channel,
@@ -67,8 +64,7 @@ namespace ix
         };
 
         /// Push a message to be processed by the background thread
-        void pushMessage(MessageKind messageKind,
-                         const Json::Value& msg);
+        void pushMessage(MessageKind messageKind, const Json::Value& msg);
 
         /// Get a wait time which is increasing exponentially based on the number of retries
         uint64_t getWaitTimeExp(int retry_count);

ixcore/CMakeLists.txt

@@ -0,0 +1,19 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+#
+
+set (IXCORE_SOURCES
+    ixcore/utils/IXCoreLogger.cpp
+)
+
+set (IXCORE_HEADERS
+    ixcore/utils/IXCoreLogger.h
+)
+
+add_library(ixcore STATIC
+    ${IXCORE_SOURCES}
+    ${IXCORE_HEADERS}
+)
+
+target_include_directories( ixcore PUBLIC . )

ixcore/ixcore/utils/IXCoreLogger.cpp

@@ -0,0 +1,14 @@
+#include "ixcore/utils/IXCoreLogger.h"
+
+
+namespace ix
+{
+// Default do nothing logger
+IXCoreLogger::LogFunc IXCoreLogger::_currentLogger = [](const char* /*msg*/){};
+
+void IXCoreLogger::Log(const char* msg)
+{
+    _currentLogger(msg);
+}
+
+} // ix

ixcore/ixcore/utils/IXCoreLogger.h

@@ -0,0 +1,18 @@
+#pragma once
+#include <functional>
+
+namespace ix
+{
+    class IXCoreLogger
+    {
+    public:
+        using LogFunc = std::function<void(const char*)>;
+        static void Log(const char* msg);
+
+        static void setLogFunction(LogFunc& func) { _currentLogger = func; }
+
+    private:
+        static LogFunc _currentLogger;
+    };
+
+} // namespace ix

ixcrypto/CMakeLists.txt

@@ -0,0 +1,54 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+#
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../CMake;${CMAKE_MODULE_PATH}")
+
+set (IXCRYPTO_SOURCES
+    ixcrypto/IXHMac.cpp
+    ixcrypto/IXBase64.cpp
+    ixcrypto/IXUuid.cpp
+    ixcrypto/IXHash.cpp
+)
+
+set (IXCRYPTO_HEADERS
+    ixcrypto/IXHMac.h
+    ixcrypto/IXBase64.h
+    ixcrypto/IXUuid.h
+    ixcrypto/IXHash.h
+)
+
+add_library(ixcrypto STATIC
+    ${IXCRYPTO_SOURCES}
+    ${IXCRYPTO_HEADERS}
+)
+
+set(IXCRYPTO_INCLUDE_DIRS 
+    .
+    ../ixcore)
+
+target_include_directories( ixcrypto PUBLIC ${IXCRYPTO_INCLUDE_DIRS} )
+
+# hmac computation needs a crypto library
+
+if (WIN32)
+  set(USE_MBED_TLS TRUE)
+endif()
+
+target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_TLS)
+if (USE_MBED_TLS)
+    find_package(MbedTLS REQUIRED)
+    target_include_directories(ixcrypto PUBLIC ${MBEDTLS_INCLUDE_DIRS})
+    target_link_libraries(ixcrypto ${MBEDTLS_LIBRARIES})
+    target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_MBED_TLS)
+elseif (APPLE)
+elseif (WIN32)
+else()
+    find_package(OpenSSL REQUIRED)
+    add_definitions(${OPENSSL_DEFINITIONS})
+    message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
+    include_directories(${OPENSSL_INCLUDE_DIR})
+    target_link_libraries(ixcrypto ${OPENSSL_LIBRARIES})
+    target_compile_definitions(ixcrypto PUBLIC IXCRYPTO_USE_OPEN_SSL)
+endif()
+

ixcrypto/ixcrypto/IXBase64.h

@@ -12,4 +12,4 @@ namespace ix
 {
     std::string base64_encode(const std::string& data, size_t len);
     std::string base64_decode(const std::string& encoded_string);
-}
+} // namespace ix

ixcrypto/ixcrypto/IXHMac.cpp

@@ -3,13 +3,18 @@
  *  Author: Benjamin Sergeant
  *  Copyright (c) 2018 Machine Zone. All rights reserved.
  */
+
 #include "IXHMac.h"
 #include "IXBase64.h"
 
-#ifdef __APPLE__
+#if defined(IXCRYPTO_USE_MBED_TLS)
+# include <mbedtls/md.h>
+#elif defined(__APPLE__)
 # include <CommonCrypto/CommonHMAC.h>
-#else
+#elif defined(IXCRYPTO_USE_OPEN_SSL)
 # include <openssl/hmac.h>
+#else
+# error "Unsupported configuration"
 #endif
 
 namespace ix
@@ -19,16 +24,23 @@ namespace ix
         constexpr size_t hashSize = 16;
         unsigned char hash[hashSize];
 
-#ifdef __APPLE__
+#if defined(IXCRYPTO_USE_MBED_TLS)
+        mbedtls_md_hmac(mbedtls_md_info_from_type(MBEDTLS_MD_MD5),
+               (unsigned char *) key.c_str(), key.size(),
+               (unsigned char *) data.c_str(), data.size(),
+               (unsigned char *) &hash);
+#elif defined(__APPLE__)
         CCHmac(kCCHmacAlgMD5,
                key.c_str(), key.size(),
                data.c_str(), data.size(),
                &hash);
-#else
+#elif defined(IXCRYPTO_USE_OPEN_SSL)
         HMAC(EVP_md5(),
              key.c_str(), (int) key.size(),
              (unsigned char *) data.c_str(), (int) data.size(),
              (unsigned char *) hash, nullptr);
+#else
+#       error "Unsupported configuration"
 #endif
 
         std::string hashString(reinterpret_cast<char*>(hash), hashSize);

ixcrypto/ixcrypto/IXHash.h

@@ -13,4 +13,3 @@ namespace ix
 {
     uint64_t djb2Hash(const std::vector<uint8_t>& data);
 }
-

ixcrypto/ixcrypto/IXUuid.h

@@ -9,9 +9,9 @@
 
 namespace ix
 {
-   /**
-    * Generate a random uuid
-    */
-   std::string uuid4();
+    /**
+     * Generate a random uuid
+     */
+    std::string uuid4();
 
-}
+} // namespace ix

ixwebsocket/IXCancellationRequest.h

@@ -6,14 +6,13 @@
 
 #pragma once
 
-#include <functional>
 #include <atomic>
+#include <functional>
 
 namespace ix
 {
     using CancellationRequest = std::function<bool()>;
 
-    CancellationRequest makeCancellationRequestWithTimeout(int seconds,
-                                                           std::atomic<bool>& requestInitCancellation);
-}
-
+    CancellationRequest makeCancellationRequestWithTimeout(
+        int seconds, std::atomic<bool>& requestInitCancellation);
+} // namespace ix

ixwebsocket/IXConnectionState.h

@@ -6,14 +6,15 @@
 
 #pragma once
 
-#include <stdint.h>
-#include <string>
 #include <atomic>
 #include <memory>
+#include <stdint.h>
+#include <string>
 
 namespace ix
 {
-    class ConnectionState {
+    class ConnectionState
+    {
     public:
         ConnectionState();
         virtual ~ConnectionState() = default;
@@ -32,6 +33,4 @@ namespace ix
 
         static std::atomic<uint64_t> _globalId;
     };
-}
-
-
+} // namespace ix

ixwebsocket/IXDNSLookup.cpp

@@ -9,30 +9,20 @@
 
 #include <string.h>
 #include <chrono>
+#include <thread>
 
 namespace ix
 {
-    const int64_t DNSLookup::kDefaultWait = 10; // ms
-
-    std::atomic<uint64_t> DNSLookup::_nextId(0);
-    std::set<uint64_t> DNSLookup::_activeJobs;
-    std::mutex DNSLookup::_activeJobsMutex;
+    const int64_t DNSLookup::kDefaultWait = 1; // ms
 
     DNSLookup::DNSLookup(const std::string& hostname, int port, int64_t wait) :
+        _hostname(hostname),
         _port(port),
         _wait(wait),
         _res(nullptr),
-        _done(false),
-        _id(_nextId++)
+        _done(false)
     {
-        setHostname(hostname);
-    }
-
-    DNSLookup::~DNSLookup()
-    {
-        // Remove this job from the active jobs list
-        std::lock_guard<std::mutex> lock(_activeJobsMutex);
-        _activeJobs.erase(_id);
+        ;
     }
 
     struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname,
@@ -60,14 +50,14 @@ namespace ix
 
     struct addrinfo* DNSLookup::resolve(std::string& errMsg,
                                         const CancellationRequest& isCancellationRequested,
-                                        bool blocking)
+                                        bool cancellable)
     {
-        return blocking ? resolveBlocking(errMsg, isCancellationRequested)
-                        : resolveAsync(errMsg, isCancellationRequested);
+        return cancellable ? resolveCancellable(errMsg, isCancellationRequested)
+                           : resolveUnCancellable(errMsg, isCancellationRequested);
     }
 
-    struct addrinfo* DNSLookup::resolveBlocking(std::string& errMsg,
-                                                const CancellationRequest& isCancellationRequested)
+    struct addrinfo* DNSLookup::resolveUnCancellable(std::string& errMsg,
+                                                     const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
 
@@ -78,11 +68,11 @@ namespace ix
             return nullptr;
         }
 
-        return getAddrInfo(getHostname(), _port, errMsg);
+        return getAddrInfo(_hostname, _port, errMsg);
     }
 
-    struct addrinfo* DNSLookup::resolveAsync(std::string& errMsg,
-                                             const CancellationRequest& isCancellationRequested)
+    struct addrinfo* DNSLookup::resolveCancellable(std::string& errMsg,
+                                                   const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
 
@@ -94,30 +84,28 @@ namespace ix
                             // if you need a second lookup.
         }
 
-        // Record job in the active Job set
-        {
-            std::lock_guard<std::mutex> lock(_activeJobsMutex);
-            _activeJobs.insert(_id);
-        }
-
         //
         // Good resource on thread forced termination
         // https://www.bo-yang.net/2017/11/19/cpp-kill-detached-thread
         //
-        _thread = std::thread(&DNSLookup::run, this, _id, getHostname(), _port);
-        _thread.detach();
+        auto ptr = shared_from_this();
+        std::weak_ptr<DNSLookup> self(ptr);
 
-        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
+        int port = _port;
+        std::string hostname(_hostname);
+
+        // We make the background thread doing the work a shared pointer
+        // instead of a member variable, because it can keep running when
+        // this object goes out of scope, in case of cancellation
+        auto t = std::make_shared<std::thread>(&DNSLookup::run, this, self, hostname, port);
+        t->detach();
 
         while (!_done)
         {
-            // Wait for 10 milliseconds on the condition variable, to see
-            // if the bg thread has terminated.
-            if (_condition.wait_for(lock, std::chrono::milliseconds(_wait)) == std::cv_status::no_timeout)
-            {
-                // Background thread has terminated, so we can break of this loop
-                break;
-            }
+            // Wait for 1 milliseconds, to see if the bg thread has terminated.
+            // We do not use a condition variable to wait, as destroying this one
+            // if the bg thread is alive can cause undefined behavior.
+            std::this_thread::sleep_for(std::chrono::milliseconds(_wait));
 
             // Were we cancelled ?
             if (isCancellationRequested && isCancellationRequested())
@@ -138,7 +126,7 @@ namespace ix
         return getRes();
     }
 
-    void DNSLookup::run(uint64_t id, const std::string& hostname, int port) // thread runner
+    void DNSLookup::run(std::weak_ptr<DNSLookup> self, std::string hostname, int port) // thread runner
     {
         // We don't want to read or write into members variables of an object that could be
         // gone, so we use temporary variables (res) or we pass in by copy everything that
@@ -146,33 +134,14 @@ namespace ix
         std::string errMsg;
         struct addrinfo* res = getAddrInfo(hostname, port, errMsg);
 
-        // if this isn't an active job, and the control thread is gone
-        // there is nothing to do, and we don't want to touch the defunct
-        // object data structure such as _errMsg or _condition
-        std::lock_guard<std::mutex> lock(_activeJobsMutex);
-        if (_activeJobs.count(id) == 0)
+        if (self.lock())
         {
-            return;
+            // Copy result into the member variables
+            setRes(res);
+            setErrMsg(errMsg);
+
+            _done = true;
         }
-
-        // Copy result into the member variables
-        setRes(res);
-        setErrMsg(errMsg);
-
-        _condition.notify_one();
-        _done = true;
-    }
-
-    void DNSLookup::setHostname(const std::string& hostname)
-    {
-        std::lock_guard<std::mutex> lock(_hostnameMutex);
-        _hostname = hostname;
-    }
-
-    const std::string& DNSLookup::getHostname()
-    {
-        std::lock_guard<std::mutex> lock(_hostnameMutex);
-        return _hostname;
     }
 
     void DNSLookup::setErrMsg(const std::string& errMsg)

ixwebsocket/IXDNSLookup.h

@@ -11,42 +11,37 @@
 #pragma once
 
 #include "IXCancellationRequest.h"
-
-#include <string>
-#include <thread>
 #include <atomic>
-#include <condition_variable>
+#include <memory>
+#include <mutex>
 #include <set>
+#include <string>
 
 struct addrinfo;
 
 namespace ix
 {
-    class DNSLookup {
+    class DNSLookup : public std::enable_shared_from_this<DNSLookup>
+    {
     public:
-        DNSLookup(const std::string& hostname,
-                  int port,
-                  int64_t wait = DNSLookup::kDefaultWait);
-        ~DNSLookup();
+        DNSLookup(const std::string& hostname, int port, int64_t wait = DNSLookup::kDefaultWait);
+        ~DNSLookup() = default;
 
         struct addrinfo* resolve(std::string& errMsg,
                                  const CancellationRequest& isCancellationRequested,
-                                 bool blocking = false);
+                                 bool cancellable = true);
 
     private:
-        struct addrinfo* resolveAsync(std::string& errMsg,
-                                      const CancellationRequest& isCancellationRequested);
-        struct addrinfo* resolveBlocking(std::string& errMsg,
-                                         const CancellationRequest& isCancellationRequested);
+        struct addrinfo* resolveCancellable(std::string& errMsg,
+                                            const CancellationRequest& isCancellationRequested);
+        struct addrinfo* resolveUnCancellable(std::string& errMsg,
+                                              const CancellationRequest& isCancellationRequested);
 
         static struct addrinfo* getAddrInfo(const std::string& hostname,
                                             int port,
                                             std::string& errMsg);
 
-        void run(uint64_t id, const std::string& hostname, int port); // thread runner
-
-        void setHostname(const std::string& hostname);
-        const std::string& getHostname();
+        void run(std::weak_ptr<DNSLookup> self, std::string hostname, int port); // thread runner
 
         void setErrMsg(const std::string& errMsg);
         const std::string& getErrMsg();
@@ -55,10 +50,9 @@ namespace ix
         struct addrinfo* getRes();
 
         std::string _hostname;
-        std::mutex _hostnameMutex;
         int _port;
-
         int64_t _wait;
+        const static int64_t kDefaultWait;
 
         struct addrinfo* _res;
         std::mutex _resMutex;
@@ -67,15 +61,5 @@ namespace ix
         std::mutex _errMsgMutex;
 
         std::atomic<bool> _done;
-        std::thread _thread;
-        std::condition_variable _condition;
-        std::mutex _conditionVariableMutex;
-
-        uint64_t _id;
-        static std::atomic<uint64_t> _nextId;
-        static std::set<uint64_t> _activeJobs;
-        static std::mutex _activeJobsMutex;
-
-        const static int64_t kDefaultWait;
     };
-}
+} // namespace ix

ixwebsocket/IXExponentialBackoff.cpp

@@ -0,0 +1,26 @@
+/*
+ *  IXExponentialBackoff.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXExponentialBackoff.h"
+
+#include <cmath>
+
+namespace ix
+{
+    uint32_t calculateRetryWaitMilliseconds(
+        uint32_t retry_count,
+        uint32_t maxWaitBetweenReconnectionRetries)
+    {
+        uint32_t wait_time = std::pow(2, retry_count) * 100;
+
+        if (wait_time > maxWaitBetweenReconnectionRetries || wait_time == 0)
+        {
+            wait_time = maxWaitBetweenReconnectionRetries;
+        }
+
+        return wait_time;
+    }
+}

ixwebsocket/IXExponentialBackoff.h

@@ -0,0 +1,16 @@
+/*
+ *  IXExponentialBackoff.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <cstdint>
+
+namespace ix
+{
+    uint32_t calculateRetryWaitMilliseconds(
+        uint32_t retry_count,
+        uint32_t maxWaitBetweenReconnectionRetries);
+} // namespace ix

ixwebsocket/IXHttp.cpp

@@ -0,0 +1,168 @@
+/*
+ *  IXHttp.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXHttp.h"
+#include "IXCancellationRequest.h"
+#include "IXSocket.h"
+
+#include <sstream>
+#include <vector>
+
+namespace ix
+{
+    std::string Http::trim(const std::string& str)
+    {
+        std::string out;
+        for (auto c : str)
+        {
+            if (c != ' ' && c != '\n' && c != '\r')
+            {
+                out += c;
+            }
+        }
+
+        return out;
+    }
+
+    std::pair<std::string, int> Http::parseStatusLine(const std::string& line)
+    {
+        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
+        std::string token;
+        std::stringstream tokenStream(line);
+        std::vector<std::string> tokens;
+
+        // Split by ' '
+        while (std::getline(tokenStream, token, ' '))
+        {
+            tokens.push_back(token);
+        }
+
+        std::string httpVersion;
+        if (tokens.size() >= 1)
+        {
+            httpVersion = trim(tokens[0]);
+        }
+
+        int statusCode = -1;
+        if (tokens.size() >= 2)
+        {
+            std::stringstream ss;
+            ss << trim(tokens[1]);
+            ss >> statusCode;
+        }
+
+        return std::make_pair(httpVersion, statusCode);
+    }
+
+    std::tuple<std::string, std::string, std::string> Http::parseRequestLine(const std::string& line)
+    {
+        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
+        std::string token;
+        std::stringstream tokenStream(line);
+        std::vector<std::string> tokens;
+
+        // Split by ' '
+        while (std::getline(tokenStream, token, ' '))
+        {
+            tokens.push_back(token);
+        }
+
+        std::string method;
+        if (tokens.size() >= 1)
+        {
+            method = trim(tokens[0]);
+        }
+
+        std::string requestUri;
+        if (tokens.size() >= 2)
+        {
+            requestUri = trim(tokens[1]);
+        }
+
+        std::string httpVersion;
+        if (tokens.size() >= 3)
+        {
+            httpVersion = trim(tokens[2]);
+        }
+
+        return std::make_tuple(method, requestUri, httpVersion);
+    }
+
+    std::tuple<bool, std::string, HttpRequestPtr> Http::parseRequest(std::shared_ptr<Socket> socket)
+    {
+        HttpRequestPtr httpRequest;
+
+        std::atomic<bool> requestInitCancellation(false);
+
+        int timeoutSecs = 5; // FIXME
+
+        auto isCancellationRequested =
+            makeCancellationRequestWithTimeout(timeoutSecs, requestInitCancellation);
+
+        // Read first line
+        auto lineResult = socket->readLine(isCancellationRequested);
+        auto lineValid = lineResult.first;
+        auto line = lineResult.second;
+
+        if (!lineValid)
+        {
+            return std::make_tuple(false, "Error reading HTTP request line", httpRequest);
+        }
+
+        // Parse request line (GET /foo HTTP/1.1\r\n)
+        auto requestLine = Http::parseRequestLine(line);
+        auto method      = std::get<0>(requestLine);
+        auto uri         = std::get<1>(requestLine);
+        auto httpVersion = std::get<2>(requestLine);
+
+        // Retrieve and validate HTTP headers
+        auto result = parseHttpHeaders(socket, isCancellationRequested);
+        auto headersValid = result.first;
+        auto headers = result.second;
+
+        if (!headersValid)
+        {
+            return std::make_tuple(false, "Error parsing HTTP headers", httpRequest);
+        }
+
+        httpRequest = std::make_shared<HttpRequest>(uri, method, httpVersion, headers);
+        return std::make_tuple(true, "", httpRequest);
+    }
+
+    bool Http::sendResponse(HttpResponsePtr response, std::shared_ptr<Socket> socket)
+    {
+        // Write the response to the socket
+        std::stringstream ss;
+        ss << "HTTP/1.1 ";
+        ss << response->statusCode;
+        ss << " ";
+        ss << response->description;
+        ss << "\r\n";
+
+        if (!socket->writeBytes(ss.str(), nullptr))
+        {
+            return false;
+        }
+
+        // Write headers
+        ss.str("");
+        ss << "Content-Length: " << response->payload.size() << "\r\n";
+        for (auto&& it : response->headers)
+        {
+            ss << it.first << ": " << it.second << "\r\n";
+        }
+        ss << "\r\n";
+
+        if (!socket->writeBytes(ss.str(), nullptr))
+        {
+            return false;
+        }
+
+        return response->payload.empty()
+            ? true
+            : socket->writeBytes(response->payload, nullptr);
+    }
+}

ixwebsocket/IXHttp.h

@@ -0,0 +1,124 @@
+/*
+ *  IXHttp.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXProgressCallback.h"
+#include "IXWebSocketHttpHeaders.h"
+#include <tuple>
+
+namespace ix
+{
+    enum class HttpErrorCode : int
+    {
+        Ok = 0,
+        CannotConnect = 1,
+        Timeout = 2,
+        Gzip = 3,
+        UrlMalformed = 4,
+        CannotCreateSocket = 5,
+        SendError = 6,
+        ReadError = 7,
+        CannotReadStatusLine = 8,
+        MissingStatus = 9,
+        HeaderParsingError = 10,
+        MissingLocation = 11,
+        TooManyRedirects = 12,
+        ChunkReadError = 13,
+        CannotReadBody = 14,
+        Invalid = 100
+    };
+
+    struct HttpResponse
+    {
+        int statusCode;
+        std::string description;
+        HttpErrorCode errorCode;
+        WebSocketHttpHeaders headers;
+        std::string payload;
+        std::string errorMsg;
+        uint64_t uploadSize;
+        uint64_t downloadSize;
+
+        HttpResponse(int s = 0,
+                     const std::string& des = std::string(),
+                     const HttpErrorCode& c = HttpErrorCode::Ok,
+                     const WebSocketHttpHeaders& h = WebSocketHttpHeaders(),
+                     const std::string& p = std::string(),
+                     const std::string& e = std::string(),
+                     uint64_t u = 0,
+                     uint64_t d = 0)
+            : statusCode(s)
+            , description(des)
+            , errorCode(c)
+            , headers(h)
+            , payload(p)
+            , errorMsg(e)
+            , uploadSize(u)
+            , downloadSize(d)
+        {
+            ;
+        }
+    };
+
+    using HttpResponsePtr = std::shared_ptr<HttpResponse>;
+    using HttpParameters = std::map<std::string, std::string>;
+    using Logger = std::function<void(const std::string&)>;
+    using OnResponseCallback = std::function<void(const HttpResponsePtr&)>;
+
+    struct HttpRequestArgs
+    {
+        std::string url;
+        std::string verb;
+        WebSocketHttpHeaders extraHeaders;
+        std::string body;
+        int connectTimeout;
+        int transferTimeout;
+        bool followRedirects;
+        int maxRedirects;
+        bool verbose;
+        bool compress;
+        Logger logger;
+        OnProgressCallback onProgressCallback;
+    };
+
+    using HttpRequestArgsPtr = std::shared_ptr<HttpRequestArgs>;
+
+    struct HttpRequest
+    {
+        std::string uri;
+        std::string method;
+        std::string version;
+        WebSocketHttpHeaders headers;
+
+        HttpRequest(const std::string& u,
+                    const std::string& m,
+                    const std::string& v,
+                    const WebSocketHttpHeaders& h = WebSocketHttpHeaders())
+            : uri(u)
+            , method(m)
+            , version(v)
+            , headers(h)
+        {
+        }
+    };
+
+    using HttpRequestPtr = std::shared_ptr<HttpRequest>;
+
+    class Http
+    {
+    public:
+        static std::tuple<bool, std::string, HttpRequestPtr> parseRequest(
+            std::shared_ptr<Socket> socket);
+        static bool sendResponse(HttpResponsePtr response, std::shared_ptr<Socket> socket);
+
+        static std::pair<std::string, int> parseStatusLine(
+            const std::string& line);
+        static std::tuple<std::string, std::string, std::string> parseRequestLine(
+            const std::string& line);
+        static std::string trim(const std::string& str);
+    };
+} // namespace ix

ixwebsocket/IXHttpClient.cpp

@@ -6,6 +6,7 @@
 
 #include "IXHttpClient.h"
 #include "IXUrlParser.h"
+#include "IXUserAgent.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXSocketFactory.h"
 
@@ -14,6 +15,7 @@
 #include <vector>
 #include <cstring>
 
+#include <assert.h>
 #include <zlib.h>
 
 namespace ix
@@ -21,29 +23,106 @@ namespace ix
     const std::string HttpClient::kPost = "POST";
     const std::string HttpClient::kGet = "GET";
     const std::string HttpClient::kHead = "HEAD";
+    const std::string HttpClient::kDel = "DEL";
+    const std::string HttpClient::kPut = "PUT";
 
-    HttpClient::HttpClient()
+    HttpClient::HttpClient(bool async) : _async(async), _stop(false)
     {
+        if (!_async) return;
 
+        _thread = std::thread(&HttpClient::run, this);
     }
 
     HttpClient::~HttpClient()
     {
+        if (!_thread.joinable()) return;
 
+        _stop = true;
+        _condition.notify_one();
+        _thread.join();
     }
 
-    HttpResponse HttpClient::request(
+    HttpRequestArgsPtr HttpClient::createRequest(const std::string& url,
+                                                 const std::string& verb)
+    {
+        auto request = std::make_shared<HttpRequestArgs>();
+        request->url = url;
+        request->verb = verb;
+        return request;
+    }
+
+    bool HttpClient::performRequest(HttpRequestArgsPtr args,
+                                    const OnResponseCallback& onResponseCallback)
+    {
+        assert(_async && "HttpClient needs its async parameter set to true "
+                         "in order to call performRequest");
+        if (!_async) return false;
+
+        // Enqueue the task
+        {
+            // acquire lock
+            std::unique_lock<std::mutex> lock(_queueMutex);
+
+            // add the task
+            _queue.push(std::make_pair(args, onResponseCallback));
+        } // release lock
+
+        // wake up one thread
+        _condition.notify_one();
+
+        return true;
+    }
+
+    void HttpClient::run()
+    {
+        while (true)
+        {
+            HttpRequestArgsPtr args;
+            OnResponseCallback onResponseCallback;
+
+            {
+                std::unique_lock<std::mutex> lock(_queueMutex);
+
+                while (!_stop && _queue.empty())
+                {
+                    _condition.wait(lock);
+                }
+
+                if (_stop) return;
+
+                auto p = _queue.front();
+                _queue.pop();
+
+                args = p.first;
+                onResponseCallback = p.second;
+            }
+
+            if (_stop) return;
+
+            HttpResponsePtr response = request(args->url, args->verb, args->body, args);
+            onResponseCallback(response);
+
+            if (_stop) return;
+        }
+    }
+
+    HttpResponsePtr HttpClient::request(
         const std::string& url,
         const std::string& verb,
         const std::string& body,
-        const HttpRequestArgs& args,
+        HttpRequestArgsPtr args,
         int redirects)
     {
+        // We only have one socket connection, so we cannot
+        // make multiple requests concurrently.
+        std::lock_guard<std::mutex> lock(_mutex);
+
         uint64_t uploadSize = 0;
         uint64_t downloadSize = 0;
         int code = 0;
         WebSocketHttpHeaders headers;
         std::string payload;
+        std::string description;
 
         std::string protocol, host, path, query;
         int port;
@@ -52,9 +131,9 @@ namespace ix
         {
             std::stringstream ss;
             ss << "Cannot parse url: " << url;
-            return std::make_tuple(code, HttpErrorCode_UrlMalformed,
-                                   headers, payload, ss.str(),
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::UrlMalformed,
+                                                  headers, payload, ss.str(),
+                                                  uploadSize, downloadSize);
         }
 
         bool tls = protocol == "https";
@@ -63,35 +142,45 @@ namespace ix
 
         if (!_socket)
         {
-            return std::make_tuple(code, HttpErrorCode_CannotCreateSocket,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotCreateSocket,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         // Build request string
         std::stringstream ss;
         ss << verb << " " << path << " HTTP/1.1\r\n";
         ss << "Host: " << host << "\r\n";
-        ss << "User-Agent: ixwebsocket/1.0.0" << "\r\n";
-        ss << "Accept: */*" << "\r\n";
 
-        if (args.compress)
+        if (args->compress)
         {
             ss << "Accept-Encoding: gzip" << "\r\n";
         }
 
         // Append extra headers
-        for (auto&& it : args.extraHeaders)
+        for (auto&& it : args->extraHeaders)
         {
             ss << it.first << ": " << it.second << "\r\n";
         }
 
-        if (verb == kPost)
+        // Set a default Accept header if none is present
+        if (headers.find("Accept") == headers.end())
+        {
+            ss << "Accept: */*" << "\r\n";
+        }
+
+        // Set a default User agent if none is present
+        if (headers.find("User-Agent") == headers.end())
+        {
+            ss << "User-Agent: " << userAgent() << "\r\n";
+        }
+
+        if (verb == kPost || verb == kPut)
         {
             ss << "Content-Length: " << body.size() << "\r\n";
 
             // Set default Content-Type if unspecified
-            if (args.extraHeaders.find("Content-Type") == args.extraHeaders.end())
+            if (args->extraHeaders.find("Content-Type") == args->extraHeaders.end())
             {
                 ss << "Content-Type: application/x-www-form-urlencoded" << "\r\n";
             }
@@ -109,23 +198,23 @@ namespace ix
 
         // Make a cancellation object dealing with connection timeout
         auto isCancellationRequested =
-            makeCancellationRequestWithTimeout(args.connectTimeout, requestInitCancellation);
+            makeCancellationRequestWithTimeout(args->connectTimeout, requestInitCancellation);
 
         bool success = _socket->connect(host, port, errMsg, isCancellationRequested);
         if (!success)
         {
             std::stringstream ss;
-            ss << "Cannot connect to url: " << url;
-            return std::make_tuple(code, HttpErrorCode_CannotConnect,
-                                   headers, payload, ss.str(),
-                                   uploadSize, downloadSize);
+            ss << "Cannot connect to url: " << url << " / error : " << errMsg;
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotConnect,
+                                                  headers, payload, ss.str(),
+                                                  uploadSize, downloadSize);
         }
 
         // Make a new cancellation object dealing with transfer timeout
         isCancellationRequested =
-            makeCancellationRequestWithTimeout(args.transferTimeout, requestInitCancellation);
+            makeCancellationRequestWithTimeout(args->transferTimeout, requestInitCancellation);
 
-        if (args.verbose)
+        if (args->verbose)
         {
             std::stringstream ss;
             ss << "Sending " << verb << " request "
@@ -142,9 +231,9 @@ namespace ix
         if (!_socket->writeBytes(req, isCancellationRequested))
         {
             std::string errorMsg("Cannot send request");
-            return std::make_tuple(code, HttpErrorCode_SendError,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::SendError,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         uploadSize = req.size();
@@ -156,12 +245,12 @@ namespace ix
         if (!lineValid)
         {
             std::string errorMsg("Cannot retrieve status line");
-            return std::make_tuple(code, HttpErrorCode_CannotReadStatusLine,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotReadStatusLine,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
-        if (args.verbose)
+        if (args->verbose)
         {
             std::stringstream ss;
             ss << "Status line " << line;
@@ -171,9 +260,9 @@ namespace ix
         if (sscanf(line.c_str(), "HTTP/1.1 %d", &code) != 1)
         {
             std::string errorMsg("Cannot parse response code from status line");
-            return std::make_tuple(code, HttpErrorCode_MissingStatus,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::MissingStatus,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         auto result = parseHttpHeaders(_socket, isCancellationRequested);
@@ -183,29 +272,29 @@ namespace ix
         if (!headersValid)
         {
             std::string errorMsg("Cannot parse http headers");
-            return std::make_tuple(code, HttpErrorCode_HeaderParsingError,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::HeaderParsingError,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         // Redirect ?
-        if ((code >= 301 && code <= 308) && args.followRedirects)
+        if ((code >= 301 && code <= 308) && args->followRedirects)
         {
             if (headers.find("Location") == headers.end())
             {
                 std::string errorMsg("Missing location header for redirect");
-                return std::make_tuple(code, HttpErrorCode_MissingLocation,
-                                       headers, payload, errorMsg,
-                                       uploadSize, downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::MissingLocation,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
 
-            if (redirects >= args.maxRedirects)
+            if (redirects >= args->maxRedirects)
             {
                 std::stringstream ss;
                 ss << "Too many redirects: " << redirects;
-                return std::make_tuple(code, HttpErrorCode_TooManyRedirects,
-                                       headers, payload, ss.str(),
-                                       uploadSize, downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::TooManyRedirects,
+                                                      headers, payload, ss.str(),
+                                                      uploadSize, downloadSize);
             }
 
             // Recurse
@@ -215,9 +304,9 @@ namespace ix
 
         if (verb == "HEAD")
         {
-            return std::make_tuple(code, HttpErrorCode_Ok,
-                                   headers, payload, std::string(),
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Ok,
+                                                  headers, payload, std::string(),
+                                                  uploadSize, downloadSize);
         }
 
         // Parse response:
@@ -231,14 +320,14 @@ namespace ix
             payload.reserve(contentLength);
 
             auto chunkResult = _socket->readBytes(contentLength,
-                                                  args.onProgressCallback,
+                                                  args->onProgressCallback,
                                                   isCancellationRequested);
             if (!chunkResult.first)
             {
                 errorMsg = "Cannot read chunk";
-                return std::make_tuple(code, HttpErrorCode_ChunkReadError,
-                                       headers, payload, errorMsg,
-                                       uploadSize, downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
             payload += chunkResult.second;
         }
@@ -254,9 +343,9 @@ namespace ix
 
                 if (!lineResult.first)
                 {
-                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
-                                           headers, payload, errorMsg,
-                                           uploadSize, downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
 
                 uint64_t chunkSize;
@@ -264,7 +353,7 @@ namespace ix
                 ss << std::hex << line;
                 ss >> chunkSize;
 
-                if (args.verbose)
+                if (args->verbose)
                 {
                     std::stringstream oss;
                     oss << "Reading " << chunkSize << " bytes"
@@ -272,18 +361,18 @@ namespace ix
                     log(oss.str(), args);
                 }
 
-                payload.reserve(payload.size() + chunkSize);
+                payload.reserve(payload.size() + (size_t) chunkSize);
 
                 // Read a chunk
-                auto chunkResult = _socket->readBytes(chunkSize,
-                                                      args.onProgressCallback,
+                auto chunkResult = _socket->readBytes((size_t) chunkSize,
+                                                      args->onProgressCallback,
                                                       isCancellationRequested);
                 if (!chunkResult.first)
                 {
                     errorMsg = "Cannot read chunk";
-                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
-                                           headers, payload, errorMsg,
-                                           uploadSize, downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
                 payload += chunkResult.second;
 
@@ -292,9 +381,9 @@ namespace ix
 
                 if (!lineResult.first)
                 {
-                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
-                                           headers, payload, errorMsg,
-                                           uploadSize, downloadSize);
+                    return std::make_shared<HttpResponse>(code, description, HttpErrorCode::ChunkReadError,
+                                                          headers, payload, errorMsg,
+                                                          uploadSize, downloadSize);
                 }
 
                 if (chunkSize == 0) break;
@@ -307,9 +396,9 @@ namespace ix
         else
         {
             std::string errorMsg("Cannot read http body");
-            return std::make_tuple(code, HttpErrorCode_CannotReadBody,
-                                   headers, payload, errorMsg,
-                                   uploadSize, downloadSize);
+            return std::make_shared<HttpResponse>(code, description, HttpErrorCode::CannotReadBody,
+                                                  headers, payload, errorMsg,
+                                                  uploadSize, downloadSize);
         }
 
         downloadSize = payload.size();
@@ -321,44 +410,64 @@ namespace ix
             if (!gzipInflate(payload, decompressedPayload))
             {
                 std::string errorMsg("Error decompressing payload");
-                return std::make_tuple(code, HttpErrorCode_Gzip,
-                                       headers, payload, errorMsg,
-                                       uploadSize, downloadSize);
+                return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Gzip,
+                                                      headers, payload, errorMsg,
+                                                      uploadSize, downloadSize);
             }
             payload = decompressedPayload;
         }
 
-        return std::make_tuple(code, HttpErrorCode_Ok,
-                               headers, payload, std::string(),
-                               uploadSize, downloadSize);
+        return std::make_shared<HttpResponse>(code, description, HttpErrorCode::Ok,
+                                              headers, payload, std::string(),
+                                              uploadSize, downloadSize);
     }
 
-    HttpResponse HttpClient::get(const std::string& url,
-                                 const HttpRequestArgs& args)
+    HttpResponsePtr HttpClient::get(const std::string& url,
+                                    HttpRequestArgsPtr args)
     {
         return request(url, kGet, std::string(), args);
     }
 
-    HttpResponse HttpClient::head(const std::string& url,
-                                  const HttpRequestArgs& args)
+    HttpResponsePtr HttpClient::head(const std::string& url,
+                                     HttpRequestArgsPtr args)
     {
         return request(url, kHead, std::string(), args);
     }
 
-    HttpResponse HttpClient::post(const std::string& url,
-                                  const HttpParameters& httpParameters,
-                                  const HttpRequestArgs& args)
+    HttpResponsePtr HttpClient::del(const std::string& url,
+                                    HttpRequestArgsPtr args)
+    {
+        return request(url, kDel, std::string(), args);
+    }
+
+    HttpResponsePtr HttpClient::post(const std::string& url,
+                                     const HttpParameters& httpParameters,
+                                     HttpRequestArgsPtr args)
     {
         return request(url, kPost, serializeHttpParameters(httpParameters), args);
     }
 
-    HttpResponse HttpClient::post(const std::string& url,
-                                  const std::string& body,
-                                  const HttpRequestArgs& args)
+    HttpResponsePtr HttpClient::post(const std::string& url,
+                                     const std::string& body,
+                                     HttpRequestArgsPtr args)
     {
         return request(url, kPost, body, args);
     }
 
+    HttpResponsePtr HttpClient::put(const std::string& url,
+                                    const HttpParameters& httpParameters,
+                                    HttpRequestArgsPtr args)
+    {
+        return request(url, kPut, serializeHttpParameters(httpParameters), args);
+    }
+
+    HttpResponsePtr HttpClient::put(const std::string& url,
+                                    const std::string& body,
+                                    const HttpRequestArgsPtr args)
+    {
+        return request(url, kPut, body, args);
+    }
+
     std::string HttpClient::urlEncode(const std::string& value)
     {
         std::ostringstream escaped;
@@ -456,11 +565,11 @@ namespace ix
     }
 
     void HttpClient::log(const std::string& msg,
-                         const HttpRequestArgs& args)
+                         HttpRequestArgsPtr args)
     {
-        if (args.logger)
+        if (args->logger)
         {
-            args.logger(msg);
+            args->logger(msg);
         }
     }
 }

ixwebsocket/IXHttpClient.h

@@ -6,102 +6,85 @@
 
 #pragma once
 
-#include <algorithm>
-#include <functional>
-#include <mutex>
-#include <atomic>
-#include <tuple>
-#include <memory>
-#include <map>
-
+#include "IXHttp.h"
 #include "IXSocket.h"
 #include "IXWebSocketHttpHeaders.h"
+#include <algorithm>
+#include <atomic>
+#include <condition_variable>
+#include <functional>
+#include <map>
+#include <memory>
+#include <mutex>
+#include <queue>
+#include <thread>
 
 namespace ix
 {
-    enum HttpErrorCode
+    class HttpClient
     {
-        HttpErrorCode_Ok = 0,
-        HttpErrorCode_CannotConnect = 1,
-        HttpErrorCode_Timeout = 2,
-        HttpErrorCode_Gzip = 3,
-        HttpErrorCode_UrlMalformed = 4,
-        HttpErrorCode_CannotCreateSocket = 5,
-        HttpErrorCode_SendError = 6,
-        HttpErrorCode_ReadError = 7,
-        HttpErrorCode_CannotReadStatusLine = 8,
-        HttpErrorCode_MissingStatus = 9,
-        HttpErrorCode_HeaderParsingError = 10,
-        HttpErrorCode_MissingLocation = 11,
-        HttpErrorCode_TooManyRedirects = 12,
-        HttpErrorCode_ChunkReadError = 13,
-        HttpErrorCode_CannotReadBody = 14
-    };
-
-    using HttpResponse = std::tuple<int, // status
-                                    HttpErrorCode, // error code
-                                    WebSocketHttpHeaders,
-                                    std::string, // payload
-                                    std::string, // error msg
-                                    uint64_t,    // upload size
-                                    uint64_t>;   // download size
-
-    using HttpParameters = std::map<std::string, std::string>;
-    using Logger = std::function<void(const std::string&)>;
-
-    struct HttpRequestArgs
-    {
-        std::string url;
-        WebSocketHttpHeaders extraHeaders;
-        std::string body;
-        int connectTimeout;
-        int transferTimeout;
-        bool followRedirects;
-        int maxRedirects;
-        bool verbose;
-        bool compress;
-        Logger logger;
-        OnProgressCallback onProgressCallback;
-    };
-
-    class HttpClient {
     public:
-        HttpClient();
+        HttpClient(bool async = false);
         ~HttpClient();
 
-        HttpResponse get(const std::string& url,
-                         const HttpRequestArgs& args);
-        HttpResponse head(const std::string& url,
-                          const HttpRequestArgs& args);
+        HttpResponsePtr get(const std::string& url, HttpRequestArgsPtr args);
+        HttpResponsePtr head(const std::string& url, HttpRequestArgsPtr args);
+        HttpResponsePtr del(const std::string& url, HttpRequestArgsPtr args);
 
-        HttpResponse post(const std::string& url,
-                          const HttpParameters& httpParameters,
-                          const HttpRequestArgs& args);
-        HttpResponse post(const std::string& url,
-                          const std::string& body,
-                          const HttpRequestArgs& args);
-
-    private:
-        HttpResponse request(const std::string& url,
-                             const std::string& verb,
+        HttpResponsePtr post(const std::string& url,
+                             const HttpParameters& httpParameters,
+                             HttpRequestArgsPtr args);
+        HttpResponsePtr post(const std::string& url,
                              const std::string& body,
-                             const HttpRequestArgs& args,
-                             int redirects = 0);
+                             HttpRequestArgsPtr args);
+
+        HttpResponsePtr put(const std::string& url,
+                            const HttpParameters& httpParameters,
+                            HttpRequestArgsPtr args);
+        HttpResponsePtr put(const std::string& url,
+                            const std::string& body,
+                            HttpRequestArgsPtr args);
+
+        HttpResponsePtr request(const std::string& url,
+                                const std::string& verb,
+                                const std::string& body,
+                                HttpRequestArgsPtr args,
+                                int redirects = 0);
+
+        // Async API
+        HttpRequestArgsPtr createRequest(const std::string& url = std::string(),
+                                         const std::string& verb = HttpClient::kGet);
+
+        bool performRequest(HttpRequestArgsPtr request,
+                            const OnResponseCallback& onResponseCallback);
 
         std::string serializeHttpParameters(const HttpParameters& httpParameters);
 
         std::string urlEncode(const std::string& value);
 
-        void log(const std::string& msg, const HttpRequestArgs& args);
-
-        bool gzipInflate(
-            const std::string& in,
-            std::string& out);
-
-        std::shared_ptr<Socket> _socket;
-
         const static std::string kPost;
         const static std::string kGet;
         const static std::string kHead;
+        const static std::string kDel;
+        const static std::string kPut;
+
+    private:
+        void log(const std::string& msg, HttpRequestArgsPtr args);
+
+        bool gzipInflate(const std::string& in, std::string& out);
+
+        // Async API background thread runner
+        void run();
+
+        // Async API
+        bool _async;
+        std::queue<std::pair<HttpRequestArgsPtr, OnResponseCallback>> _queue;
+        mutable std::mutex _queueMutex;
+        std::condition_variable _condition;
+        std::atomic<bool> _stop;
+        std::thread _thread;
+
+        std::shared_ptr<Socket> _socket;
+        std::mutex _mutex; // to protect accessing the _socket (only one socket per client)
     };
-}
+} // namespace ix

ixwebsocket/IXHttpServer.cpp

@@ -0,0 +1,161 @@
+/*
+ *  IXHttpServer.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXHttpServer.h"
+#include "IXSocketConnect.h"
+#include "IXSocketFactory.h"
+#include "IXNetSystem.h"
+
+#include <iostream>
+#include <sstream>
+#include <fstream>
+#include <vector>
+
+namespace
+{
+    std::pair<bool, std::vector<uint8_t>> load(const std::string& path)
+    {
+        std::vector<uint8_t> memblock;
+
+        std::ifstream file(path);
+        if (!file.is_open()) return std::make_pair(false, memblock);
+
+        file.seekg(0, file.end);
+        std::streamoff size = file.tellg();
+        file.seekg(0, file.beg);
+
+        memblock.resize((size_t) size);
+        file.read((char*)&memblock.front(), static_cast<std::streamsize>(size));
+
+        return std::make_pair(true, memblock);
+    }
+
+    std::pair<bool, std::string> readAsString(const std::string& path)
+    {
+        auto res = load(path);
+        auto vec = res.second;
+        return std::make_pair(res.first, std::string(vec.begin(), vec.end()));
+    }
+}
+
+namespace ix
+{
+    HttpServer::HttpServer(int port,
+                           const std::string& host,
+                           int backlog,
+                           size_t maxConnections) : SocketServer(port, host, backlog, maxConnections),
+        _connectedClientsCount(0)
+    {
+        setDefaultConnectionCallback();
+    }
+
+    HttpServer::~HttpServer()
+    {
+        stop();
+    }
+
+    void HttpServer::stop()
+    {
+        stopAcceptingConnections();
+
+        // FIXME: cancelling / closing active clients ...
+
+        SocketServer::stop();
+    }
+
+    void HttpServer::setOnConnectionCallback(const OnConnectionCallback& callback)
+    {
+        _onConnectionCallback = callback;
+    }
+
+    void HttpServer::handleConnection(
+        int fd,
+        std::shared_ptr<ConnectionState> connectionState)
+    {
+        _connectedClientsCount++;
+
+        std::string errorMsg;
+        auto socket = createSocket(fd, errorMsg);
+
+        // Set the socket to non blocking mode + other tweaks
+        SocketConnect::configure(fd);
+
+        auto ret = Http::parseRequest(socket);
+        // FIXME: handle errors in parseRequest
+
+        if (std::get<0>(ret))
+        {
+            auto response = _onConnectionCallback(std::get<2>(ret), connectionState);
+            if (!Http::sendResponse(response, socket))
+            {
+                logError("Cannot send response");
+            }
+        }
+        connectionState->setTerminated();
+        Socket::closeSocket(fd);
+
+        _connectedClientsCount--;
+    }
+
+    size_t HttpServer::getConnectedClientsCount()
+    {
+        return _connectedClientsCount;
+    }
+
+    void HttpServer::setDefaultConnectionCallback()
+    {
+        setOnConnectionCallback(
+            [this](HttpRequestPtr request,
+                   std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
+            {
+                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)
+                {
+                    return std::make_shared<HttpResponse>(404, "Not Found",
+                                                          HttpErrorCode::Ok,
+                                                          WebSocketHttpHeaders(),
+                                                          std::string());
+                }
+
+                std::string content = res.second;
+
+                // Log request
+                std::stringstream ss;
+                ss << request->method
+                   << " "
+                   << request->headers["User-Agent"]
+                   << " "
+                   << request->uri
+                   << " "
+                   << content.size();
+                logInfo(ss.str());
+
+                WebSocketHttpHeaders headers;
+                // FIXME: check extensions to set the content type
+                // headers["Content-Type"] = "application/octet-stream";
+                headers["Accept-Ranges"] = "none";
+
+                for (auto&& it : request->headers)
+                {
+                    headers[it.first] = it.second;
+                }
+
+                return std::make_shared<HttpResponse>(200, "OK",
+                                                      HttpErrorCode::Ok,
+                                                      headers,
+                                                      content);
+            }
+        );
+    }
+}

ixwebsocket/IXHttpServer.h

@@ -0,0 +1,49 @@
+/*
+ *  IXHttpServer.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXHttp.h"
+#include "IXSocketServer.h"
+#include "IXWebSocket.h"
+#include <functional>
+#include <memory>
+#include <mutex>
+#include <set>
+#include <string>
+#include <thread>
+#include <utility> // pair
+
+namespace ix
+{
+    class HttpServer final : public SocketServer
+    {
+    public:
+        using OnConnectionCallback =
+            std::function<HttpResponsePtr(HttpRequestPtr, std::shared_ptr<ConnectionState>)>;
+
+        HttpServer(int port = SocketServer::kDefaultPort,
+                   const std::string& host = SocketServer::kDefaultHost,
+                   int backlog = SocketServer::kDefaultTcpBacklog,
+                   size_t maxConnections = SocketServer::kDefaultMaxConnections);
+        virtual ~HttpServer();
+        virtual void stop() final;
+
+        void setOnConnectionCallback(const OnConnectionCallback& callback);
+
+    private:
+        // Member variables
+        OnConnectionCallback _onConnectionCallback;
+        std::atomic<int> _connectedClientsCount;
+
+        // Methods
+        virtual void handleConnection(int fd,
+                                      std::shared_ptr<ConnectionState> connectionState) final;
+        virtual size_t getConnectedClientsCount() final;
+
+        void setDefaultConnectionCallback();
+    };
+} // namespace ix

ixwebsocket/IXNetSystem.cpp

@@ -15,9 +15,8 @@ namespace ix
         WSADATA wsaData;
         int err;
 
-        /* Use the MAKEWORD(lowbyte, highbyte) macro declared in Windef.h */
+        // Use the MAKEWORD(lowbyte, highbyte) macro declared in Windef.h
         wVersionRequested = MAKEWORD(2, 2);
-
         err = WSAStartup(wVersionRequested, &wsaData);
 
         return err == 0;
@@ -30,10 +29,85 @@ namespace ix
     {
 #ifdef _WIN32
         int err = WSACleanup();
-
         return err == 0;
 #else
         return true;
 #endif
     }
-}
+
+    //
+    // That function could 'return WSAPoll(pfd, nfds, timeout);'
+    // but WSAPoll is said to have weird behaviors on the internet
+    // (the curl folks have had problems with it).
+    //
+    // So we make it a select wrapper
+    //
+    int poll(struct pollfd *fds, nfds_t nfds, int timeout)
+    {
+#ifdef _WIN32
+        int maxfd = 0;
+        fd_set readfds, writefds, errorfds;
+        FD_ZERO(&readfds);
+        FD_ZERO(&writefds);
+        FD_ZERO(&errorfds);
+
+        for (nfds_t i = 0; i < nfds; ++i)
+        {
+            struct pollfd *fd = &fds[i];
+
+            if (fd->fd > maxfd)
+            {
+                maxfd = fd->fd;
+            }
+            if ((fd->events & POLLIN))
+            {
+                FD_SET(fd->fd, &readfds);
+            }
+            if ((fd->events & POLLOUT))
+            {
+                FD_SET(fd->fd, &writefds);
+            }
+            if ((fd->events & POLLERR))
+            {
+                FD_SET(fd->fd, &errorfds);
+            }
+        }
+
+        struct timeval tv;
+        tv.tv_sec = timeout / 1000;
+        tv.tv_usec = (timeout % 1000) * 1000;
+
+        int ret = select(maxfd + 1, &readfds, &writefds, &errorfds,
+                         timeout != -1 ? &tv : NULL);
+
+        if (ret < 0)
+        {
+            return ret;
+        }
+
+        for (nfds_t i = 0; i < nfds; ++i)
+        {
+            struct pollfd *fd = &fds[i];
+            fd->revents = 0;
+
+            if (FD_ISSET(fd->fd, &readfds))
+            {
+                fd->revents |= POLLIN;
+            }
+            if (FD_ISSET(fd->fd, &writefds))
+            {
+                fd->revents |= POLLOUT;
+            }
+            if (FD_ISSET(fd->fd, &errorfds))
+            {
+                fd->revents |= POLLERR;
+            }
+        }
+
+        return ret;
+#else
+        return ::poll(fds, nfds, timeout);
+#endif
+    }
+
+} // namespace ix

ixwebsocket/IXNetSystem.h

@@ -7,25 +7,32 @@
 #pragma once
 
 #ifdef _WIN32
-# include <WS2tcpip.h>
-# include <WinSock2.h>
-# include <basetsd.h>
-# include <io.h>
-# include <ws2def.h>
+#include <WS2tcpip.h>
+#include <WinSock2.h>
+#include <basetsd.h>
+#include <io.h>
+#include <ws2def.h>
+
+// Define our own poll on Windows, as a wrapper on top of select
+typedef unsigned long int nfds_t;
+
 #else
-# include <arpa/inet.h>
-# include <errno.h>
-# include <netdb.h>
-# include <netinet/tcp.h>
-# include <sys/select.h>
-# include <sys/socket.h>
-# include <sys/stat.h>
-# include <sys/time.h>
-# include <unistd.h>
+#include <arpa/inet.h>
+#include <errno.h>
+#include <netdb.h>
+#include <netinet/tcp.h>
+#include <poll.h>
+#include <sys/select.h>
+#include <sys/socket.h>
+#include <sys/stat.h>
+#include <sys/time.h>
+#include <unistd.h>
 #endif
 
 namespace ix
 {
     bool initNetSystem();
     bool uninitNetSystem();
-}
+
+    int poll(struct pollfd* fds, nfds_t nfds, int timeout);
+} // namespace ix

ixwebsocket/IXSelectInterrupt.h

@@ -11,7 +11,8 @@
 
 namespace ix
 {
-    class SelectInterrupt {
+    class SelectInterrupt
+    {
     public:
         SelectInterrupt();
         virtual ~SelectInterrupt();
@@ -23,6 +24,4 @@ namespace ix
         virtual uint64_t read();
         virtual int getFd() const;
     };
-}
-
-
+} // namespace ix

ixwebsocket/IXSelectInterruptEventFd.h

@@ -7,13 +7,13 @@
 #pragma once
 
 #include "IXSelectInterrupt.h"
-
 #include <stdint.h>
 #include <string>
 
 namespace ix
 {
-    class SelectInterruptEventFd : public SelectInterrupt {
+    class SelectInterruptEventFd final : public SelectInterrupt
+    {
     public:
         SelectInterruptEventFd();
         virtual ~SelectInterruptEventFd();
@@ -28,5 +28,4 @@ namespace ix
     private:
         int _eventfd;
     };
-}
-
+} // namespace ix

ixwebsocket/IXSelectInterruptFactory.h

@@ -12,4 +12,4 @@ namespace ix
 {
     class SelectInterrupt;
     std::shared_ptr<SelectInterrupt> createSelectInterrupt();
-}
+} // namespace ix

ixwebsocket/IXSelectInterruptPipe.cpp

@@ -40,6 +40,8 @@ namespace ix
 
     bool SelectInterruptPipe::init(std::string& errorMsg)
     {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
         // calling init twice is a programming error
         assert(_fildes[kPipeReadIndex] == -1);
         assert(_fildes[kPipeWriteIndex] == -1);
@@ -108,6 +110,8 @@ namespace ix
 
     bool SelectInterruptPipe::notify(uint64_t value)
     {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
         int fd = _fildes[kPipeWriteIndex];
         if (fd == -1) return false;
 
@@ -118,6 +122,8 @@ namespace ix
     // TODO: return max uint64_t for errors ?
     uint64_t SelectInterruptPipe::read()
     {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
         int fd = _fildes[kPipeReadIndex];
 
         uint64_t value = 0;
@@ -133,6 +139,8 @@ namespace ix
 
     int SelectInterruptPipe::getFd() const
     {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
         return _fildes[kPipeReadIndex];
     }
 }

ixwebsocket/IXSelectInterruptPipe.h

@@ -7,13 +7,14 @@
 #pragma once
 
 #include "IXSelectInterrupt.h"
-
+#include <mutex>
 #include <stdint.h>
 #include <string>
 
 namespace ix
 {
-    class SelectInterruptPipe : public SelectInterrupt {
+    class SelectInterruptPipe final : public SelectInterrupt
+    {
     public:
         SelectInterruptPipe();
         virtual ~SelectInterruptPipe();
@@ -30,10 +31,10 @@ namespace ix
         // happens between a control thread and a background thread, which is
         // blocked on select.
         int _fildes[2];
+        mutable std::mutex _fildesMutex;
 
         // Used to identify the read/write idx
         static const int kPipeReadIndex;
         static const int kPipeWriteIndex;
     };
-}
-
+} // namespace ix

ixwebsocket/IXSetThreadName.h

@@ -10,4 +10,3 @@ namespace ix
 {
     void setThreadName(const std::string& name);
 }
-

ixwebsocket/IXSocket.cpp

@@ -19,7 +19,6 @@
 #include <sys/types.h>
 
 #include <algorithm>
-#include <iostream>
 
 #ifdef min
 #undef min
@@ -45,43 +44,42 @@ namespace ix
         close();
     }
 
-    PollResultType Socket::poll(int timeoutSecs)
+    PollResultType Socket::poll(bool readyToRead,
+                                int timeoutMs,
+                                int sockfd,
+                                std::shared_ptr<SelectInterrupt> selectInterrupt)
     {
-        if (_sockfd == -1)
-        {
-            return PollResultType::Error;
-        }
+        //
+        // We used to use ::select to poll but on Android 9 we get large fds out of ::connect
+        // which crash in FD_SET as they are larger than FD_SETSIZE.
+        // Switching to ::poll does fix that.
+        //
+        // However poll isn't as portable as select and has bugs on Windows, so we should write a
+        // shim to fallback to select on those platforms.
+        // See https://github.com/mpv-player/mpv/pull/5203/files for such a select wrapper.
+        //
+        nfds_t nfds = 1;
+        struct pollfd fds[2];
 
-        return isReadyToRead(1000 * timeoutSecs);
-    }
-
-    PollResultType Socket::select(bool readyToRead, int timeoutMs)
-    {
-        fd_set rfds;
-        fd_set wfds;
-        FD_ZERO(&rfds);
-        FD_ZERO(&wfds);
-
-        fd_set* fds = (readyToRead) ? &rfds : & wfds;
-        FD_SET(_sockfd, fds);
+        fds[0].fd = sockfd;
+        fds[0].events = (readyToRead) ? POLLIN : POLLOUT;
+        fds[0].events |= POLLERR;
 
         // File descriptor used to interrupt select when needed
-        int interruptFd = _selectInterrupt->getFd();
-        if (interruptFd != -1)
+        int interruptFd = -1;
+        if (selectInterrupt)
         {
-            FD_SET(interruptFd, fds);
+            interruptFd = selectInterrupt->getFd();
+
+            if (interruptFd != -1)
+            {
+                nfds = 2;
+                fds[1].fd = interruptFd;
+                fds[1].events = POLLIN;
+            }
         }
 
-        struct timeval timeout;
-        timeout.tv_sec = timeoutMs / 1000;
-        timeout.tv_usec = (timeoutMs < 1000) ? 0 : 1000 * (timeoutMs % 1000);
-
-        // Compute the highest fd.
-        int sockfd = _sockfd;
-        int nfds = (std::max)(sockfd, interruptFd);
-
-        int ret = ::select(nfds + 1, &rfds, &wfds, nullptr,
-                           (timeoutMs < 0) ? nullptr : &timeout);
+        int ret = ix::poll(fds, nfds, timeoutMs);
 
         PollResultType pollResult = PollResultType::ReadyForRead;
         if (ret < 0)
@@ -92,9 +90,9 @@ namespace ix
         {
             pollResult = PollResultType::Timeout;
         }
-        else if (interruptFd != -1 && FD_ISSET(interruptFd, &rfds))
+        else if (interruptFd != -1 && fds[1].revents & POLLIN)
         {
-            uint64_t value = _selectInterrupt->read();
+            uint64_t value = selectInterrupt->read();
 
             if (value == kSendRequest)
             {
@@ -105,13 +103,36 @@ namespace ix
                 pollResult = PollResultType::CloseRequest;
             }
         }
-        else if (sockfd != -1 && readyToRead && FD_ISSET(sockfd, &rfds))
+        else if (sockfd != -1 && readyToRead && fds[0].revents & POLLIN)
         {
             pollResult = PollResultType::ReadyForRead;
         }
-        else if (sockfd != -1 && !readyToRead && FD_ISSET(sockfd, &wfds))
+        else if (sockfd != -1 && !readyToRead && fds[0].revents & POLLOUT)
         {
             pollResult = PollResultType::ReadyForWrite;
+
+#ifdef _WIN32
+            // On connect error, in async mode, windows will write to the exceptions fds
+            if (fds[0].revents & POLLERR)
+            {
+                pollResult = PollResultType::Error;
+            }
+#else
+            int optval = -1;
+            socklen_t optlen = sizeof(optval);
+
+            // getsockopt() puts the errno value for connect into optval so 0
+            // means no-error.
+            if (getsockopt(sockfd, SOL_SOCKET, SO_ERROR, &optval, &optlen) == -1 ||
+                optval != 0)
+            {
+                pollResult = PollResultType::Error;
+
+                // set errno to optval so that external callers can have an
+                // appropriate error description when calling strerror
+                errno = optval;
+            }
+#endif
         }
 
         return pollResult;
@@ -119,18 +140,28 @@ namespace ix
 
     PollResultType Socket::isReadyToRead(int timeoutMs)
     {
+        if (_sockfd == -1)
+        {
+            return PollResultType::Error;
+        }
+
         bool readyToRead = true;
-        return select(readyToRead, timeoutMs);
+        return poll(readyToRead, timeoutMs, _sockfd, _selectInterrupt);
     }
 
     PollResultType Socket::isReadyToWrite(int timeoutMs)
     {
+        if (_sockfd == -1)
+        {
+            return PollResultType::Error;
+        }
+
         bool readyToRead = false;
-        return select(readyToRead, timeoutMs);
+        return poll(readyToRead, timeoutMs, _sockfd, _selectInterrupt);
     }
 
     // Wake up from poll/select by writing to the pipe which is watched by select
-    bool Socket::wakeUpFromPoll(uint8_t wakeUpCode)
+    bool Socket::wakeUpFromPoll(uint64_t wakeUpCode)
     {
         return _selectInterrupt->notify(wakeUpCode);
     }
@@ -160,8 +191,6 @@ namespace ix
 
     ssize_t Socket::send(char* buffer, size_t length)
     {
-        std::lock_guard<std::mutex> lock(_socketMutex);
-
         int flags = 0;
 #ifdef MSG_NOSIGNAL
         flags = MSG_NOSIGNAL;
@@ -177,8 +206,6 @@ namespace ix
 
     ssize_t Socket::recv(void* buffer, size_t length)
     {
-        std::lock_guard<std::mutex> lock(_socketMutex);
-
         int flags = 0;
 #ifdef MSG_NOSIGNAL
         flags = MSG_NOSIGNAL;
@@ -229,19 +256,28 @@ namespace ix
     bool Socket::writeBytes(const std::string& str,
                             const CancellationRequest& isCancellationRequested)
     {
+        int offset = 0;
+        int len = (int) str.size();
+
         while (true)
         {
             if (isCancellationRequested && isCancellationRequested()) return false;
 
-            char* buffer = const_cast<char*>(str.c_str());
-            int len = (int) str.size();
-
-            ssize_t ret = send(buffer, len);
+            ssize_t ret = send((char*)&str[offset], len);
 
             // We wrote some bytes, as needed, all good.
             if (ret > 0)
             {
-                return ret == len;
+                if (ret == len)
+                {
+                    return true;
+                }
+                else
+                {
+                    offset += ret;
+                    len -= ret;
+                    continue;
+                }
             }
             // There is possibly something to be writen, try again
             else if (ret < 0 && Socket::isWaitNeeded())

ixwebsocket/IXSocket.h

@@ -6,12 +6,12 @@
 
 #pragma once
 
-#include <string>
-#include <functional>
-#include <mutex>
 #include <atomic>
-#include <vector>
+#include <functional>
 #include <memory>
+#include <mutex>
+#include <string>
+#include <vector>
 
 #ifdef _WIN32
 #include <BaseTsd.h>
@@ -24,11 +24,11 @@ typedef SSIZE_T ssize_t;
 #undef EINVAL
 
 // map to WSA error codes
-#define EWOULDBLOCK    WSAEWOULDBLOCK
-#define EAGAIN         WSATRY_AGAIN
-#define EINPROGRESS    WSAEINPROGRESS
-#define EBADF          WSAEBADF
-#define EINVAL         WSAEINVAL
+#define EWOULDBLOCK WSAEWOULDBLOCK
+#define EAGAIN WSATRY_AGAIN
+#define EINPROGRESS WSAEINPROGRESS
+#define EBADF WSAEBADF
+#define EINVAL WSAEINVAL
 
 #endif
 
@@ -49,15 +49,16 @@ namespace ix
         CloseRequest = 5
     };
 
-    class Socket {
+    class Socket
+    {
     public:
         Socket(int fd = -1);
         virtual ~Socket();
         bool init(std::string& errorMsg);
 
         // Functions to check whether there is activity on the socket
-        PollResultType poll(int timeoutSecs = kDefaultPollTimeout);
-        bool wakeUpFromPoll(uint8_t wakeUpCode);
+        PollResultType poll(int timeoutMs = kDefaultPollTimeout);
+        bool wakeUpFromPoll(uint64_t wakeUpCode);
 
         PollResultType isReadyToWrite(int timeoutMs);
         PollResultType isReadyToRead(int timeoutMs);
@@ -75,22 +76,24 @@ namespace ix
 
         // Blocking and cancellable versions, working with socket that can be set
         // to non blocking mode. Used during HTTP upgrade.
-        bool readByte(void* buffer,
-                      const CancellationRequest& isCancellationRequested);
-        bool writeBytes(const std::string& str,
-                        const CancellationRequest& isCancellationRequested);
+        bool readByte(void* buffer, const CancellationRequest& isCancellationRequested);
+        bool writeBytes(const std::string& str, const CancellationRequest& isCancellationRequested);
 
-        std::pair<bool, std::string> readLine(
-            const CancellationRequest& isCancellationRequested);
-        std::pair<bool, std::string> readBytes(
-            size_t length,
-            const OnProgressCallback& onProgressCallback,
-            const CancellationRequest& isCancellationRequested);
+        std::pair<bool, std::string> readLine(const CancellationRequest& isCancellationRequested);
+        std::pair<bool, std::string> readBytes(size_t length,
+                                               const OnProgressCallback& onProgressCallback,
+                                               const CancellationRequest& isCancellationRequested);
 
         static int getErrno();
         static bool isWaitNeeded();
         static void closeSocket(int fd);
 
+        static PollResultType poll(bool readyToRead,
+                                   int timeoutMs,
+                                   int sockfd,
+                                   std::shared_ptr<SelectInterrupt> selectInterrupt = nullptr);
+
+
         // Used as special codes for pipe communication
         static const uint64_t kSendRequest;
         static const uint64_t kCloseRequest;
@@ -100,8 +103,6 @@ namespace ix
         std::mutex _socketMutex;
 
     private:
-        PollResultType select(bool readyToRead, int timeoutMs);
-
         static const int kDefaultPollTimeout;
         static const int kDefaultPollNoTimeout;
 
@@ -111,4 +112,4 @@ namespace ix
 
         std::shared_ptr<SelectInterrupt> _selectInterrupt;
     };
-}
+} // namespace ix

ixwebsocket/IXSocketAppleSSL.cpp

@@ -20,8 +20,6 @@
 #include <unistd.h>
 #include <stdint.h>
 
-#include <iostream>
-
 #include <errno.h>
 #define socketerrno errno
 

ixwebsocket/IXSocketAppleSSL.h

@@ -6,17 +6,15 @@
 
 #pragma once
 
-#include "IXSocket.h"
 #include "IXCancellationRequest.h"
-
-#include <Security/Security.h>
+#include "IXSocket.h"
 #include <Security/SecureTransport.h>
-
+#include <Security/Security.h>
 #include <mutex>
 
 namespace ix
 {
-    class SocketAppleSSL : public Socket
+    class SocketAppleSSL final : public Socket
     {
     public:
         SocketAppleSSL(int fd = -1);
@@ -34,7 +32,7 @@ namespace ix
 
     private:
         SSLContextRef _sslContext;
-        mutable std::mutex _mutex;  // AppleSSL routines are not thread-safe
+        mutable std::mutex _mutex; // AppleSSL routines are not thread-safe
     };
 
-}
+} // namespace ix

ixwebsocket/IXSocketConnect.cpp

@@ -63,55 +63,31 @@ namespace ix
                 return -1;
             }
 
-            // On Linux the timeout needs to be re-initialized everytime
-            // http://man7.org/linux/man-pages/man2/select.2.html
-            struct timeval timeout;
-            timeout.tv_sec = 0;
-            timeout.tv_usec = 10 * 1000; // 10ms timeout
+            int timeoutMs = 10;
+            bool readyToRead = false;
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, fd);
 
-            fd_set wfds;
-            fd_set efds;
-
-            FD_ZERO(&wfds);
-            FD_SET(fd, &wfds);
-            FD_ZERO(&efds);
-            FD_SET(fd, &efds);
-
-            // Use select to check the status of the new connection
-            res = select(fd + 1, nullptr, &wfds, &efds, &timeout);
-
-            if (res < 0 && (Socket::getErrno() == EBADF || Socket::getErrno() == EINVAL))
+            if (pollResult == PollResultType::Timeout)
+            {
+                continue;
+            }
+            else if (pollResult == PollResultType::Error)
             {
                 Socket::closeSocket(fd);
-                errMsg = std::string("Connect error, select error: ") + strerror(Socket::getErrno());
+                errMsg = std::string("Connect error: ") +
+                            strerror(Socket::getErrno());
                 return -1;
             }
-
-            // Nothing was written to the socket, wait again.
-            if (!FD_ISSET(fd, &wfds)) continue;
-
-            // Something was written to the socket. Check for errors.
-            int optval = -1;
-            socklen_t optlen = sizeof(optval);
-
-#ifdef _WIN32
-            // On connect error, in async mode, windows will write to the exceptions fds
-            if (FD_ISSET(fd, &efds))
-#else
-            // getsockopt() puts the errno value for connect into optval so 0
-            // means no-error.
-            if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &optval, &optlen) == -1 ||
-                optval != 0)
-#endif
+            else if (pollResult == PollResultType::ReadyForWrite)
             {
-                Socket::closeSocket(fd);
-                errMsg = strerror(optval);
-                return -1;
+                return fd;
             }
             else
             {
-                // Success !
-                return fd;
+                Socket::closeSocket(fd);
+                errMsg = std::string("Connect error: ") +
+                            strerror(Socket::getErrno());
+                return -1;
             }
         }
 
@@ -128,8 +104,8 @@ namespace ix
         //
         // First do DNS resolution
         //
-        DNSLookup dnsLookup(hostname, port);
-        struct addrinfo *res = dnsLookup.resolve(errMsg, isCancellationRequested);
+        auto dnsLookup = std::make_shared<DNSLookup>(hostname, port);
+        struct addrinfo *res = dnsLookup->resolve(errMsg, isCancellationRequested);
         if (res == nullptr)
         {
             return -1;

ixwebsocket/IXSocketConnect.h

@@ -7,14 +7,14 @@
 #pragma once
 
 #include "IXCancellationRequest.h"
-
 #include <string>
 
 struct addrinfo;
 
 namespace ix
 {
-    class SocketConnect {
+    class SocketConnect
+    {
     public:
         static int connect(const std::string& hostname,
                            int port,
@@ -24,9 +24,8 @@ namespace ix
         static void configure(int sockfd);
 
     private:
-        static int connectToAddress(const struct addrinfo *address,
+        static int connectToAddress(const struct addrinfo* address,
                                     std::string& errMsg,
                                     const CancellationRequest& isCancellationRequested);
     };
-}
-
+} // namespace ix

ixwebsocket/IXSocketFactory.cpp

@@ -8,11 +8,13 @@
 
 #ifdef IXWEBSOCKET_USE_TLS
 
-# ifdef __APPLE__
+# ifdef IXWEBSOCKET_USE_MBED_TLS
+#  include <ixwebsocket/IXSocketMbedTLS.h>
+# elif __APPLE__
 #  include <ixwebsocket/IXSocketAppleSSL.h>
 # elif defined(_WIN32)
 #  include <ixwebsocket/IXSocketSChannel.h>
-# else
+# elif defined(IXWEBSOCKET_USE_OPEN_SSL)
 #  include <ixwebsocket/IXSocketOpenSSL.h>
 # endif
 
@@ -37,7 +39,9 @@ namespace ix
         else
         {
 #ifdef IXWEBSOCKET_USE_TLS
-# ifdef __APPLE__
+# if defined(IXWEBSOCKET_USE_MBED_TLS)
+            socket = std::make_shared<SocketMbedTLS>();
+# elif defined(__APPLE__)
             socket = std::make_shared<SocketAppleSSL>();
 # elif defined(_WIN32)
             socket = std::make_shared<SocketSChannel>();

ixwebsocket/IXSocketFactory.h

@@ -13,9 +13,7 @@
 namespace ix
 {
     class Socket;
-    std::shared_ptr<Socket> createSocket(bool tls,
-                                         std::string& errorMsg);
+    std::shared_ptr<Socket> createSocket(bool tls, std::string& errorMsg);
 
-    std::shared_ptr<Socket> createSocket(int fd,
-                                         std::string& errorMsg);
-}
+    std::shared_ptr<Socket> createSocket(int fd, std::string& errorMsg);
+} // namespace ix

ixwebsocket/IXSocketMbedTLS.cpp

@@ -0,0 +1,178 @@
+/*
+ *  IXSocketMbedTLS.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ *
+ *  Some code taken from
+ *  https://github.com/rottor12/WsClientLib/blob/master/lib/src/WsClientLib.cpp
+ *  and mini_client.c example from mbedtls
+ */
+
+#include "IXSocketMbedTLS.h"
+#include "IXSocketConnect.h"
+#include "IXNetSystem.h"
+#include "IXSocket.h"
+
+#include <string.h>
+
+namespace ix
+{
+    SocketMbedTLS::~SocketMbedTLS()
+    {
+        close();
+    }
+
+    bool SocketMbedTLS::init(const std::string& host, std::string& errMsg)
+    {
+        std::lock_guard<std::mutex> lock(_mutex);
+
+        mbedtls_ssl_init(&_ssl);
+        mbedtls_ssl_config_init(&_conf);
+        mbedtls_ctr_drbg_init(&_ctr_drbg);
+
+        const char *pers = "IXSocketMbedTLS";
+
+        mbedtls_entropy_init(&_entropy);
+        if (mbedtls_ctr_drbg_seed(&_ctr_drbg,
+                                  mbedtls_entropy_func,
+                                  &_entropy,
+                                  (const unsigned char *) pers,
+                                  strlen(pers)) != 0)
+        {
+            errMsg = "Setting entropy seed failed";
+            return false;
+        }
+
+        if (mbedtls_ssl_config_defaults(&_conf,
+                                        MBEDTLS_SSL_IS_CLIENT,
+                                        MBEDTLS_SSL_TRANSPORT_STREAM,
+                                        MBEDTLS_SSL_PRESET_DEFAULT ) != 0)
+        {
+            errMsg = "Setting config default failed";
+            return false;
+        }
+
+        mbedtls_ssl_conf_rng(&_conf, mbedtls_ctr_drbg_random, &_ctr_drbg);
+
+        // FIXME: cert verification is disabled
+        mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_NONE);
+
+        if (mbedtls_ssl_setup(&_ssl, &_conf) != 0)
+        {
+            errMsg = "SSL setup failed";
+            return false;
+        }
+
+        if (mbedtls_ssl_set_hostname(&_ssl, host.c_str()) != 0)
+        {
+            errMsg = "SNI setup failed";
+            return false;
+        }
+
+        return true;
+    }
+
+    bool SocketMbedTLS::connect(const std::string& host,
+                                int port,
+                                std::string& errMsg,
+                                const CancellationRequest& isCancellationRequested)
+    {
+        {
+            std::lock_guard<std::mutex> lock(_mutex);
+            _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
+            if (_sockfd == -1) return false;
+        }
+
+        if (!init(host, errMsg))
+        {
+            close();
+            return false;
+        }
+
+        mbedtls_ssl_set_bio(&_ssl, &_sockfd, mbedtls_net_send, mbedtls_net_recv, NULL);
+
+        int res;
+        do
+        {
+            std::lock_guard<std::mutex> lock(_mutex);
+            res = mbedtls_ssl_handshake(&_ssl);
+        }
+        while (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE);
+
+        if (res != 0)
+        {
+            char buf[256];
+            mbedtls_strerror(res, buf, sizeof(buf));
+
+            errMsg = "error in handshake : ";
+            errMsg += buf;
+
+            close();
+            return false;
+        }
+
+        return true;
+    }
+
+    void SocketMbedTLS::close()
+    {
+        std::lock_guard<std::mutex> lock(_mutex);
+
+        mbedtls_ssl_free(&_ssl);
+        mbedtls_ssl_config_free(&_conf);
+        mbedtls_ctr_drbg_free(&_ctr_drbg);
+        mbedtls_entropy_free(&_entropy);
+
+        Socket::close();
+    }
+
+    ssize_t SocketMbedTLS::send(char* buf, size_t nbyte)
+    {
+        ssize_t sent = 0;
+
+        while (nbyte > 0)
+        {
+            std::lock_guard<std::mutex> lock(_mutex);
+
+            ssize_t res = mbedtls_ssl_write(&_ssl, (unsigned char*) buf, nbyte);
+
+            if (res > 0) {
+                nbyte -= res;
+                sent += res;
+            } else if (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE) {
+                errno = EWOULDBLOCK;
+                return -1;
+            } else {
+                return -1;
+            }
+        }
+        return sent;
+    }
+
+    ssize_t SocketMbedTLS::send(const std::string& buffer)
+    {
+        return send((char*)&buffer[0], buffer.size());
+    }
+
+    ssize_t SocketMbedTLS::recv(void* buf, size_t nbyte)
+    {
+        while (true)
+        {
+            std::lock_guard<std::mutex> lock(_mutex);
+
+            ssize_t res = mbedtls_ssl_read(&_ssl, (unsigned char*) buf, (int) nbyte);
+
+            if (res > 0)
+            {
+                return res;
+            }
+
+            if (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE)
+            {
+                errno = EWOULDBLOCK;
+            }
+            return -1;
+        }
+    }
+
+}

ixwebsocket/IXSocketMbedTLS.h

@@ -0,0 +1,47 @@
+/*
+ *  IXSocketMbedTLS.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSocket.h"
+#include <mbedtls/ctr_drbg.h>
+#include <mbedtls/debug.h>
+#include <mbedtls/entropy.h>
+#include <mbedtls/error.h>
+#include <mbedtls/net.h>
+#include <mbedtls/platform.h>
+#include <mutex>
+
+namespace ix
+{
+    class SocketMbedTLS final : public Socket
+    {
+    public:
+        SocketMbedTLS() = default;
+        ~SocketMbedTLS();
+
+        virtual bool connect(const std::string& host,
+                             int port,
+                             std::string& errMsg,
+                             const CancellationRequest& isCancellationRequested) final;
+        virtual void close() final;
+
+        virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
+        virtual ssize_t recv(void* buffer, size_t length) final;
+
+    private:
+        mbedtls_ssl_context _ssl;
+        mbedtls_ssl_config _conf;
+        mbedtls_entropy_context _entropy;
+        mbedtls_ctr_drbg_context _ctr_drbg;
+
+        std::mutex _mutex;
+
+        bool init(const std::string& host, std::string& errMsg);
+    };
+
+} // namespace ix

ixwebsocket/IXSocketOpenSSL.cpp

@@ -10,7 +10,6 @@
 #include "IXSocketConnect.h"
 
 #include <cassert>
-#include <iostream>
 
 #include <openssl/x509v3.h>
 
@@ -241,7 +240,6 @@ namespace ix
         }
     }
 
-    // No wait support
     bool SocketOpenSSL::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg,
@@ -362,7 +360,6 @@ namespace ix
         return send((char*)&buffer[0], buffer.size());
     }
 
-    // No wait support
     ssize_t SocketOpenSSL::recv(void* buf, size_t nbyte)
     {
         while (true)

ixwebsocket/IXSocketOpenSSL.h

@@ -6,20 +6,18 @@
 
 #pragma once
 
-#include "IXSocket.h"
 #include "IXCancellationRequest.h"
-
+#include "IXSocket.h"
+#include <mutex>
 #include <openssl/bio.h>
-#include <openssl/hmac.h>
 #include <openssl/conf.h>
 #include <openssl/err.h>
+#include <openssl/hmac.h>
 #include <openssl/ssl.h>
 
-#include <mutex>
-
 namespace ix
 {
-    class SocketOpenSSL : public Socket
+    class SocketOpenSSL final : public Socket
     {
     public:
         SocketOpenSSL(int fd = -1);
@@ -40,18 +38,16 @@ namespace ix
         std::string getSSLError(int ret);
         SSL_CTX* openSSLCreateContext(std::string& errMsg);
         bool openSSLHandshake(const std::string& hostname, std::string& errMsg);
-        bool openSSLCheckServerCert(SSL *ssl,
-                                    const std::string& hostname,
-                                    std::string& errMsg);
-        bool checkHost(const std::string& host, const char *pattern);
+        bool openSSLCheckServerCert(SSL* ssl, const std::string& hostname, std::string& errMsg);
+        bool checkHost(const std::string& host, const char* pattern);
 
         SSL* _ssl_connection;
         SSL_CTX* _ssl_context;
         const SSL_METHOD* _ssl_method;
-        mutable std::mutex _mutex;  // OpenSSL routines are not thread-safe
+        mutable std::mutex _mutex; // OpenSSL routines are not thread-safe
 
         static std::once_flag _openSSLInitFlag;
         static std::atomic<bool> _openSSLInitializationSuccessful;
     };
 
-}
+} // namespace ix

ixwebsocket/IXSocketSChannel.h

@@ -10,15 +10,13 @@
 
 namespace ix
 {
-    class SocketSChannel : public Socket
+    class SocketSChannel final : public Socket
     {
     public:
         SocketSChannel();
         ~SocketSChannel();
 
-        virtual bool connect(const std::string& host,
-                             int port,
-                             std::string& errMsg) final;
+        virtual bool connect(const std::string& host, int port, std::string& errMsg) final;
         virtual void close() final;
 
         // The important override
@@ -31,4 +29,4 @@ namespace ix
     private:
     };
 
-}
+} // namespace ix

ixwebsocket/IXSocketServer.cpp

@@ -11,7 +11,6 @@
 
 #include <iostream>
 #include <sstream>
-#include <future>
 #include <string.h>
 #include <assert.h>
 
@@ -30,7 +29,9 @@ namespace ix
         _host(host),
         _backlog(backlog),
         _maxConnections(maxConnections),
+        _serverFd(-1),
         _stop(false),
+        _stopGc(false),
         _connectionStateFactory(&ConnectionState::createConnectionState)
     {
 
@@ -124,9 +125,15 @@ namespace ix
 
     void SocketServer::start()
     {
-        if (_thread.joinable()) return; // we've already been started
+        if (!_thread.joinable())
+        {
+            _thread = std::thread(&SocketServer::run, this);
+        }
 
-        _thread = std::thread(&SocketServer::run, this);
+        if (!_gcThread.joinable())
+        {
+            _gcThread = std::thread(&SocketServer::runGC, this);
+        }
     }
 
     void SocketServer::wait()
@@ -142,21 +149,21 @@ namespace ix
 
     void SocketServer::stop()
     {
-        while (true)
+        // Stop accepting connections, and close the 'accept' thread
+        if (_thread.joinable())
         {
-            if (closeTerminatedThreads()) break;
-
-            // wait 10ms and try again later.
-            // we could have a timeout, but if we exit of here
-            // we leaked threads, it is quite bad.
-            std::this_thread::sleep_for(std::chrono::milliseconds(10));
+            _stop = true;
+            _thread.join();
+            _stop = false;
         }
 
-        if (!_thread.joinable()) return; // nothing to do
-
-        _stop = true;
-        _thread.join();
-        _stop = false;
+        // Join all threads and make sure that all connections are terminated
+        if (_gcThread.joinable())
+        {
+            _stopGc = true;
+            _gcThread.join();
+            _stopGc = false;
+        }
 
         _conditionVariable.notify_one();
         Socket::closeSocket(_serverFd);
@@ -175,7 +182,7 @@ namespace ix
     // field becomes true, and we can use that to know that we can join that thread
     // and remove it from our _connectionsThreads data structure (a list).
     //
-    bool SocketServer::closeTerminatedThreads()
+    void SocketServer::closeTerminatedThreads()
     {
         std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
         auto it = _connectionsThreads.begin();
@@ -195,8 +202,6 @@ namespace ix
             if (thread.joinable()) thread.join();
             it = _connectionsThreads.erase(it);
         }
-
-        return _connectionsThreads.empty();
     }
 
     void SocketServer::run()
@@ -208,23 +213,12 @@ namespace ix
         {
             if (_stop) return;
 
-            // Garbage collection to shutdown/join threads for closed connections.
-            // We could run this in its own thread, so that we dont need to accept
-            // a new connection to close a thread.
-            // We could also use a condition variable to be notify when we need to do this
-            closeTerminatedThreads();
+            // Use poll to check whether a new connection is in progress
+            int timeoutMs = 10;
+            bool readyToRead = true;
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, _serverFd);
 
-            // Use select to check whether a new connection is in progress
-            fd_set rfds;
-            struct timeval timeout;
-            timeout.tv_sec = 0;
-            timeout.tv_usec = 10 * 1000; // 10ms timeout
-
-            FD_ZERO(&rfds);
-            FD_SET(_serverFd, &rfds);
-
-            if (select(_serverFd + 1, &rfds, nullptr, nullptr, &timeout) < 0 &&
-                (errno == EBADF || errno == EINVAL))
+            if (pollResult == PollResultType::Error)
             {
                 std::stringstream ss;
                 ss << "SocketServer::run() error in select: "
@@ -233,9 +227,8 @@ namespace ix
                 continue;
             }
 
-            if (!FD_ISSET(_serverFd, &rfds))
+            if (pollResult != PollResultType::ReadyForRead)
             {
-                // We reached the select timeout, and no new connections are pending
                 continue;
             }
 
@@ -290,5 +283,30 @@ namespace ix
                                 connectionState)));
         }
     }
+
+    size_t SocketServer::getConnectionsThreadsCount()
+    {
+        std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
+        return _connectionsThreads.size();
+    }
+
+    void SocketServer::runGC()
+    {
+        for (;;)
+        {
+            // Garbage collection to shutdown/join threads for closed connections.
+            closeTerminatedThreads();
+
+            // We quit this thread if all connections are closed and we received
+            // a stop request by setting _stopGc to true.
+            if (_stopGc && getConnectionsThreadsCount() == 0)
+            {
+                break;
+            }
+
+            // Sleep a little bit then keep cleaning up
+            std::this_thread::sleep_for(std::chrono::milliseconds(10));
+        }
+    }
 }
 

ixwebsocket/IXSocketServer.h

@@ -7,28 +7,28 @@
 #pragma once
 
 #include "IXConnectionState.h"
-
-#include <utility> // pair
-#include <string>
-#include <set>
-#include <thread>
-#include <list>
-#include <mutex>
-#include <functional>
-#include <memory>
 #include <atomic>
 #include <condition_variable>
+#include <functional>
+#include <list>
+#include <memory>
+#include <mutex>
+#include <set>
+#include <string>
+#include <thread>
+#include <utility> // pair
 
 namespace ix
 {
-    class SocketServer {
+    class SocketServer
+    {
     public:
         using ConnectionStateFactory = std::function<std::shared_ptr<ConnectionState>()>;
 
         // Each connection is handled by its own worker thread.
         // We use a list as we only care about remove and append operations.
-        using ConnectionThreads = std::list<std::pair<std::shared_ptr<ConnectionState>,
-                                                      std::thread>>;
+        using ConnectionThreads =
+            std::list<std::pair<std::shared_ptr<ConnectionState>, std::thread>>;
 
         SocketServer(int port = SocketServer::kDefaultPort,
                      const std::string& host = SocketServer::kDefaultHost,
@@ -52,7 +52,6 @@ namespace ix
         void wait();
 
     protected:
-
         // Logging
         void logError(const std::string& str);
         void logInfo(const std::string& str);
@@ -74,6 +73,12 @@ namespace ix
         // background thread to wait for incoming connections
         std::atomic<bool> _stop;
         std::thread _thread;
+        void run();
+
+        // background thread to cleanup (join) terminated threads
+        std::atomic<bool> _stopGc;
+        std::thread _gcThread;
+        void runGC();
 
         // the list of (connectionState, threads) for each connections
         ConnectionThreads _connectionsThreads;
@@ -87,13 +92,11 @@ namespace ix
         // the factory to create ConnectionState objects
         ConnectionStateFactory _connectionStateFactory;
 
-        // Methods
-        void run();
-        virtual void handleConnection(int fd,
-                                      std::shared_ptr<ConnectionState> connectionState) = 0;
+        virtual void handleConnection(int fd, std::shared_ptr<ConnectionState> connectionState) = 0;
         virtual size_t getConnectedClientsCount() = 0;
 
         // Returns true if all connection threads are joined
-        bool closeTerminatedThreads();
+        void closeTerminatedThreads();
+        size_t getConnectionsThreadsCount();
     };
-}
+} // namespace ix

ixwebsocket/IXUrlParser.cpp

@@ -7,8 +7,6 @@
 #include "IXUrlParser.h"
 #include "LUrlParser.h"
 
-#include <iostream>
-
 namespace ix
 {
     bool UrlParser::parse(const std::string& url,
@@ -66,22 +64,4 @@ namespace ix
         return true;
     }
 
-    void UrlParser::printUrl(const std::string& url)
-    {
-        std::string protocol, host, path, query;
-        int port {0};
-
-        if (!parse(url, protocol, host, path, query, port))
-        {
-            return;
-        }
-
-        std::cout << "[" << url << "]" << std::endl;
-        std::cout << protocol << std::endl;
-        std::cout << host << std::endl;
-        std::cout << port << std::endl;
-        std::cout << path << std::endl;
-        std::cout << query << std::endl;
-        std::cout << "-------------------------------" << std::endl;
-    }
 }

ixwebsocket/IXUrlParser.h

@@ -19,7 +19,5 @@ namespace ix
                           std::string& path,
                           std::string& query,
                           int& port);
-
-        static void printUrl(const std::string& url);
     };
-}
+} // namespace ix

ixwebsocket/IXUserAgent.cpp

@@ -0,0 +1,83 @@
+/*
+ *  IXUserAgent.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXUserAgent.h"
+#include "IXWebSocketVersion.h"
+
+#include <sstream>
+#include <zlib.h>
+
+// Platform name
+#if defined(_WIN32)
+    #define PLATFORM_NAME "windows" // Windows
+#elif defined(_WIN64)
+    #define PLATFORM_NAME "windows" // Windows
+#elif defined(__CYGWIN__) && !defined(_WIN32)
+    #define PLATFORM_NAME "windows" // Windows (Cygwin POSIX under Microsoft Window)
+#elif defined(__ANDROID__)
+    #define PLATFORM_NAME "android" // Android (implies Linux, so it must come first)
+#elif defined(__linux__)
+    #define PLATFORM_NAME "linux" // Debian, Ubuntu, Gentoo, Fedora, openSUSE, RedHat, Centos and other
+#elif defined(__unix__) || !defined(__APPLE__) && defined(__MACH__)
+    #include <sys/param.h>
+    #if defined(BSD)
+        #define PLATFORM_NAME "bsd" // FreeBSD, NetBSD, OpenBSD, DragonFly BSD
+    #endif
+#elif defined(__hpux)
+    #define PLATFORM_NAME "hp-ux" // HP-UX
+#elif defined(_AIX)
+    #define PLATFORM_NAME "aix" // IBM AIX
+#elif defined(__APPLE__) && defined(__MACH__) // Apple OSX and iOS (Darwin)
+    #include <TargetConditionals.h>
+    #if TARGET_IPHONE_SIMULATOR == 1
+        #define PLATFORM_NAME "ios" // Apple iOS
+    #elif TARGET_OS_IPHONE == 1
+        #define PLATFORM_NAME "ios" // Apple iOS
+    #elif TARGET_OS_MAC == 1
+        #define PLATFORM_NAME "macos" // Apple OSX
+    #endif
+#elif defined(__sun) && defined(__SVR4)
+    #define PLATFORM_NAME "solaris" // Oracle Solaris, Open Indiana
+#else
+    #define PLATFORM_NAME "unknown platform"
+#endif
+
+// SSL
+#if defined(IXWEBSOCKET_USE_OPEN_SSL)
+#include <openssl/opensslv.h>
+#endif
+
+namespace ix
+{
+    std::string userAgent()
+    {
+        std::stringstream ss;
+
+        // IXWebSocket Version
+        ss << "ixwebsocket/" << IX_WEBSOCKET_VERSION;
+
+        // Platform
+        ss << " " << PLATFORM_NAME;
+
+        // TLS
+#ifdef IXWEBSOCKET_USE_TLS
+#ifdef IXWEBSOCKET_USE_MBED_TLS
+        ss << " ssl/mbedtls";
+#elif __APPLE__
+        ss << " ssl/DarwinSSL";
+#elif defined(IXWEBSOCKET_USE_OPEN_SSL)
+        ss << " ssl/OpenSSL " << OPENSSL_VERSION_TEXT;
+#endif
+#else
+        ss << " nossl";
+#endif
+
+        // Zlib version
+        ss << " zlib " << ZLIB_VERSION;
+
+        return ss.str();
+    }
+}

ixwebsocket/IXUserAgent.h

@@ -0,0 +1,14 @@
+/*
+ *  IXUserAgent.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <string>
+
+namespace ix
+{
+    std::string userAgent();
+} // namespace ix

ixwebsocket/IXUtf8Validator.h

@@ -0,0 +1,167 @@
+/*
+ * The following code is adapted from code originally written by Bjoern
+ * Hoehrmann <bjoern@hoehrmann.de>. See
+ * http://bjoern.hoehrmann.de/utf-8/decoder/dfa/ for details.
+ *
+ * The original license:
+ *
+ * Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+*/
+
+/*
+ *  IXUtf8Validator.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ *
+ *  From websocketpp. Tiny modifications made for code style, function names etc...
+ */
+
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace ix
+{
+    /// State that represents a valid utf8 input sequence
+    static unsigned int const utf8_accept = 0;
+    /// State that represents an invalid utf8 input sequence
+    static unsigned int const utf8_reject = 1;
+
+    /// Lookup table for the UTF8 decode state machine
+    static uint8_t const utf8d[] = {
+      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, // 00..1f
+      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, // 20..3f
+      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, // 40..5f
+      0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, // 60..7f
+      1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9,9, // 80..9f
+      7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7,7, // a0..bf
+      8,8,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2,2, // c0..df
+      0xa,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x4,0x3,0x3, // e0..ef
+      0xb,0x6,0x6,0x6,0x5,0x8,0x8,0x8,0x8,0x8,0x8,0x8,0x8,0x8,0x8,0x8, // f0..ff
+      0x0,0x1,0x2,0x3,0x5,0x8,0x7,0x1,0x1,0x1,0x4,0x6,0x1,0x1,0x1,0x1, // s0..s0
+      1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0,1,1,1,1,1,0,1,0,1,1,1,1,1,1, // s1..s2
+      1,2,1,1,1,1,1,2,1,2,1,1,1,1,1,1,1,1,1,1,1,1,1,2,1,1,1,1,1,1,1,1, // s3..s4
+      1,2,1,1,1,1,1,1,1,2,1,1,1,1,1,1,1,1,1,1,1,1,1,3,1,3,1,1,1,1,1,1, // s5..s6
+      1,3,1,1,1,1,1,3,1,3,1,1,1,1,1,1,1,3,1,1,1,1,1,1,1,1,1,1,1,1,1,1, // s7..s8
+    };
+
+    /// Decode the next byte of a UTF8 sequence
+    /**
+     * @param [out] state The decoder state to advance
+     * @param [out] codep The codepoint to fill in
+     * @param [in] byte The byte to input
+     * @return The ending state of the decode operation
+     */
+    inline uint32_t decodeNextByte(uint32_t * state, uint32_t * codep, uint8_t byte)
+    {
+      uint32_t type = utf8d[byte];
+
+      *codep = (*state != utf8_accept) ?
+        (byte & 0x3fu) | (*codep << 6) :
+        (0xff >> type) & (byte);
+
+      *state = utf8d[256 + *state*16 + type];
+      return *state;
+    }
+
+    /// Provides streaming UTF8 validation functionality
+    class Utf8Validator
+    {
+    public:
+        /// Construct and initialize the validator
+        Utf8Validator() : m_state(utf8_accept),m_codepoint(0) {}
+
+        /// Advance the state of the validator with the next input byte
+        /**
+         * @param byte The byte to advance the validation state with
+         * @return Whether or not the byte resulted in a validation error.
+         */
+        bool consume(uint8_t byte)
+        {
+            if (decodeNextByte(&m_state,&m_codepoint,byte) == utf8_reject)
+            {
+                return false;
+            }
+            return true;
+        }
+
+        /// Advance Validator state with input from an iterator pair
+        /**
+         * @param begin Input iterator to the start of the input range
+         * @param end Input iterator to the end of the input range
+         * @return Whether or not decoding the bytes resulted in a validation error.
+         */
+        template <typename iterator_type>
+        bool decode(iterator_type begin, iterator_type end)
+        {
+            for (iterator_type it = begin; it != end; ++it)
+            {
+                unsigned int result = decodeNextByte(
+                    &m_state,
+                    &m_codepoint,
+                    static_cast<uint8_t>(*it)
+                );
+
+                if (result == utf8_reject)
+                {
+                    return false;
+                }
+            }
+            return true;
+        }
+
+        /// Return whether the input sequence ended on a valid utf8 codepoint
+        /**
+         * @return Whether or not the input sequence ended on a valid codepoint.
+         */
+        bool complete()
+        {
+            return m_state == utf8_accept;
+        }
+
+        /// Reset the Validator to decode another message
+        void reset()
+        {
+            m_state = utf8_accept;
+            m_codepoint = 0;
+        }
+    private:
+        uint32_t    m_state;
+        uint32_t    m_codepoint;
+    };
+
+    /// Validate a UTF8 string
+    /**
+     * convenience function that creates a Validator, validates a complete string
+     * and returns the result.
+     */
+    inline bool validateUtf8(std::string const & s)
+    {
+        Utf8Validator v;
+        if (!v.decode(s.begin(),s.end()))
+        {
+            return false;
+        }
+        return v.complete();
+    }
+
+} // namespace ix

ixwebsocket/IXWebSocket.cpp

@@ -7,25 +7,12 @@
 #include "IXWebSocket.h"
 #include "IXSetThreadName.h"
 #include "IXWebSocketHandshake.h"
+#include "IXExponentialBackoff.h"
+#include "IXUtf8Validator.h"
 
-#include <iostream>
 #include <cmath>
 #include <cassert>
 
-namespace
-{
-    uint64_t calculateRetryWaitMilliseconds(uint64_t retry_count)
-    {
-        // This will overflow quite fast for large value of retry_count
-        // and will become 0, in which case the wait time will be none
-        // and we'll be constantly retrying to connect.
-        uint64_t wait_time = ((uint64_t) std::pow(2, retry_count) * 100L);
-
-        // cap the wait time to 10s, or to retry_count == 10 for which wait_time > 10s
-        uint64_t tenSeconds = 10 * 1000;
-        return (wait_time > tenSeconds || retry_count > 10) ? tenSeconds : wait_time;
-    }
-}
 
 namespace ix
 {
@@ -34,11 +21,13 @@ namespace ix
     const int WebSocket::kDefaultPingIntervalSecs(-1);
     const int WebSocket::kDefaultPingTimeoutSecs(-1);
     const bool WebSocket::kDefaultEnablePong(true);
+    const uint32_t WebSocket::kDefaultMaxWaitBetweenReconnectionRetries(10 * 1000); // 10s
 
     WebSocket::WebSocket() :
         _onMessageCallback(OnMessageCallback()),
         _stop(false),
         _automaticReconnection(true),
+        _maxWaitBetweenReconnectionRetries(kDefaultMaxWaitBetweenReconnectionRetries),
         _handshakeTimeoutSecs(kDefaultHandShakeTimeoutSecs),
         _enablePong(kDefaultEnablePong),
         _pingIntervalSecs(kDefaultPingIntervalSecs),
@@ -47,9 +36,11 @@ namespace ix
         _ws.setOnCloseCallback(
             [this](uint16_t code, const std::string& reason, size_t wireSize, bool remote)
             {
-                _onMessageCallback(WebSocket_MessageType_Close, "", wireSize,
-                                   WebSocketErrorInfo(), WebSocketOpenInfo(),
-                                   WebSocketCloseInfo(code, reason, remote));
+                _onMessageCallback(
+                    std::make_shared<WebSocketMessage>(
+                        WebSocketMessageType::Close, "", wireSize,
+                        WebSocketErrorInfo(), WebSocketOpenInfo(),
+                        WebSocketCloseInfo(code, reason, remote)));
             }
         );
     }
@@ -64,6 +55,11 @@ namespace ix
         std::lock_guard<std::mutex> lock(_configMutex);
         _url = url;
     }
+    void WebSocket::setExtraHeaders(const WebSocketHttpHeaders& headers)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _extraHeaders = headers;
+    }
 
     const std::string& WebSocket::getUrl() const
     {
@@ -131,6 +127,25 @@ namespace ix
         _enablePong = false;
     }
 
+    void WebSocket::disablePerMessageDeflate()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        WebSocketPerMessageDeflateOptions perMessageDeflateOptions(false);
+        _perMessageDeflateOptions = perMessageDeflateOptions;
+    }
+
+    void WebSocket::setMaxWaitBetweenReconnectionRetries(uint32_t maxWaitBetweenReconnectionRetries)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _maxWaitBetweenReconnectionRetries = maxWaitBetweenReconnectionRetries;
+    }
+
+    uint32_t WebSocket::getMaxWaitBetweenReconnectionRetries() const
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        return _maxWaitBetweenReconnectionRetries;
+    }
+
     void WebSocket::start()
     {
         if (_thread.joinable()) return; // we've already been started
@@ -138,26 +153,19 @@ namespace ix
         _thread = std::thread(&WebSocket::run, this);
     }
 
-    void WebSocket::stop()
+    void WebSocket::stop(uint16_t code,
+                         const std::string& reason)
     {
-        bool automaticReconnection = _automaticReconnection;
+        close(code, reason);
 
-        // This value needs to be forced when shutting down, it is restored later
-        _automaticReconnection = false;
-
-        close();
-
-        if (!_thread.joinable())
+        if (_thread.joinable())
         {
-            _automaticReconnection = automaticReconnection;
-            return;
+            // wait until working thread will exit
+            // it will exit after close operation is finished
+            _stop = true;
+            _thread.join();
+            _stop = false;
         }
-
-        _stop = true;
-        _thread.join();
-        _stop = false;
-
-        _automaticReconnection = automaticReconnection;
     }
 
     WebSocketInitResult WebSocket::connect(int timeoutSecs)
@@ -170,16 +178,18 @@ namespace ix
                           _pingTimeoutSecs);
         }
 
-        WebSocketInitResult status = _ws.connectToUrl(_url, timeoutSecs);
+        WebSocketInitResult status = _ws.connectToUrl(_url, _extraHeaders, timeoutSecs);
         if (!status.success)
         {
             return status;
         }
 
-        _onMessageCallback(WebSocket_MessageType_Open, "", 0,
-                           WebSocketErrorInfo(),
-                           WebSocketOpenInfo(status.uri, status.headers),
-                           WebSocketCloseInfo());
+        _onMessageCallback(
+            std::make_shared<WebSocketMessage>(
+                WebSocketMessageType::Open, "", 0,
+                WebSocketErrorInfo(),
+                WebSocketOpenInfo(status.uri, status.headers),
+                WebSocketCloseInfo()));
         return status;
     }
 
@@ -199,84 +209,84 @@ namespace ix
             return status;
         }
 
-        _onMessageCallback(WebSocket_MessageType_Open, "", 0,
-                           WebSocketErrorInfo(),
-                           WebSocketOpenInfo(status.uri, status.headers),
-                           WebSocketCloseInfo());
+        _onMessageCallback(
+                std::make_shared<WebSocketMessage>(
+                    WebSocketMessageType::Open, "", 0,
+                    WebSocketErrorInfo(),
+                    WebSocketOpenInfo(status.uri, status.headers),
+                    WebSocketCloseInfo()));
         return status;
     }
 
     bool WebSocket::isConnected() const
     {
-        return getReadyState() == WebSocket_ReadyState_Open;
+        return getReadyState() == ReadyState::Open;
     }
 
     bool WebSocket::isClosing() const
     {
-        return getReadyState() == WebSocket_ReadyState_Closing;
+        return getReadyState() == ReadyState::Closing;
     }
 
-    void WebSocket::close()
+    void WebSocket::close(uint16_t code,
+                          const std::string& reason)
     {
-        _ws.close();
+        _ws.close(code, reason);
     }
 
-    void WebSocket::reconnectPerpetuallyIfDisconnected()
+    void WebSocket::checkConnection(bool firstConnectionAttempt)
     {
-        uint64_t retries = 0;
-        WebSocketErrorInfo connectErr;
-        ix::WebSocketInitResult status;
         using millis = std::chrono::duration<double, std::milli>;
-        millis duration;
 
-        // Try to connect only once when we don't have automaticReconnection setup
-        if (!isConnected() && !isClosing() && !_stop && !_automaticReconnection)
+        uint32_t retries = 0;
+        millis duration(0);
+
+        // Try to connect perpertually
+        while (true)
         {
-            status = connect(_handshakeTimeoutSecs);
+            if (isConnected() || isClosing() || _stop)
+            {
+                break;
+            }
+
+            if (!firstConnectionAttempt && !_automaticReconnection)
+            {
+                // Do not attempt to reconnect
+                break;
+            }
+
+            firstConnectionAttempt = false;
+
+            // Only sleep if we are retrying
+            if (duration.count() > 0)
+            {
+                // to do: make sleeping conditional
+                std::this_thread::sleep_for(duration);
+            }
+
+            // Try to connect synchronously
+            ix::WebSocketInitResult status = connect(_handshakeTimeoutSecs);
 
             if (!status.success)
             {
-                duration = millis(calculateRetryWaitMilliseconds(retries++));
+                WebSocketErrorInfo connectErr;
 
-                connectErr.retries = retries;
-                connectErr.wait_time = duration.count();
-                connectErr.reason = status.errorStr;
-                connectErr.http_status = status.http_status;
-                _onMessageCallback(WebSocket_MessageType_Error, "", 0,
-                                   connectErr, WebSocketOpenInfo(),
-                                   WebSocketCloseInfo());
-            }
-        }
-        else
-        {
-            // Otherwise try to reconnect perpertually
-            while (true)
-            {
-                if (isConnected() || isClosing() || _stop || !_automaticReconnection)
+                if (_automaticReconnection)
                 {
-                    break;
-                }
+                    duration = millis(calculateRetryWaitMilliseconds(retries++, _maxWaitBetweenReconnectionRetries));
 
-                status = connect(_handshakeTimeoutSecs);
-
-                if (!status.success)
-                {
-                    duration = millis(calculateRetryWaitMilliseconds(retries++));
-
-                    connectErr.retries = retries;
                     connectErr.wait_time = duration.count();
-                    connectErr.reason = status.errorStr;
-                    connectErr.http_status = status.http_status;
-                    _onMessageCallback(WebSocket_MessageType_Error, "", 0,
-                                       connectErr, WebSocketOpenInfo(),
-                                       WebSocketCloseInfo());
-
-                    // Only sleep if we aren't in the middle of stopping
-                    if (!_stop)
-                    {
-                        std::this_thread::sleep_for(duration);
-                    }
+                    connectErr.retries = retries;
                 }
+
+                connectErr.reason      = status.errorStr;
+                connectErr.http_status = status.http_status;
+
+                _onMessageCallback(
+                     std::make_shared<WebSocketMessage>(
+                        WebSocketMessageType::Error, "", 0,
+                        connectErr, WebSocketOpenInfo(),
+                        WebSocketCloseInfo()));
             }
         }
     }
@@ -285,22 +295,30 @@ namespace ix
     {
         setThreadName(getUrl());
 
+        bool firstConnectionAttempt = true;
+
         while (true)
         {
-            if (_stop) return;
-
             // 1. Make sure we are always connected
-            reconnectPerpetuallyIfDisconnected();
+            checkConnection(firstConnectionAttempt);
 
-            if (_stop) return;
+            firstConnectionAttempt = false;
+
+            // if here we are closed then checkConnection was not able to connect
+            if (getReadyState() == ReadyState::Closed)
+            {
+                break;
+            }
+
+            // We can avoid to poll if we want to stop and are not closing
+            if (_stop && !isClosing()) break;
 
             // 2. Poll to see if there's any new data available
-            _ws.poll();
-
-            if (_stop) return;
+            WebSocketTransport::PollResult pollResult = _ws.poll();
 
             // 3. Dispatch the incoming messages
             _ws.dispatch(
+                pollResult,
                 [this](const std::string& msg,
                        size_t wireSize,
                        bool decompressionError,
@@ -309,39 +327,41 @@ namespace ix
                     WebSocketMessageType webSocketMessageType;
                     switch (messageKind)
                     {
-                        case WebSocketTransport::MSG:
+                        case WebSocketTransport::MessageKind::MSG_TEXT:
+                        case WebSocketTransport::MessageKind::MSG_BINARY:
                         {
-                            webSocketMessageType = WebSocket_MessageType_Message;
+                            webSocketMessageType = WebSocketMessageType::Message;
                         } break;
 
-                        case WebSocketTransport::PING:
+                        case WebSocketTransport::MessageKind::PING:
                         {
-                            webSocketMessageType = WebSocket_MessageType_Ping;
+                            webSocketMessageType = WebSocketMessageType::Ping;
                         } break;
 
-                        case WebSocketTransport::PONG:
+                        case WebSocketTransport::MessageKind::PONG:
                         {
-                            webSocketMessageType = WebSocket_MessageType_Pong;
+                            webSocketMessageType = WebSocketMessageType::Pong;
                         } break;
 
-                        case WebSocketTransport::FRAGMENT:
+                        case WebSocketTransport::MessageKind::FRAGMENT:
                         {
-                            webSocketMessageType = WebSocket_MessageType_Fragment;
+                            webSocketMessageType = WebSocketMessageType::Fragment;
                         } break;
                     }
 
                     WebSocketErrorInfo webSocketErrorInfo;
                     webSocketErrorInfo.decompressionError = decompressionError;
 
-                    _onMessageCallback(webSocketMessageType, msg, wireSize,
-                                       webSocketErrorInfo, WebSocketOpenInfo(),
-                                       WebSocketCloseInfo());
+                    bool binary = messageKind == WebSocketTransport::MessageKind::MSG_BINARY;
+
+                    _onMessageCallback(
+                         std::make_shared<WebSocketMessage>(
+                            webSocketMessageType, msg, wireSize,
+                            webSocketErrorInfo, WebSocketOpenInfo(),
+                            WebSocketCloseInfo(), binary));
 
                     WebSocket::invokeTrafficTrackerCallback(msg.size(), true);
                 });
-
-            // If we aren't trying to reconnect automatically, exit if we aren't connected
-            if (!isConnected() && !_automaticReconnection) return;
         }
     }
 
@@ -368,8 +388,15 @@ namespace ix
         }
     }
 
-    WebSocketSendInfo WebSocket::send(const std::string& text,
+    WebSocketSendInfo WebSocket::send(const std::string& data,
+                                      bool binary,
                                       const OnProgressCallback& onProgressCallback)
+    {
+        return (binary) ? sendBinary(data, onProgressCallback) : sendText(data, onProgressCallback);
+    }
+
+    WebSocketSendInfo WebSocket::sendBinary(const std::string& text,
+                                            const OnProgressCallback& onProgressCallback)
     {
         return sendMessage(text, SendMessageKind::Binary, onProgressCallback);
     }
@@ -377,6 +404,12 @@ namespace ix
     WebSocketSendInfo WebSocket::sendText(const std::string& text,
                                           const OnProgressCallback& onProgressCallback)
     {
+        if (!validateUtf8(text))
+        {
+            close(WebSocketCloseConstants::kInvalidFramePayloadData,
+                  WebSocketCloseConstants::kInvalidFramePayloadDataMessage);
+            return false;
+        }
         return sendMessage(text, SendMessageKind::Text, onProgressCallback);
     }
 
@@ -434,11 +467,11 @@ namespace ix
     {
         switch (_ws.getReadyState())
         {
-            case ix::WebSocketTransport::OPEN: return WebSocket_ReadyState_Open;
-            case ix::WebSocketTransport::CONNECTING: return WebSocket_ReadyState_Connecting;
-            case ix::WebSocketTransport::CLOSING: return WebSocket_ReadyState_Closing;
-            case ix::WebSocketTransport::CLOSED: return WebSocket_ReadyState_Closed;
-            default: return WebSocket_ReadyState_Closed;
+            case ix::WebSocketTransport::ReadyState::OPEN      : return ReadyState::Open;
+            case ix::WebSocketTransport::ReadyState::CONNECTING: return ReadyState::Connecting;
+            case ix::WebSocketTransport::ReadyState::CLOSING   : return ReadyState::Closing;
+            case ix::WebSocketTransport::ReadyState::CLOSED    : return ReadyState::Closed;
+            default: return ReadyState::Closed;
         }
     }
 
@@ -446,11 +479,11 @@ namespace ix
     {
         switch (readyState)
         {
-            case WebSocket_ReadyState_Open: return "OPEN";
-            case WebSocket_ReadyState_Connecting: return "CONNECTING";
-            case WebSocket_ReadyState_Closing: return "CLOSING";
-            case WebSocket_ReadyState_Closed: return "CLOSED";
-            default: return "CLOSED";
+            case ReadyState::Open      : return "OPEN";
+            case ReadyState::Connecting: return "CONNECTING";
+            case ReadyState::Closing   : return "CLOSING";
+            case ReadyState::Closed    : return "CLOSED";
+            default: return "UNKNOWN";
         }
     }
 
@@ -464,6 +497,11 @@ namespace ix
         _automaticReconnection = false;
     }
 
+    bool WebSocket::isAutomaticReconnectionEnabled() const
+    {
+        return _automaticReconnection;
+    }
+
     size_t WebSocket::bufferedAmount() const
     {
         return _ws.bufferedAmount();

ixwebsocket/IXWebSocket.h

@@ -9,77 +9,31 @@
 
 #pragma once
 
+#include "IXProgressCallback.h"
+#include "IXWebSocketCloseConstants.h"
+#include "IXWebSocketErrorInfo.h"
+#include "IXWebSocketHttpHeaders.h"
+#include "IXWebSocketMessage.h"
+#include "IXWebSocketPerMessageDeflateOptions.h"
+#include "IXWebSocketSendInfo.h"
+#include "IXWebSocketTransport.h"
+#include <atomic>
+#include <mutex>
 #include <string>
 #include <thread>
-#include <mutex>
-#include <atomic>
-
-#include "IXWebSocketTransport.h"
-#include "IXWebSocketErrorInfo.h"
-#include "IXWebSocketSendInfo.h"
-#include "IXWebSocketPerMessageDeflateOptions.h"
-#include "IXWebSocketHttpHeaders.h"
-#include "IXProgressCallback.h"
 
 namespace ix
 {
     // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#Ready_state_constants
-    enum ReadyState
+    enum class ReadyState
     {
-        WebSocket_ReadyState_Connecting = 0,
-        WebSocket_ReadyState_Open = 1,
-        WebSocket_ReadyState_Closing = 2,
-        WebSocket_ReadyState_Closed = 3
+        Connecting = 0,
+        Open = 1,
+        Closing = 2,
+        Closed = 3
     };
 
-    enum WebSocketMessageType
-    {
-        WebSocket_MessageType_Message = 0,
-        WebSocket_MessageType_Open = 1,
-        WebSocket_MessageType_Close = 2,
-        WebSocket_MessageType_Error = 3,
-        WebSocket_MessageType_Ping = 4,
-        WebSocket_MessageType_Pong = 5,
-        WebSocket_MessageType_Fragment = 6
-    };
-
-    struct WebSocketOpenInfo
-    {
-        std::string uri;
-        WebSocketHttpHeaders headers;
-
-        WebSocketOpenInfo(const std::string& u = std::string(),
-                          const WebSocketHttpHeaders& h = WebSocketHttpHeaders())
-            : uri(u)
-            , headers(h)
-        {
-            ;
-        }
-    };
-
-    struct WebSocketCloseInfo
-    {
-        uint16_t code;
-        std::string reason;
-        bool remote;
-
-        WebSocketCloseInfo(uint16_t c = 0,
-                           const std::string& r = std::string(),
-                           bool rem = false)
-            : code(c)
-            , reason(r)
-            , remote(rem)
-        {
-            ;
-        }
-    };
-
-    using OnMessageCallback = std::function<void(WebSocketMessageType,
-                                                 const std::string&,
-                                                 size_t wireSize,
-                                                 const WebSocketErrorInfo&,
-                                                 const WebSocketOpenInfo&,
-                                                 const WebSocketCloseInfo&)>;
+    using OnMessageCallback = std::function<void(const WebSocketMessagePtr&)>;
 
     using OnTrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
 
@@ -90,34 +44,49 @@ namespace ix
         ~WebSocket();
 
         void setUrl(const std::string& url);
-        void setPerMessageDeflateOptions(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
-        void setHandshakeTimeout(int handshakeTimeoutSecs);
+
+        // send extra headers in client handshake request
+        void setExtraHeaders(const WebSocketHttpHeaders& headers);
+        void setPerMessageDeflateOptions(
+            const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
         void setHeartBeatPeriod(int heartBeatPeriodSecs);
         void setPingInterval(int pingIntervalSecs); // alias of setHeartBeatPeriod
         void setPingTimeout(int pingTimeoutSecs);
         void enablePong();
         void disablePong();
+        void disablePerMessageDeflate();
 
         // Run asynchronously, by calling start and stop.
         void start();
-        void stop();
+
+        // stop is synchronous
+        void stop(uint16_t code = WebSocketCloseConstants::kNormalClosureCode,
+                  const std::string& reason = WebSocketCloseConstants::kNormalClosureMessage);
 
         // Run in blocking mode, by connecting first manually, and then calling run.
         WebSocketInitResult connect(int timeoutSecs);
         void run();
 
-        WebSocketSendInfo send(const std::string& text,
+        // send is in binary mode by default
+        WebSocketSendInfo send(const std::string& data,
+                               bool binary = false,
                                const OnProgressCallback& onProgressCallback = nullptr);
+        WebSocketSendInfo sendBinary(const std::string& text,
+                                     const OnProgressCallback& onProgressCallback = nullptr);
         WebSocketSendInfo sendText(const std::string& text,
                                    const OnProgressCallback& onProgressCallback = nullptr);
         WebSocketSendInfo ping(const std::string& text);
-        void close();
+
+        void close(uint16_t code = WebSocketCloseConstants::kNormalClosureCode,
+                   const std::string& reason = WebSocketCloseConstants::kNormalClosureMessage);
 
         void setOnMessageCallback(const OnMessageCallback& callback);
         static void setTrafficTrackerCallback(const OnTrafficTrackerCallback& callback);
         static void resetTrafficTrackerCallback();
 
         ReadyState getReadyState() const;
+        static std::string readyStateToString(ReadyState readyState);
+
         const std::string& getUrl() const;
         const WebSocketPerMessageDeflateOptions& getPerMessageDeflateOptions() const;
         int getHeartBeatPeriod() const;
@@ -127,26 +96,28 @@ namespace ix
 
         void enableAutomaticReconnection();
         void disableAutomaticReconnection();
+        bool isAutomaticReconnectionEnabled() const;
+        void setMaxWaitBetweenReconnectionRetries(uint32_t maxWaitBetweenReconnectionRetries);
+        uint32_t getMaxWaitBetweenReconnectionRetries() const;
 
     private:
-
         WebSocketSendInfo sendMessage(const std::string& text,
                                       SendMessageKind sendMessageKind,
                                       const OnProgressCallback& callback = nullptr);
 
         bool isConnected() const;
         bool isClosing() const;
-        void reconnectPerpetuallyIfDisconnected();
-        std::string readyStateToString(ReadyState readyState);
+        void checkConnection(bool firstConnectionAttempt);
         static void invokeTrafficTrackerCallback(size_t size, bool incoming);
 
         // Server
-        void setSocketFileDescriptor(int fd);
         WebSocketInitResult connectToSocket(int fd, int timeoutSecs);
 
         WebSocketTransport _ws;
 
         std::string _url;
+        WebSocketHttpHeaders _extraHeaders;
+
         WebSocketPerMessageDeflateOptions _perMessageDeflateOptions;
         mutable std::mutex _configMutex; // protect all config variables access
 
@@ -154,10 +125,14 @@ namespace ix
         static OnTrafficTrackerCallback _onTrafficTrackerCallback;
 
         std::atomic<bool> _stop;
-        std::atomic<bool> _automaticReconnection;
         std::thread _thread;
         std::mutex _writeMutex;
 
+        // Automatic reconnection
+        std::atomic<bool> _automaticReconnection;
+        static const uint32_t kDefaultMaxWaitBetweenReconnectionRetries;
+        uint32_t _maxWaitBetweenReconnectionRetries;
+
         std::atomic<int> _handshakeTimeoutSecs;
         static const int kDefaultHandShakeTimeoutSecs;
 
@@ -165,7 +140,7 @@ namespace ix
         bool _enablePong;
         static const bool kDefaultEnablePong;
 
-        // Optional ping and ping timeout
+        // Optional ping and pong timeout
         int _pingIntervalSecs;
         int _pingTimeoutSecs;
         static const int kDefaultPingIntervalSecs;
@@ -173,4 +148,4 @@ namespace ix
 
         friend class WebSocketServer;
     };
-}
+} // namespace ix

ixwebsocket/IXWebSocketCloseConstants.cpp

@@ -0,0 +1,31 @@
+/*
+ *  IXWebSocketCloseConstants.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXWebSocketCloseConstants.h"
+
+namespace ix
+{
+    const uint16_t WebSocketCloseConstants::kNormalClosureCode(1000);
+    const uint16_t WebSocketCloseConstants::kInternalErrorCode(1011);
+    const uint16_t WebSocketCloseConstants::kAbnormalCloseCode(1006);
+    const uint16_t WebSocketCloseConstants::kInvalidFramePayloadData(1007);
+    const uint16_t WebSocketCloseConstants::kProtocolErrorCode(1002);
+    const uint16_t WebSocketCloseConstants::kNoStatusCodeErrorCode(1005);
+
+    const std::string WebSocketCloseConstants::kNormalClosureMessage("Normal closure");
+    const std::string WebSocketCloseConstants::kInternalErrorMessage("Internal error");
+    const std::string WebSocketCloseConstants::kAbnormalCloseMessage("Abnormal closure");
+    const std::string WebSocketCloseConstants::kPingTimeoutMessage("Ping timeout");
+    const std::string WebSocketCloseConstants::kProtocolErrorMessage("Protocol error");
+    const std::string WebSocketCloseConstants::kNoStatusCodeErrorMessage("No status code");
+    const std::string WebSocketCloseConstants::kProtocolErrorReservedBitUsed("Reserved bit used");
+    const std::string WebSocketCloseConstants::kProtocolErrorPingPayloadOversized("Ping reason control frame with payload length > 125 octets");
+    const std::string WebSocketCloseConstants::kProtocolErrorCodeControlMessageFragmented("Control message fragmented");
+    const std::string WebSocketCloseConstants::kProtocolErrorCodeDataOpcodeOutOfSequence("Fragmentation: data message out of sequence");
+    const std::string WebSocketCloseConstants::kProtocolErrorCodeContinuationOpCodeOutOfSequence("Fragmentation: continuation opcode out of sequence");
+    const std::string WebSocketCloseConstants::kInvalidFramePayloadDataMessage("Invalid frame payload data");
+    const std::string WebSocketCloseConstants::kInvalidCloseCodeMessage("Invalid close code");
+}

ixwebsocket/IXWebSocketCloseConstants.h

@@ -0,0 +1,37 @@
+/*
+ *  IXWebSocketCloseConstants.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <cstdint>
+#include <string>
+
+namespace ix
+{
+    struct WebSocketCloseConstants
+    {
+        static const uint16_t kNormalClosureCode;
+        static const uint16_t kInternalErrorCode;
+        static const uint16_t kAbnormalCloseCode;
+        static const uint16_t kProtocolErrorCode;
+        static const uint16_t kNoStatusCodeErrorCode;
+        static const uint16_t kInvalidFramePayloadData;
+
+        static const std::string kNormalClosureMessage;
+        static const std::string kInternalErrorMessage;
+        static const std::string kAbnormalCloseMessage;
+        static const std::string kPingTimeoutMessage;
+        static const std::string kProtocolErrorMessage;
+        static const std::string kNoStatusCodeErrorMessage;
+        static const std::string kProtocolErrorReservedBitUsed;
+        static const std::string kProtocolErrorPingPayloadOversized;
+        static const std::string kProtocolErrorCodeControlMessageFragmented;
+        static const std::string kProtocolErrorCodeDataOpcodeOutOfSequence;
+        static const std::string kProtocolErrorCodeContinuationOpCodeOutOfSequence;
+        static const std::string kInvalidFramePayloadDataMessage;
+        static const std::string kInvalidCloseCodeMessage;
+    };
+} // namespace ix

ixwebsocket/IXWebSocketCloseInfo.h

@@ -0,0 +1,25 @@
+/*
+ *  IXWebSocketCloseInfo.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+namespace ix
+{
+    struct WebSocketCloseInfo
+    {
+        uint16_t code;
+        std::string reason;
+        bool remote;
+
+        WebSocketCloseInfo(uint16_t c = 0, const std::string& r = std::string(), bool rem = false)
+            : code(c)
+            , reason(r)
+            , remote(rem)
+        {
+            ;
+        }
+    };
+} // namespace ix

ixwebsocket/IXWebSocketErrorInfo.h

@@ -12,10 +12,10 @@ namespace ix
 {
     struct WebSocketErrorInfo
     {
-        uint64_t retries;
-        double wait_time;
-        int http_status;
+        uint32_t retries = 0;
+        double wait_time = 0;
+        int http_status = 0;
         std::string reason;
-        bool decompressionError;
+        bool decompressionError = false;
     };
-}
+} // namespace ix

ixwebsocket/IXWebSocketHandshake.cpp

@@ -7,10 +7,11 @@
 #include "IXWebSocketHandshake.h"
 #include "IXSocketConnect.h"
 #include "IXUrlParser.h"
+#include "IXHttp.h"
+#include "IXUserAgent.h"
 
 #include "libwshandshake.hpp"
 
-#include <iostream>
 #include <sstream>
 #include <random>
 #include <algorithm>
@@ -32,15 +33,6 @@ namespace ix
 
     }
 
-    std::string WebSocketHandshake::trim(const std::string& str)
-    {
-        std::string out(str);
-        out.erase(std::remove(out.begin(), out.end(), ' '), out.end());
-        out.erase(std::remove(out.begin(), out.end(), '\r'), out.end());
-        out.erase(std::remove(out.begin(), out.end(), '\n'), out.end());
-        return out;
-    }
-
     bool WebSocketHandshake::insensitiveStringCompare(const std::string& a, const std::string& b)
     {
         return std::equal(a.begin(), a.end(),
@@ -51,40 +43,6 @@ namespace ix
                           });
     }
 
-    std::tuple<std::string, std::string, std::string> WebSocketHandshake::parseRequestLine(const std::string& line)
-    {
-        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
-        std::string token;
-        std::stringstream tokenStream(line);
-        std::vector<std::string> tokens;
-
-        // Split by ' '
-        while (std::getline(tokenStream, token, ' '))
-        {
-            tokens.push_back(token);
-        }
-
-        std::string method;
-        if (tokens.size() >= 1)
-        {
-            method = trim(tokens[0]);
-        }
-
-        std::string requestUri;
-        if (tokens.size() >= 2)
-        {
-            requestUri = trim(tokens[1]);
-        }
-
-        std::string httpVersion;
-        if (tokens.size() >= 3)
-        {
-            httpVersion = trim(tokens[2]);
-        }
-
-        return std::make_tuple(method, requestUri, httpVersion);
-    }
-
     std::string WebSocketHandshake::genRandomString(const int len)
     {
         std::string alphanum =
@@ -131,6 +89,7 @@ namespace ix
     }
 
     WebSocketInitResult WebSocketHandshake::clientHandshake(const std::string& url,
+                                                            const WebSocketHttpHeaders& extraHeaders,
                                                             const std::string& host,
                                                             const std::string& path,
                                                             int port,
@@ -170,6 +129,17 @@ namespace ix
         ss << "Sec-WebSocket-Version: 13\r\n";
         ss << "Sec-WebSocket-Key: " << secWebSocketKey << "\r\n";
 
+        // User-Agent can be customized by users
+        if (extraHeaders.find("User-Agent") == extraHeaders.end())
+        {
+            ss << "User-Agent: " << userAgent() << "\r\n";
+        }
+
+        for (auto& it : extraHeaders)
+        {
+            ss << it.first << ":" << it.second << "\r\n";
+        }
+
         if (_enablePerMessageDeflate)
         {
             ss << _perMessageDeflateOptions.generateHeader();
@@ -194,23 +164,26 @@ namespace ix
         }
 
         // Validate status
-        int status;
+        auto statusLine = Http::parseStatusLine(line);
+        std::string httpVersion = statusLine.first;
+        int status = statusLine.second;
 
         // HTTP/1.0 is too old.
-        if (sscanf(line.c_str(), "HTTP/1.0 %d", &status) == 1)
+        if (httpVersion != "HTTP/1.1")
         {
             std::stringstream ss;
-            ss << "Server version is HTTP/1.0. Rejecting connection to " << host
+            ss << "Expecting HTTP/1.1, got " << httpVersion << ". "
+               << "Rejecting connection to " << host << ":" << port
                << ", status: " << status
                << ", HTTP Status line: " << line;
             return WebSocketInitResult(false, status, ss.str());
         }
 
         // We want an 101 HTTP status
-        if (sscanf(line.c_str(), "HTTP/1.1 %d", &status) != 1 || status != 101)
+        if (status != 101)
         {
             std::stringstream ss;
-            ss << "Got bad status connecting to " << host
+            ss << "Got bad status connecting to " << host << ":" << port
                << ", status: " << status
                << ", HTTP Status line: " << line;
             return WebSocketInitResult(false, status, ss.str());
@@ -243,7 +216,7 @@ namespace ix
         }
 
         char output[29] = {};
-        WebSocketHandshakeKeyGen::generate(secWebSocketKey.c_str(), output);
+        WebSocketHandshakeKeyGen::generate(secWebSocketKey, output);
         if (std::string(output) != headers["sec-websocket-accept"])
         {
             std::string errorMsg("Invalid Sec-WebSocket-Accept value");
@@ -265,7 +238,7 @@ namespace ix
             else if (!_perMessageDeflate.init(webSocketPerMessageDeflateOptions))
             {
                 return WebSocketInitResult(
-                    false, 0,"Failed to initialize per message deflate engine");
+                    false, 0, "Failed to initialize per message deflate engine");
             }
         }
 
@@ -295,7 +268,7 @@ namespace ix
         }
 
         // Validate request line (GET /foo HTTP/1.1\r\n)
-        auto requestLine = parseRequestLine(line);
+        auto requestLine = Http::parseRequestLine(line);
         auto method      = std::get<0>(requestLine);
         auto uri         = std::get<1>(requestLine);
         auto httpVersion = std::get<2>(requestLine);
@@ -325,9 +298,15 @@ namespace ix
             return sendErrorResponse(400, "Missing Sec-WebSocket-Key value");
         }
 
-        if (headers["upgrade"] != "websocket")
+        if (headers.find("upgrade") == headers.end())
         {
-            return sendErrorResponse(400, "Invalid or missing Upgrade header");
+            return sendErrorResponse(400, "Missing Upgrade header");
+        }
+
+        if (!insensitiveStringCompare(headers["upgrade"], "WebSocket"))
+        {
+            return sendErrorResponse(400, "Invalid Upgrade header, "
+                                          "need WebSocket, got " + headers["upgrade"]);
         }
 
         if (headers.find("sec-websocket-version") == headers.end())
@@ -344,18 +323,19 @@ namespace ix
             if (version != 13)
             {
                 return sendErrorResponse(400, "Invalid Sec-WebSocket-Version, "
-                                              "need 13, got" + ss.str());
+                                              "need 13, got " + ss.str());
             }
         }
 
         char output[29] = {};
-        WebSocketHandshakeKeyGen::generate(headers["sec-websocket-key"].c_str(), output);
+        WebSocketHandshakeKeyGen::generate(headers["sec-websocket-key"], output);
 
         std::stringstream ss;
         ss << "HTTP/1.1 101 Switching Protocols\r\n";
         ss << "Sec-WebSocket-Accept: " << std::string(output) << "\r\n";
         ss << "Upgrade: websocket\r\n";
         ss << "Connection: Upgrade\r\n";
+        ss << "Server: " << userAgent() << "\r\n";
 
         // Parse the client headers. Does it support deflate ?
         std::string header = headers["sec-websocket-extensions"];

ixwebsocket/IXWebSocketHandshake.h

@@ -7,16 +7,14 @@
 #pragma once
 
 #include "IXCancellationRequest.h"
+#include "IXSocket.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXWebSocketPerMessageDeflate.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
-#include "IXSocket.h"
-
-#include <string>
 #include <atomic>
 #include <chrono>
 #include <memory>
-#include <tuple>
+#include <string>
 
 namespace ix
 {
@@ -42,7 +40,8 @@ namespace ix
         }
     };
 
-    class WebSocketHandshake {
+    class WebSocketHandshake
+    {
     public:
         WebSocketHandshake(std::atomic<bool>& requestInitCancellation,
                            std::shared_ptr<Socket> _socket,
@@ -50,14 +49,15 @@ namespace ix
                            WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
                            std::atomic<bool>& enablePerMessageDeflate);
 
-        WebSocketInitResult clientHandshake(const std::string& url,
-                                            const std::string& host,
-                                            const std::string& path,
-                                            int port,
-                                            int timeoutSecs);
+        WebSocketInitResult clientHandshake(
+            const std::string& url,
+            const WebSocketHttpHeaders& extraHeaders,
+            const std::string& host,
+            const std::string& path,
+            int port,
+            int timeoutSecs);
 
-        WebSocketInitResult serverHandshake(int fd,
-                                            int timeoutSecs);
+        WebSocketInitResult serverHandshake(int fd, int timeoutSecs);
 
     private:
         std::string genRandomString(const int len);
@@ -65,8 +65,6 @@ namespace ix
         // Parse HTTP headers
         WebSocketInitResult sendErrorResponse(int code, const std::string& reason);
 
-        std::tuple<std::string, std::string, std::string> parseRequestLine(const std::string& line);
-        std::string trim(const std::string& str);
         bool insensitiveStringCompare(const std::string& a, const std::string& b);
 
         std::atomic<bool>& _requestInitCancellation;
@@ -75,4 +73,4 @@ namespace ix
         WebSocketPerMessageDeflateOptions& _perMessageDeflateOptions;
         std::atomic<bool>& _enablePerMessageDeflate;
     };
-}
+} // namespace ix

ixwebsocket/IXWebSocketHttpHeaders.h

@@ -7,10 +7,9 @@
 #pragma once
 
 #include "IXCancellationRequest.h"
-
-#include <string>
 #include <map>
 #include <memory>
+#include <string>
 
 namespace ix
 {
@@ -21,15 +20,14 @@ namespace ix
         // Case Insensitive compare_less binary function
         struct NocaseCompare
         {
-            bool operator() (const unsigned char& c1, const unsigned char& c2) const;
+            bool operator()(const unsigned char& c1, const unsigned char& c2) const;
         };
 
-        bool operator() (const std::string & s1, const std::string & s2) const;
+        bool operator()(const std::string& s1, const std::string& s2) const;
     };
 
     using WebSocketHttpHeaders = std::map<std::string, std::string, CaseInsensitiveLess>;
 
     std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
-        std::shared_ptr<Socket> socket,
-        const CancellationRequest& isCancellationRequested);
-}
+        std::shared_ptr<Socket> socket, const CancellationRequest& isCancellationRequested);
+} // namespace ix

ixwebsocket/IXWebSocketMessage.h

@@ -0,0 +1,49 @@
+/*
+ *  IXWebSocketMessage.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXWebSocketCloseInfo.h"
+#include "IXWebSocketErrorInfo.h"
+#include "IXWebSocketMessageType.h"
+#include "IXWebSocketOpenInfo.h"
+#include <memory>
+#include <string>
+#include <thread>
+
+namespace ix
+{
+    struct WebSocketMessage
+    {
+        WebSocketMessageType type;
+        std::string str;
+        size_t wireSize;
+        WebSocketErrorInfo errorInfo;
+        WebSocketOpenInfo openInfo;
+        WebSocketCloseInfo closeInfo;
+        bool binary;
+
+        WebSocketMessage(WebSocketMessageType t,
+                         const std::string& s,
+                         size_t w,
+                         WebSocketErrorInfo e,
+                         WebSocketOpenInfo o,
+                         WebSocketCloseInfo c,
+                         bool b = false)
+            : type(t)
+            , str(std::move(s))
+            , wireSize(w)
+            , errorInfo(e)
+            , openInfo(o)
+            , closeInfo(c)
+            , binary(b)
+        {
+            ;
+        }
+    };
+
+    using WebSocketMessagePtr = std::shared_ptr<WebSocketMessage>;
+} // namespace ix

ixwebsocket/IXWebSocketMessageQueue.cpp

@@ -0,0 +1,89 @@
+/*
+ *  IXWebSocketMessageQueue.cpp
+ *  Author: Korchynskyi Dmytro
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXWebSocketMessageQueue.h"
+
+namespace ix
+{
+
+    WebSocketMessageQueue::WebSocketMessageQueue(WebSocket* websocket)
+    {
+        bindWebsocket(websocket);
+    }
+
+    WebSocketMessageQueue::~WebSocketMessageQueue()
+    {
+        if (!_messages.empty())
+        {
+            // not handled all messages
+        }
+
+        bindWebsocket(nullptr);
+    }
+
+    void WebSocketMessageQueue::bindWebsocket(WebSocket * websocket)
+    {
+        if (_websocket == websocket) return;
+
+        // unbind old
+        if (_websocket)
+        {
+            // set dummy callback just to avoid crash
+            _websocket->setOnMessageCallback([](const WebSocketMessagePtr&) {});
+        }
+
+        _websocket = websocket;
+
+        // bind new
+        if (_websocket)
+        {
+            _websocket->setOnMessageCallback([this](const WebSocketMessagePtr& msg)
+            {
+                std::lock_guard<std::mutex> lock(_messagesMutex);
+                _messages.emplace_back(std::move(msg));
+            });
+        }
+    }
+
+    void WebSocketMessageQueue::setOnMessageCallback(const OnMessageCallback& callback)
+    {
+        _onMessageUserCallback = callback;
+    }
+
+    void WebSocketMessageQueue::setOnMessageCallback(OnMessageCallback&& callback)
+    {
+        _onMessageUserCallback = std::move(callback);
+    }
+
+    WebSocketMessagePtr WebSocketMessageQueue::popMessage()
+    {
+        WebSocketMessagePtr message;
+        std::lock_guard<std::mutex> lock(_messagesMutex);
+
+        if (!_messages.empty())
+        {
+            message = std::move(_messages.front());
+            _messages.pop_front();
+        }
+
+        return message;
+    }
+
+    void WebSocketMessageQueue::poll(int count)
+    {
+        if (!_onMessageUserCallback)
+            return;
+
+        WebSocketMessagePtr message;
+
+        while (count > 0 && (message = popMessage()))
+        {
+            _onMessageUserCallback(message);
+            --count;
+        }
+    }
+
+}

ixwebsocket/IXWebSocketMessageQueue.h

@@ -0,0 +1,41 @@
+/*
+ *  IXWebSocketMessageQueue.h
+ *  Author: Korchynskyi Dmytro
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXWebSocket.h"
+#include <list>
+#include <memory>
+#include <thread>
+
+namespace ix
+{
+    //
+    // A helper class to dispatch websocket message callbacks in your thread.
+    //
+    class WebSocketMessageQueue
+    {
+    public:
+        WebSocketMessageQueue(WebSocket* websocket = nullptr);
+        ~WebSocketMessageQueue();
+
+        void bindWebsocket(WebSocket* websocket);
+
+        void setOnMessageCallback(const OnMessageCallback& callback);
+        void setOnMessageCallback(OnMessageCallback&& callback);
+
+        void poll(int count = 512);
+
+    protected:
+        WebSocketMessagePtr popMessage();
+
+    private:
+        WebSocket* _websocket = nullptr;
+        OnMessageCallback _onMessageUserCallback;
+        std::mutex _messagesMutex;
+        std::list<WebSocketMessagePtr> _messages;
+    };
+} // namespace ix

ixwebsocket/IXWebSocketMessageType.h

@@ -0,0 +1,21 @@
+/*
+ *  IXWebSocketMessageType.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+namespace ix
+{
+    enum class WebSocketMessageType
+    {
+        Message = 0,
+        Open = 1,
+        Close = 2,
+        Error = 3,
+        Ping = 4,
+        Pong = 5,
+        Fragment = 6
+    };
+}

ixwebsocket/IXWebSocketOpenInfo.h

@@ -0,0 +1,24 @@
+/*
+ *  IXWebSocketOpenInfo.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+namespace ix
+{
+    struct WebSocketOpenInfo
+    {
+        std::string uri;
+        WebSocketHttpHeaders headers;
+
+        WebSocketOpenInfo(const std::string& u = std::string(),
+                          const WebSocketHttpHeaders& h = WebSocketHttpHeaders())
+            : uri(u)
+            , headers(h)
+        {
+            ;
+        }
+    };
+} // namespace ix

ixwebsocket/IXWebSocketPerMessageDeflate.h

@@ -34,8 +34,8 @@
 
 #pragma once
 
-#include <string>
 #include <memory>
+#include <string>
 
 namespace ix
 {
@@ -57,4 +57,4 @@ namespace ix
         std::unique_ptr<WebSocketPerMessageDeflateCompressor> _compressor;
         std::unique_ptr<WebSocketPerMessageDeflateDecompressor> _decompressor;
     };
-}
+} // namespace ix

ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp

@@ -7,7 +7,6 @@
 #include "IXWebSocketPerMessageDeflateCodec.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 
-#include <iostream>
 #include <cassert>
 #include <string.h>
 

ixwebsocket/IXWebSocketPerMessageDeflateCodec.h

@@ -7,8 +7,8 @@
 #pragma once
 
 #include "zlib.h"
-#include <string>
 #include <memory>
+#include <string>
 
 namespace ix
 {
@@ -46,5 +46,4 @@ namespace ix
         z_stream _inflateState;
     };
 
-}
-
+} // namespace ix

ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp

@@ -7,7 +7,6 @@
 #include "IXWebSocketPerMessageDeflateOptions.h"
 
 #include <sstream>
-#include <iostream>
 #include <algorithm>
 #include <cctype>
 
@@ -34,6 +33,8 @@ namespace ix
         _serverNoContextTakeover = serverNoContextTakeover;
         _clientMaxWindowBits = clientMaxWindowBits;
         _serverMaxWindowBits = serverMaxWindowBits;
+
+        sanitizeClientMaxWindowBits();
     }
 
     //
@@ -108,10 +109,22 @@ namespace ix
                 _clientMaxWindowBits =
                     std::min(maxClientMaxWindowBits,
                         std::max(x, minClientMaxWindowBits));
+
+                sanitizeClientMaxWindowBits();
             }
         }
     }
 
+    void WebSocketPerMessageDeflateOptions::sanitizeClientMaxWindowBits()
+    {
+        // zlib/deflate has a bug with windowsbits == 8, so we silently upgrade it to 9
+        // See https://bugs.chromium.org/p/chromium/issues/detail?id=691074
+        if (_clientMaxWindowBits == 8)
+        {
+            _clientMaxWindowBits = 9;
+        }
+    }
+
     std::string WebSocketPerMessageDeflateOptions::generateHeader()
     {
         std::stringstream ss;