Ping and Pong messages cannot be fragmented (autobahn test: 5.1 and 5.2 Fragmentation)

+ws autobahn / Add code to test websocket client compliance with the autobahn test-suite
+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).

.clang-format

@@ -0,0 +1,46 @@
+# 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: InlineOnly
+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
+Standard: Cpp11
+UseTab: Never

.dockerignore

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

.gitignore

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

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+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
+
+-   repo: https://github.com/pocc/pre-commit-hooks
+    rev: ''
+    hooks:
+    -   id: clang-format

.travis.yml

@@ -1,17 +1,56 @@
-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 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
+      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,6 +4,8 @@
 #
 
 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)
@@ -15,51 +17,86 @@ if (NOT WIN32)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 
+if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wshorten-64-to-32")
+endif()
+
 set( IXWEBSOCKET_SOURCES
-    ixwebsocket/IXEventFd.cpp
+    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/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
 )
 
 set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXEventFd.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/IXSocketServer.h
     ixwebsocket/IXSocketConnect.h
     ixwebsocket/IXSocketFactory.h
-    ixwebsocket/IXSetThreadName.h
-    ixwebsocket/IXDNSLookup.h
-    ixwebsocket/IXCancellationRequest.h
-    ixwebsocket/IXProgressCallback.h
+    ixwebsocket/IXSocketServer.h
+    ixwebsocket/IXUrlParser.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/IXWebSocketSendInfo.h
+    ixwebsocket/IXWebSocketServer.h
+    ixwebsocket/IXWebSocketTransport.h
+    ixwebsocket/IXWebSocketVersion.h
+    ixwebsocket/LUrlParser.h
     ixwebsocket/libwshandshake.hpp
-    ixwebsocket/IXHttpClient.h
-    ixwebsocket/IXUrlParser.h
 )
 
+if (UNIX)
+    # Linux, Mac, iOS, Android
+    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptPipe.cpp )
+    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptPipe.h )
+endif()
+
 # Platform specific code
 if (APPLE)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/apple/IXSetThreadName_apple.cpp)
@@ -67,18 +104,31 @@ elseif (WIN32)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
 else()
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/linux/IXSetThreadName_linux.cpp)
+    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptEventFd.cpp)
+    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)
+        add_definitions(-DIXWEBSOCKET_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)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketSChannel.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketSChannel.cpp)
     else()
+        add_definitions(-DIXWEBSOCKET_USE_OPEN_SSL)
+        set(USE_OPEN_SSL TRUE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketOpenSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketOpenSSL.cpp)
     endif()
@@ -89,37 +139,70 @@ add_library( ixwebsocket STATIC
     ${IXWEBSOCKET_HEADERS}
 )
 
-# gcc/Linux needs -pthread
-find_package(Threads)
+if (APPLE AND USE_TLS AND NOT USE_MBED_TLS)
+  target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
+endif()
 
-if(UNIX AND NOT APPLE)
+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})
   include_directories(${OPENSSL_INCLUDE_DIR})
+  target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
 endif()
 
-if (WIN32)
-  get_filename_component(libz_path
-    ${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/release_dynamic/x64/lib/zlib.lib
-    ABSOLUTE)
-  add_library(libz STATIC IMPORTED)
-  set_target_properties(libz PROPERTIES IMPORTED_LOCATION
-    ${libz_path})
+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)
 
-  include_directories(${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/include)
+    target_link_libraries(ixwebsocket mbedtls)
+  else()
+    find_package(MbedTLS REQUIRED)
+    include_directories(${MBEDTLS_INCLUDE_DIRS})
+    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
+  endif()
+endif()
 
-  target_link_libraries(ixwebsocket libz wsock32 ws2_32)
-  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-  
+find_package(ZLIB)
+if (ZLIB_FOUND)
+  include_directories(${ZLIB_INCLUDE_DIRS})
+  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
 else()
-  target_link_libraries(ixwebsocket 
-    z ${OPENSSL_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+  add_subdirectory(third_party/zlib)
+  include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
+  target_link_libraries(ixwebsocket zlibstatic)
 endif()
 
 set( IXWEBSOCKET_INCLUDE_DIRS
     .
-    ../../shared/OpenSSL/include)
-target_include_directories( ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS} )
+)
 
-add_subdirectory(ws)
+if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+    # Build with Multiple Processes
+    target_compile_options(ixwebsocket PRIVATE /MP)
+endif()
+
+target_include_directories(ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS})
+
+set_target_properties(ixwebsocket PROPERTIES PUBLIC_HEADER "${IXWEBSOCKET_HEADERS}")
+
+install(TARGETS ixwebsocket
+        ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
+        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/
+)
+
+if (USE_WS)
+    add_subdirectory(ws)
+endif()

DOCKER_VERSION

@@ -0,0 +1 @@
+5.1.1

Dockerfile

@@ -1,31 +0,0 @@
-FROM debian:stretch
-
-ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update 
-RUN apt-get -y install g++ 
-RUN apt-get -y install libssl-dev
-RUN apt-get -y install gdb
-RUN apt-get -y install screen
-RUN apt-get -y install procps
-RUN apt-get -y install lsof
-RUN apt-get -y install libz-dev
-RUN apt-get -y install vim
-RUN apt-get -y install make
-RUN apt-get -y install cmake
-RUN apt-get -y install curl
-RUN apt-get -y install python
-RUN apt-get -y install netcat
-
-# debian strech cmake is too old for building with Docker
-COPY makefile .
-RUN ["make", "install_cmake_for_linux"]
-
-COPY . .
-
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-rc4-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-# RUN ["make"]
-
-EXPOSE 8765
-CMD ["/ws/ws", "transfer", "--port", "8765", "--host", "0.0.0.0"]

Dockerfile

@@ -0,0 +1 @@
+docker/Dockerfile.alpine

README.md

@@ -1,387 +1,13 @@
-# General
+## Hello world
 
-![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
+![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
-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 
+Interested ? Go read the [docs](https://bsergean.github.io/IXWebSocket/site/) ! 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::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
-    {
-        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
-webSocket.send("hello world");
-
-// ... 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<ix::WebSocket> webSocket)
-    {
-        webSocket->setOnMessageCallback(
-            [webSocket, &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;
-
-                    // 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 = parseHeaders(headersData);
-
-// 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.
-
-There is a Dockerfile for running some code on Linux, and a unittest which can be executed by typing `make test`.
-
-You can build and install the ws command line tool with Homebrew.
-
-```
-brew create --cmake https://github.com/machinezone/IXWebSocket/archive/v1.1.0.tar.gz
-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 500M were sent and received succesfully.
-
-## Limitations
-
-* There is no text support for sending data, only the binary protocol is supported. Sending json or text over the binary protocol works well.
-* 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::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
-    {
-        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::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
-    {
-        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::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
-    {
-        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 not any traffic to make sure that load balancers do not kill an
-idle connection.
-
-```
-webSocket.setHeartBeatPeriod(45);
-```
+IXWebSocket is not yet autobahn compliant, but we are working on changing this. See the current compliance [test results](https://bsergean.github.io/IXWebSocket/autobahn/index.html).

appveyor.yml

@@ -1,10 +1,14 @@
 image:
 - Visual Studio 2017
-- Ubuntu
 
 install:
 - ls -al
 - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
-- python test/run.py
+- cd test
+- mkdir build
+- cd build
+- cmake -G"NMake Makefiles" ..
+- nmake
+- ixwebsocket_unittest.exe
 
 build: off

docker-compose.yml

@@ -0,0 +1,43 @@
+version: "3"
+services:
+  snake:
+    image: bsergean/ws:build
+    entrypoint: ws snake --port 8765 --host 0.0.0.0 --redis_hosts redis1
+    ports:
+      - "8765:8765"
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
+
+  ws:
+    security_opt:
+    - seccomp:unconfined
+    cap_add:
+    - SYS_PTRACE
+    stdin_open: true
+    tty: true
+    image: bsergean/ws:build
+    entrypoint: bash
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
+
+  redis1:
+    image: redis:alpine
+    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.debian

@@ -0,0 +1,52 @@
+# Build time
+FROM debian:buster 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
+
+COPY . .
+
+ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
+ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
+
+RUN ["make"]
+
+# Runtime
+FROM debian:buster as runtime
+
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update 
+# Runtime 
+RUN apt-get install -y libssl1.1 
+RUN apt-get install -y ca-certificates
+RUN ["update-ca-certificates"]
+
+# Debugging
+RUN apt-get install -y strace
+RUN apt-get install -y procps
+RUN apt-get install -y htop
+
+RUN adduser --disabled-password --gecos '' 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
+
+COPY --chown=app:app ws/snake/appsConfig.json .
+COPY --chown=app:app ws/cobraMetricsSample.json .
+
+ENTRYPOINT ["ws"]
+CMD ["--help"]

docker/Dockerfile.fedora

@@ -0,0 +1,43 @@
+FROM fedora:30 as build
+
+RUN yum install -y gcc-g++
+RUN yum install -y cmake
+RUN yum install -y make
+RUN yum install -y openssl-devel
+
+RUN yum install -y 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
+
+ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
+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"]
+RUN ["make"]
+
+# Runtime
+FROM fedora:30 as runtime
+
+RUN yum install -y libtsan
+
+RUN groupadd app && useradd -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
+
+COPY --chown=app:app ws/snake/appsConfig.json .
+COPY --chown=app:app ws/cobraMetricsSample.json .
+
+ENTRYPOINT ["ws"]
+CMD ["--help"]

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"]

docker/Dockerfile.ubuntu_xenial

@@ -0,0 +1,24 @@
+# Build time
+FROM ubuntu:xenial 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"]
+RUN ["make", "test"]

docs/CHANGELOG.md

@@ -0,0 +1,93 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## [5.1.2] - 2019-09-02
+
+Ping and Pong messages cannot be fragmented (autobahn test: 5.1 and 5.2 Fragmentation)
+
+## [5.1.1] - 2019-09-01
+
+Close connections when reserved bits are used (autobahn test: 3 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,62 @@
+## 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
+
+### 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,78 @@
+## 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.
+* 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.
+|                       |
++-----------------------+
+```
+
+

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.

examples/cobra_publisher/ixcrypto/IXHash.cpp

@@ -1,22 +0,0 @@
-/*
- *  IXHash.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone. All rights reserved.
- */
-
-#include <string>
-
-namespace ix
-{
-    uint64_t djb2Hash(const std::string& data)
-    {
-        uint64_t hashAddress = 5381;
-
-        for (auto& c : data)
-        {
-            hashAddress = ((hashAddress << 5) + hashAddress) + c;
-        }
-
-        return hashAddress;
-    }
-}

examples/cobra_publisher/ixcrypto/IXHash.h

@@ -1,15 +0,0 @@
-/*
- *  IXHash.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-#include <string>
-
-namespace ix
-{
-    uint64_t djb2Hash(const std::string& data);
-}
-

examples/cobra_publisher/ixcrypto/IXUuid.cpp

@@ -1,75 +0,0 @@
-/*
- *  IXUuid.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone. All rights reserved.
- */
-
-/**
- * Generate a random uuid similar to the uuid python module
- *
- * >>> import uuid
- * >>> uuid.uuid4().hex
- * 'bec08155b37d4050a1f3c3fa0276bf12'
- *
- * Code adapted from https://github.com/r-lyeh-archived/sole
- */
-
-#include "IXUuid.h"
-
-#include <sstream>
-#include <string>
-#include <iomanip>
-#include <random>
-
-
-namespace ix
-{
-    class Uuid
-    {
-        public:
-            Uuid();
-            std::string toString() const;
-
-        private:
-            uint64_t _ab;
-            uint64_t _cd;
-    };
-
-    Uuid::Uuid()
-    {
-        static std::random_device rd;
-        static std::uniform_int_distribution<uint64_t> dist(0, (uint64_t)(~0));
-
-        _ab = dist(rd);
-        _cd = dist(rd);
-
-        _ab = (_ab & 0xFFFFFFFFFFFF0FFFULL) | 0x0000000000004000ULL;
-        _cd = (_cd & 0x3FFFFFFFFFFFFFFFULL) | 0x8000000000000000ULL;
-    }
-
-    std::string Uuid::toString() const
-    {
-        std::stringstream ss;
-        ss << std::hex << std::nouppercase << std::setfill('0');
-
-        uint32_t a = (_ab >> 32);
-        uint32_t b = (_ab & 0xFFFFFFFF);
-        uint32_t c = (_cd >> 32);
-        uint32_t d = (_cd & 0xFFFFFFFF);
-
-        ss << std::setw(8) << (a);
-        ss << std::setw(4) << (b >> 16);
-        ss << std::setw(4) << (b & 0xFFFF);
-        ss << std::setw(4) << (c >> 16 );
-        ss << std::setw(4) << (c & 0xFFFF);
-        ss << std::setw(8) << d;
-
-        return ss.str();
-    }
-
-    std::string uuid4()
-    {
-        Uuid id;
-        return id.toString();
-    }
-}

examples/cobra_publisher/ixcrypto/IXUuid.h

@@ -1,17 +0,0 @@
-/*
- *  IXUuid.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-#pragma once
-
-#include <string>
-
-namespace ix
-{
-   /**
-    * Generate a random uuid
-    */
-   std::string uuid4();
-
-}

examples/ws_receive/.gitignore

@@ -1 +0,0 @@
-build

examples/ws_receive/CMakeLists.txt

@@ -1,30 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-cmake_minimum_required (VERSION 3.4.1)
-project (ws_receive)
-
-# There's -Weverything too for clang
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
-
-set (CMAKE_CXX_STANDARD 14)
-
-option(USE_TLS "Add TLS support" ON)
-
-add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
-
-include_directories(ws_receive .)
-
-add_executable(ws_receive 
-  jsoncpp/jsoncpp.cpp
-  ixcrypto/IXBase64.cpp
-  ixcrypto/IXHash.cpp
-  ws_receive.cpp)
-
-if (APPLE AND USE_TLS)
-    target_link_libraries(ws_receive "-framework foundation" "-framework security")
-endif()
-
-target_link_libraries(ws_receive ixwebsocket)

examples/ws_receive/README.md

@@ -1 +0,0 @@
-ws_receive is a simple server upload program. It needs to be used in conjonction with ws_send.

examples/ws_receive/ixcrypto

@@ -1 +0,0 @@
-../cobra_publisher/ixcrypto

examples/ws_receive/jsoncpp/json/json-forwards.h

@@ -1,333 +0,0 @@
-/// Json-cpp amalgated forward header (http://jsoncpp.sourceforge.net/).
-/// It is intended to be used with #include "json/json-forwards.h"
-/// This header provides forward declaration for all JsonCpp types.
-
-// //////////////////////////////////////////////////////////////////////
-// Beginning of content of file: LICENSE
-// //////////////////////////////////////////////////////////////////////
-
-/*
-The JsonCpp library's source code, including accompanying documentation,
-tests and demonstration applications, are licensed under the following
-conditions...
-
-Baptiste Lepilleur and The JsonCpp Authors explicitly disclaim copyright in all
-jurisdictions which recognize such a disclaimer. In such jurisdictions,
-this software is released into the Public Domain.
-
-In jurisdictions which do not recognize Public Domain property (e.g. Germany as of
-2010), this software is Copyright (c) 2007-2010 by Baptiste Lepilleur and
-The JsonCpp Authors, and is released under the terms of the MIT License (see below).
-
-In jurisdictions which recognize Public Domain property, the user of this
-software may choose to accept it either as 1) Public Domain, 2) under the
-conditions of the MIT License (see below), or 3) under the terms of dual
-Public Domain/MIT License conditions described here, as they choose.
-
-The MIT License is about as close to Public Domain as a license can get, and is
-described in clear, concise terms at:
-
-   http://en.wikipedia.org/wiki/MIT_License
-
-The full text of the MIT License follows:
-
-========================================================================
-Copyright (c) 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
-
-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.
-========================================================================
-(END LICENSE TEXT)
-
-The MIT license is compatible with both the GPL and commercial
-software, affording one all of the rights of Public Domain with the
-minor nuisance of being required to keep the above copyright notice
-and license text in the source code. Note also that by accepting the
-Public Domain "license" you can re-license your copy using whatever
-license you like.
-
-*/
-
-// //////////////////////////////////////////////////////////////////////
-// End of content of file: LICENSE
-// //////////////////////////////////////////////////////////////////////
-
-
-
-
-
-#ifndef JSON_FORWARD_AMALGATED_H_INCLUDED
-# define JSON_FORWARD_AMALGATED_H_INCLUDED
-/// If defined, indicates that the source file is amalgated
-/// to prevent private header inclusion.
-#define JSON_IS_AMALGAMATION
-
-// //////////////////////////////////////////////////////////////////////
-// Beginning of content of file: include/json/config.h
-// //////////////////////////////////////////////////////////////////////
-
-// Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
-// Distributed under MIT license, or public domain if desired and
-// recognized in your jurisdiction.
-// See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE
-
-#ifndef JSON_CONFIG_H_INCLUDED
-#define JSON_CONFIG_H_INCLUDED
-#include <stddef.h>
-#include <string> //typedef String
-#include <stdint.h> //typedef int64_t, uint64_t
-
-/// If defined, indicates that json library is embedded in CppTL library.
-//# define JSON_IN_CPPTL 1
-
-/// If defined, indicates that json may leverage CppTL library
-//#  define JSON_USE_CPPTL 1
-/// If defined, indicates that cpptl vector based map should be used instead of
-/// std::map
-/// as Value container.
-//#  define JSON_USE_CPPTL_SMALLMAP 1
-
-// If non-zero, the library uses exceptions to report bad input instead of C
-// assertion macros. The default is to use exceptions.
-#ifndef JSON_USE_EXCEPTION
-#define JSON_USE_EXCEPTION 1
-#endif
-
-/// If defined, indicates that the source file is amalgated
-/// to prevent private header inclusion.
-/// Remarks: it is automatically defined in the generated amalgated header.
-// #define JSON_IS_AMALGAMATION
-
-#ifdef JSON_IN_CPPTL
-#include <cpptl/config.h>
-#ifndef JSON_USE_CPPTL
-#define JSON_USE_CPPTL 1
-#endif
-#endif
-
-#ifdef JSON_IN_CPPTL
-#define JSON_API CPPTL_API
-#elif defined(JSON_DLL_BUILD)
-#if defined(_MSC_VER) || defined(__MINGW32__)
-#define JSON_API __declspec(dllexport)
-#define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
-#endif // if defined(_MSC_VER)
-#elif defined(JSON_DLL)
-#if defined(_MSC_VER) || defined(__MINGW32__)
-#define JSON_API __declspec(dllimport)
-#define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
-#endif // if defined(_MSC_VER)
-#endif // ifdef JSON_IN_CPPTL
-#if !defined(JSON_API)
-#define JSON_API
-#endif
-
-// If JSON_NO_INT64 is defined, then Json only support C++ "int" type for
-// integer
-// Storages, and 64 bits integer support is disabled.
-// #define JSON_NO_INT64 1
-
-#if defined(_MSC_VER) // MSVC
-#  if _MSC_VER <= 1200 // MSVC 6
-    // Microsoft Visual Studio 6 only support conversion from __int64 to double
-    // (no conversion from unsigned __int64).
-#    define JSON_USE_INT64_DOUBLE_CONVERSION 1
-    // Disable warning 4786 for VS6 caused by STL (identifier was truncated to '255'
-    // characters in the debug information)
-    // All projects I've ever seen with VS6 were using this globally (not bothering
-    // with pragma push/pop).
-#    pragma warning(disable : 4786)
-#  endif // MSVC 6
-
-#  if _MSC_VER >= 1500 // MSVC 2008
-    /// Indicates that the following function is deprecated.
-#    define JSONCPP_DEPRECATED(message) __declspec(deprecated(message))
-#  endif
-
-#endif // defined(_MSC_VER)
-
-// In c++11 the override keyword allows you to explicity define that a function
-// is intended to override the base-class version.  This makes the code more
-// managable and fixes a set of common hard-to-find bugs.
-#if __cplusplus >= 201103L
-# define JSONCPP_OVERRIDE override
-# define JSONCPP_NOEXCEPT noexcept
-#elif defined(_MSC_VER) && _MSC_VER > 1600 && _MSC_VER < 1900
-# define JSONCPP_OVERRIDE override
-# define JSONCPP_NOEXCEPT throw()
-#elif defined(_MSC_VER) && _MSC_VER >= 1900
-# define JSONCPP_OVERRIDE override
-# define JSONCPP_NOEXCEPT noexcept
-#else
-# define JSONCPP_OVERRIDE
-# define JSONCPP_NOEXCEPT throw()
-#endif
-
-#ifndef JSON_HAS_RVALUE_REFERENCES
-
-#if defined(_MSC_VER) && _MSC_VER >= 1600 // MSVC >= 2010
-#define JSON_HAS_RVALUE_REFERENCES 1
-#endif // MSVC >= 2010
-
-#ifdef __clang__
-#if __has_feature(cxx_rvalue_references)
-#define JSON_HAS_RVALUE_REFERENCES 1
-#endif  // has_feature
-
-#elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
-#if defined(__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
-#define JSON_HAS_RVALUE_REFERENCES 1
-#endif  // GXX_EXPERIMENTAL
-
-#endif // __clang__ || __GNUC__
-
-#endif // not defined JSON_HAS_RVALUE_REFERENCES
-
-#ifndef JSON_HAS_RVALUE_REFERENCES
-#define JSON_HAS_RVALUE_REFERENCES 0
-#endif
-
-#ifdef __clang__
-#  if __has_extension(attribute_deprecated_with_message)
-#    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
-#  endif
-#elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
-#  if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
-#    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
-#  elif (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
-#    define JSONCPP_DEPRECATED(message)  __attribute__((__deprecated__))
-#  endif  // GNUC version
-#endif // __clang__ || __GNUC__
-
-#if !defined(JSONCPP_DEPRECATED)
-#define JSONCPP_DEPRECATED(message)
-#endif // if !defined(JSONCPP_DEPRECATED)
-
-#if __GNUC__ >= 6
-#  define JSON_USE_INT64_DOUBLE_CONVERSION 1
-#endif
-
-#if !defined(JSON_IS_AMALGAMATION)
-
-# include "version.h"
-
-# if JSONCPP_USING_SECURE_MEMORY
-#  include "allocator.h" //typedef Allocator
-# endif
-
-#endif // if !defined(JSON_IS_AMALGAMATION)
-
-namespace Json {
-typedef int Int;
-typedef unsigned int UInt;
-#if defined(JSON_NO_INT64)
-typedef int LargestInt;
-typedef unsigned int LargestUInt;
-#undef JSON_HAS_INT64
-#else                 // if defined(JSON_NO_INT64)
-// For Microsoft Visual use specific types as long long is not supported
-#if defined(_MSC_VER) // Microsoft Visual Studio
-typedef __int64 Int64;
-typedef unsigned __int64 UInt64;
-#else                 // if defined(_MSC_VER) // Other platforms, use long long
-typedef int64_t Int64;
-typedef uint64_t UInt64;
-#endif // if defined(_MSC_VER)
-typedef Int64 LargestInt;
-typedef UInt64 LargestUInt;
-#define JSON_HAS_INT64
-#endif // if defined(JSON_NO_INT64)
-#if JSONCPP_USING_SECURE_MEMORY
-#define JSONCPP_STRING        std::basic_string<char, std::char_traits<char>, Json::SecureAllocator<char> >
-#define JSONCPP_OSTRINGSTREAM std::basic_ostringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
-#define JSONCPP_OSTREAM       std::basic_ostream<char, std::char_traits<char>>
-#define JSONCPP_ISTRINGSTREAM std::basic_istringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
-#define JSONCPP_ISTREAM       std::istream
-#else
-#define JSONCPP_STRING        std::string
-#define JSONCPP_OSTRINGSTREAM std::ostringstream
-#define JSONCPP_OSTREAM       std::ostream
-#define JSONCPP_ISTRINGSTREAM std::istringstream
-#define JSONCPP_ISTREAM       std::istream
-#endif // if JSONCPP_USING_SECURE_MEMORY
-} // end namespace Json
-
-#endif // JSON_CONFIG_H_INCLUDED
-
-// //////////////////////////////////////////////////////////////////////
-// End of content of file: include/json/config.h
-// //////////////////////////////////////////////////////////////////////
-
-
-
-
-
-
-// //////////////////////////////////////////////////////////////////////
-// Beginning of content of file: include/json/forwards.h
-// //////////////////////////////////////////////////////////////////////
-
-// Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
-// Distributed under MIT license, or public domain if desired and
-// recognized in your jurisdiction.
-// See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE
-
-#ifndef JSON_FORWARDS_H_INCLUDED
-#define JSON_FORWARDS_H_INCLUDED
-
-#if !defined(JSON_IS_AMALGAMATION)
-#include "config.h"
-#endif // if !defined(JSON_IS_AMALGAMATION)
-
-namespace Json {
-
-// writer.h
-class FastWriter;
-class StyledWriter;
-
-// reader.h
-class Reader;
-
-// features.h
-class Features;
-
-// value.h
-typedef unsigned int ArrayIndex;
-class StaticString;
-class Path;
-class PathArgument;
-class Value;
-class ValueIteratorBase;
-class ValueIterator;
-class ValueConstIterator;
-
-} // namespace Json
-
-#endif // JSON_FORWARDS_H_INCLUDED
-
-// //////////////////////////////////////////////////////////////////////
-// End of content of file: include/json/forwards.h
-// //////////////////////////////////////////////////////////////////////
-
-
-
-
-
-#endif //ifndef JSON_FORWARD_AMALGATED_H_INCLUDED

examples/ws_receive/package-lock.json

@@ -1,29 +0,0 @@
-{
-  "requires": true,
-  "lockfileVersion": 1,
-  "dependencies": {
-    "async-limiter": {
-      "version": "1.0.0",
-      "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.0.tgz",
-      "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg=="
-    },
-    "base-64": {
-      "version": "0.1.0",
-      "resolved": "https://registry.npmjs.org/base-64/-/base-64-0.1.0.tgz",
-      "integrity": "sha1-eAqZyE59YAJgNhURxId2E78k9rs="
-    },
-    "djb2": {
-      "version": "0.0.2",
-      "resolved": "https://registry.npmjs.org/djb2/-/djb2-0.0.2.tgz",
-      "integrity": "sha1-RAs4kao6uBQrVNRpsXe66p6W5O8="
-    },
-    "ws": {
-      "version": "6.1.4",
-      "resolved": "https://registry.npmjs.org/ws/-/ws-6.1.4.tgz",
-      "integrity": "sha512-eqZfL+NE/YQc1/ZynhojeV8q+H050oR8AZ2uIev7RU10svA9ZnJUddHcOUZTJLinZ9yEfdA2kSATS2qZK5fhJA==",
-      "requires": {
-        "async-limiter": "1.0.0"
-      }
-    }
-  }
-}

examples/ws_receive/ws_receive.cpp

@@ -1,153 +0,0 @@
-/*
- *  ws_receive.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#include <iostream>
-#include <sstream>
-#include <fstream>
-#include <ixwebsocket/IXWebSocketServer.h>
-#include <jsoncpp/json/json.h>
-#include <ixcrypto/IXBase64.h>
-#include <ixcrypto/IXHash.h>
-
-
-namespace
-{
-    // We should cleanup the file name and full path further to remove .. as well
-    std::string extractFilename(const std::string& path)
-    {
-        std::string filename("filename.conf");
-        std::string::size_type idx;
-
-        idx = path.rfind('/');
-        if (idx != std::string::npos)
-        {
-            std::string filename = path.substr(idx+1);
-            return filename;
-        }
-        else
-        {
-            return std::string();
-        }
-    }
-}
-
-namespace ix
-{
-    void errorHandler(const std::string& errMsg,
-                      const std::string& id,
-                      std::shared_ptr<ix::WebSocket> webSocket)
-    {
-        Json::Value pdu;
-        pdu["kind"] = "error";
-        pdu["id"] = id;
-        pdu["message"] = errMsg;
-        webSocket->send(pdu.toStyledString());
-    }
-
-    void messageHandler(const std::string& str,
-                        std::shared_ptr<ix::WebSocket> webSocket)
-    {
-        std::cerr << "Received message: " << str.size() << std::endl;
-
-        Json::Value data;
-        Json::Reader reader;
-        if (!reader.parse(str, data))
-        {
-            errorHandler("Invalid JSON", std::string(), webSocket);
-            return;
-        }
-
-        std::cout << "id: " << data["id"].asString() << std::endl;
-
-        std::string content = ix::base64_decode(data["content"].asString());
-        std::cout << "Content size: " << content.size() << std::endl;
-
-        // Validate checksum
-        uint64_t cksum = ix::djb2Hash(data["content"].asString());
-        uint64_t cksumRef = data["djb2_hash"].asUInt64();
-
-        std::cout << "Computed hash: " << cksum << std::endl;
-        std::cout << "Reference hash: " << cksumRef << std::endl;
-
-        if (cksum != cksumRef)
-        {
-            errorHandler("Hash mismatch.", std::string(), webSocket);
-            return;
-        }
-
-        std::string filename = data["filename"].asString();
-        filename = extractFilename(filename);
-
-        std::ofstream out(filename);
-        out << content;
-        out.close();
-
-        Json::Value pdu;
-        pdu["ack"] = true;
-        pdu["id"] = data["id"];
-        pdu["filename"] = data["filename"];
-        webSocket->send(pdu.toStyledString());
-    }
-}
-
-int main(int argc, char** argv)
-{
-    int port = 8080;
-    if (argc == 2)
-    {
-        std::stringstream ss;
-        ss << argv[1];
-        ss >> port;
-    }
-
-    ix::WebSocketServer server(port);
-
-    server.setOnConnectionCallback(
-        [&server](std::shared_ptr<ix::WebSocket> webSocket)
-        {
-            webSocket->setOnMessageCallback(
-                [webSocket, &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;
-                        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_Close)
-                    {
-                        std::cerr << "Closed connection" << std::endl;
-                    }
-                    else if (messageType == ix::WebSocket_MessageType_Message)
-                    {
-                        messageHandler(str, webSocket);
-                    }
-                }
-            );
-        }
-    );
-
-    auto res = server.listen();
-    if (!res.first)
-    {
-        std::cerr << res.second << std::endl;
-        return 1;
-    }
-
-    server.start();
-    server.wait();
-
-    return 0;
-}

examples/ws_receive/ws_receive.js

@@ -1,43 +0,0 @@
-/*
- *  ws_receive.js
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-const WebSocket = require('ws')
-const djb2 = require('djb2')
-const fs = require('fs')
-
-const wss = new WebSocket.Server({ port: 8080,
-                                   perMessageDeflate: false,
-                                   maxPayload: 1024 * 1024 * 1024 * 1024});
-
-wss.on('connection', function connection(ws) {
-  ws.on('message', function incoming(data) {
-    console.log('Received message')
-
-    let str = data.toString()
-    let obj = JSON.parse(str)
-
-    console.log(obj.id)
-    console.log(obj.djb2_hash)
-    console.log(djb2(obj.content))
-
-    var content = Buffer.from(obj.content, 'base64')
-    // let bytes = base64.decode(obj.content)
-
-    let path = obj.filename
-    fs.writeFile(path, content, function(err) {
-      if (err) {
-        throw err
-      } else {
-        console.log('wrote data to disk')
-      }
-    });
-
-    let response = {
-      id: obj.id
-    }
-
-    ws.send(JSON.stringify(response))
-  });
-});

examples/ws_send/.gitignore

@@ -1 +0,0 @@
-build

examples/ws_send/CMakeLists.txt

@@ -1,31 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-cmake_minimum_required (VERSION 3.4.1)
-project (ws_send)
-
-# There's -Weverything too for clang
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
-
-set (CMAKE_CXX_STANDARD 14)
-
-option(USE_TLS "Add TLS support" ON)
-
-add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
-
-include_directories(ws_send .)
-
-add_executable(ws_send 
-  jsoncpp/jsoncpp.cpp
-  ixcrypto/IXBase64.cpp
-  ixcrypto/IXUuid.cpp
-  ixcrypto/IXHash.cpp
-  ws_send.cpp)
-
-if (APPLE AND USE_TLS)
-    target_link_libraries(ws_send "-framework foundation" "-framework security")
-endif()
-
-target_link_libraries(ws_send ixwebsocket)

examples/ws_send/README.md

@@ -1 +0,0 @@
-ws_send is a simple upload program. It needs to be used in conjonction with ws_receive.

examples/ws_send/ixcrypto

@@ -1 +0,0 @@
-../cobra_publisher/ixcrypto

examples/ws_send/jsoncpp

@@ -1 +0,0 @@
-../cobra_publisher/jsoncpp

examples/ws_send/ws_send.cpp

@@ -1,306 +0,0 @@
-/*
- *  ws_send.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
- */
-
-#include <iostream>
-#include <fstream>
-#include <sstream>
-#include <vector>
-#include <condition_variable>
-#include <mutex>
-#include <chrono>
-#include <ixwebsocket/IXWebSocket.h>
-#include <ixwebsocket/IXSocket.h>
-#include <ixcrypto/IXUuid.h>
-#include <ixcrypto/IXBase64.h>
-#include <ixcrypto/IXHash.h>
-#include <jsoncpp/json/json.h>
-
-using namespace ix;
-
-namespace
-{
-    void log(const std::string& msg)
-    {
-        std::cout << msg << std::endl;
-    }
-
-    class WebSocketSender
-    {
-        public:
-            WebSocketSender(const std::string& _url,
-                            bool enablePerMessageDeflate);
-
-            void subscribe(const std::string& channel);
-            void start();
-            void stop();
-
-            void waitForConnection();
-            void waitForAck();
-
-            void sendMessage(const std::string& filename, bool throttle);
-
-        private:
-            std::string _url;
-            std::string _id;
-            ix::WebSocket _webSocket;
-            bool _enablePerMessageDeflate;
-
-            std::mutex _conditionVariableMutex;
-            std::condition_variable _condition;
-    };
-
-    WebSocketSender::WebSocketSender(const std::string& url,
-                                     bool enablePerMessageDeflate) :
-        _url(url),
-        _enablePerMessageDeflate(enablePerMessageDeflate)
-    {
-        ;
-    }
-
-    void WebSocketSender::stop()
-    {
-        _webSocket.stop();
-    }
-
-    void WebSocketSender::waitForConnection()
-    {
-        std::cout << "Connecting..." << std::endl;
-
-        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
-        _condition.wait(lock);
-    }
-
-    void WebSocketSender::waitForAck()
-    {
-        std::cout << "Waiting for ack..." << std::endl;
-
-        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
-        _condition.wait(lock);
-    }
-
-    std::string load(const std::string& path)
-    {
-        // std::vector<uint8_t> memblock;
-        std::string str;
-
-        std::ifstream file(path);
-        if (!file.is_open()) return std::string();
-
-        file.seekg(0, file.end);
-        std::streamoff size = file.tellg();
-        file.seekg(0, file.beg);
-
-        str.resize(size);
-        file.read((char*)&str.front(), static_cast<std::streamsize>(size));
-
-        return str;
-    }
-
-    void WebSocketSender::start()
-    {
-        _webSocket.setUrl(_url);
-
-        ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(
-            _enablePerMessageDeflate, false, false, 15, 15);
-        _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
-
-        std::stringstream ss;
-        log(std::string("Connecting to url: ") + _url);
-
-        _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)
-            {
-                std::stringstream ss;
-                if (messageType == ix::WebSocket_MessageType_Open)
-                {
-                    _condition.notify_one();
-
-                    log("ws_send: connected");
-                    std::cout << "Uri: " << openInfo.uri << std::endl;
-                    std::cout << "Handshake Headers:" << std::endl;
-                    for (auto it : openInfo.headers)
-                    {
-                        std::cout << it.first << ": " << it.second << std::endl;
-                    }
-                }
-                else if (messageType == ix::WebSocket_MessageType_Close)
-                {
-                    ss << "ws_send: connection closed:";
-                    ss << " code " << closeInfo.code;
-                    ss << " reason " << closeInfo.reason << std::endl;
-                    log(ss.str());
-                }
-                else if (messageType == ix::WebSocket_MessageType_Message)
-                {
-                    _condition.notify_one();
-
-                    ss << "ws_send: received message: "
-                       << str;
-                    log(ss.str());
-
-                    Json::Value data;
-                    Json::Reader reader;
-                    if (!reader.parse(str, data))
-                    {
-                        std::cerr << "Invalid JSON response" << std::endl;
-                        return;
-                    }
-
-                    std::string id = data["id"].asString();
-                    if (_id != id)
-                    {
-                        std::cerr << "Invalid id" << std::endl;
-                    }
-                }
-                else if (messageType == ix::WebSocket_MessageType_Error)
-                {
-                    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;
-                    log(ss.str());
-                }
-                else
-                {
-                    ss << "Invalid ix::WebSocketMessageType";
-                    log(ss.str());
-                }
-            });
-
-        _webSocket.start();
-    }
-
-    class Bench
-    {
-        public:
-            Bench(const std::string& description) :
-                _description(description),
-                _start(std::chrono::system_clock::now()),
-                _reported(false)
-            {
-                ;
-            }
-
-            ~Bench()
-            {
-                if (!_reported)
-                {
-                    report();
-                }
-            }
-
-            void report()
-            {
-                auto now = std::chrono::system_clock::now();
-                auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(now - _start);
-
-                _ms = milliseconds.count();
-                std::cout << _description << " completed in "
-                          << _ms << "ms" << std::endl;
-
-                _reported = true;
-            }
-
-            uint64_t getDuration() const
-            {
-                return _ms;
-            }
-
-        private:
-            std::string _description;
-            std::chrono::time_point<std::chrono::system_clock> _start;
-            uint64_t _ms;
-            bool _reported;
-    };
-
-    void WebSocketSender::sendMessage(const std::string& filename,
-                                      bool throttle)
-    {
-        std::string content;
-        {
-            Bench bench("load file from disk");
-            content = load(filename);
-        }
-
-        _id = uuid4();
-
-        std::string b64Content;
-        {
-            Bench bench("base 64 encode file");
-            b64Content = base64_encode(content, content.size());
-        }
-
-        Json::Value pdu;
-        pdu["kind"] = "send";
-        pdu["id"] = _id;
-        pdu["content"] = b64Content;
-        pdu["djb2_hash"] = djb2Hash(b64Content);
-        pdu["filename"] = filename;
-
-        Bench bench("Sending file through websocket");
-        _webSocket.send(pdu.toStyledString(),
-                        [throttle](int current, int total) -> bool
-        {
-            std::cout << "Step " << current << " out of " << total << std::endl;
-
-            if (throttle)
-            {
-                std::chrono::duration<double, std::milli> duration(10);
-                std::this_thread::sleep_for(duration);
-            }
-
-            return true;
-        });
-
-        bench.report();
-        auto duration = bench.getDuration();
-        auto transferRate = 1000 * b64Content.size() / duration;
-        transferRate /= (1024 * 1024);
-        std::cout << "Send transfer rate: " << transferRate << "MB/s" << std::endl;
-    }
-
-    void wsSend(const std::string& url,
-                const std::string& path,
-                bool enablePerMessageDeflate,
-                bool throttle)
-    {
-        WebSocketSender webSocketSender(url, enablePerMessageDeflate);
-        webSocketSender.start();
-
-        webSocketSender.waitForConnection();
-
-        std::cout << "Sending..." << std::endl;
-        webSocketSender.sendMessage(path, throttle);
-
-        webSocketSender.waitForAck();
-
-        std::cout << "Done !" << std::endl;
-        webSocketSender.stop();
-    }
-}
-
-int main(int argc, char** argv)
-{
-    if (argc != 3)
-    {
-        std::cerr << "Usage: ws_send <url> <path>" << std::endl;
-        return 1;
-    }
-    std::string url = argv[1];
-    std::string path = argv[2];
-
-    bool throttle = false;
-    bool enablePerMessageDeflate = false;
-
-    Socket::init();
-    wsSend(url, path, enablePerMessageDeflate, throttle);
-    return 0;
-}

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.cpp

@@ -0,0 +1,43 @@
+/*
+ *  IXConnectionState.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXConnectionState.h"
+
+namespace ix
+{
+    std::atomic<uint64_t> ConnectionState::_globalId(0);
+
+    ConnectionState::ConnectionState() : _terminated(false)
+    {
+        computeId();
+    }
+
+    void ConnectionState::computeId()
+    {
+        _id = std::to_string(_globalId++);
+    }
+
+    const std::string& ConnectionState::getId() const
+    {
+        return _id;
+    }
+
+    std::shared_ptr<ConnectionState> ConnectionState::createConnectionState()
+    {
+        return std::make_shared<ConnectionState>();
+    }
+
+    bool ConnectionState::isTerminated() const
+    {
+        return _terminated;
+    }
+
+    void ConnectionState::setTerminated()
+    {
+        _terminated = true;
+    }
+}
+

ixwebsocket/IXConnectionState.h

@@ -0,0 +1,36 @@
+/*
+ *  IXConnectionState.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <atomic>
+#include <memory>
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class ConnectionState
+    {
+    public:
+        ConnectionState();
+        virtual ~ConnectionState() = default;
+
+        virtual void computeId();
+        virtual const std::string& getId() const;
+
+        void setTerminated();
+        bool isTerminated() const;
+
+        static std::shared_ptr<ConnectionState> createConnectionState();
+
+    protected:
+        std::atomic<bool> _terminated;
+        std::string _id;
+
+        static std::atomic<uint64_t> _globalId;
+    };
+} // namespace ix

ixwebsocket/IXDNSLookup.cpp

@@ -9,31 +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)
     {
-
-    }
-
-    DNSLookup::~DNSLookup()
-    {
-        // Remove this job from the active jobs list
-        std::unique_lock<std::mutex> lock(_activeJobsMutex);
-        _activeJobs.erase(_id);
+        ;
     }
 
     struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname,
@@ -61,19 +50,19 @@ 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";
 
         // Maybe a cancellation request got in before the background thread terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
@@ -82,8 +71,8 @@ namespace ix
         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";
 
@@ -95,33 +84,31 @@ namespace ix
                             // if you need a second lookup.
         }
 
-        // Record job in the active Job set
-        {
-            std::unique_lock<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, _hostname, _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())
+            if (isCancellationRequested && isCancellationRequested())
             {
                 errMsg = "cancellation requested";
                 return nullptr;
@@ -129,16 +116,17 @@ namespace ix
         }
 
         // Maybe a cancellation request got in before the bg terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
         }
 
-        return _res;
+        errMsg = getErrMsg();
+        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,19 +134,37 @@ 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 not thing to do, and we don't want to touch the defunct
-        // object data structure such as _errMsg or _condition
-        std::unique_lock<std::mutex> lock(_activeJobsMutex);
-        if (_activeJobs.count(id) == 0)
+        if (self.lock())
         {
-            return;
-        }
+            // Copy result into the member variables
+            setRes(res);
+            setErrMsg(errMsg);
 
-        // Copy result into the member variables
-        _res = res;
+            _done = true;
+        }
+    }
+
+    void DNSLookup::setErrMsg(const std::string& errMsg)
+    {
+        std::lock_guard<std::mutex> lock(_errMsgMutex);
         _errMsg = errMsg;
-        _condition.notify_one();
-        _done = true;
+    }
+
+    const std::string& DNSLookup::getErrMsg()
+    {
+        std::lock_guard<std::mutex> lock(_errMsgMutex);
+        return _errMsg;
+    }
+
+    void DNSLookup::setRes(struct addrinfo* addr)
+    {
+        std::lock_guard<std::mutex> lock(_resMutex);
+        _res = addr;
+    }
+
+    struct addrinfo* DNSLookup::getRes()
+    {
+        std::lock_guard<std::mutex> lock(_resMutex);
+        return _res;
     }
 }

ixwebsocket/IXDNSLookup.h

@@ -11,56 +11,55 @@
 #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 run(std::weak_ptr<DNSLookup> self, std::string hostname, int port); // thread runner
+
+        void setErrMsg(const std::string& errMsg);
+        const std::string& getErrMsg();
+
+        void setRes(struct addrinfo* addr);
+        struct addrinfo* getRes();
 
         std::string _hostname;
         int _port;
         int64_t _wait;
-        std::string _errMsg;
+        const static int64_t kDefaultWait;
+
         struct addrinfo* _res;
+        std::mutex _resMutex;
+
+        std::string _errMsg;
+        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/IXEventFd.cpp

@@ -1,121 +0,0 @@
-/*
- *  IXEventFd.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-//
-// Linux/Android has a special type of virtual files. select(2) will react
-// when reading/writing to those files, unlike closing sockets.
-//
-// https://linux.die.net/man/2/eventfd
-// http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
-//
-// eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
-// is on Kernel 3.x
-//
-// cf Android/Kernel table here
-// https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
-//
-// On macOS we use UNIX pipes to wake up select.
-//
-
-#include "IXEventFd.h"
-
-#ifdef __linux__
-# include <sys/eventfd.h>
-#endif
-
-#include <unistd.h> // for write
-#include <fcntl.h>
-
-namespace ix
-{
-    // File descriptor at index 0 in _fildes is the read end of the pipe
-    // File descriptor at index 1 in _fildes is the write end of the pipe
-    const int EventFd::kPipeReadIndex = 0;
-    const int EventFd::kPipeWriteIndex = 1;
-
-    EventFd::EventFd()
-    {
-#ifdef __linux__
-        _eventfd = -1;
-        _eventfd = eventfd(0, 0);
-        fcntl(_eventfd, F_SETFL, O_NONBLOCK);
-#else
-        _fildes[kPipeReadIndex] = -1;
-        _fildes[kPipeWriteIndex] = -1;
-
-        pipe(_fildes);
-        fcntl(_fildes[kPipeReadIndex], F_SETFL, O_NONBLOCK);
-        fcntl(_fildes[kPipeWriteIndex], F_SETFL, O_NONBLOCK);
-#endif
-    }
-
-    EventFd::~EventFd()
-    {
-#ifdef __linux__
-        ::close(_eventfd);
-#else
-        ::close(_fildes[kPipeReadIndex]);
-        ::close(_fildes[kPipeWriteIndex]);
-        _fildes[kPipeReadIndex] = -1;
-        _fildes[kPipeWriteIndex] = -1;
-#endif
-    }
-
-    bool EventFd::notify(uint64_t value)
-    {
-        int fd;
-
-#if defined(__linux__)
-        fd = _eventfd;
-#else
-        fd = _fildes[kPipeWriteIndex];
-#endif
-
-        if (fd == -1) return false;
-
-        // we should write 8 bytes for an uint64_t
-        return write(fd, &value, sizeof(value)) == 8;
-    }
-
-    // TODO: return max uint64_t for errors ?
-    uint64_t EventFd::read()
-    {
-        int fd;
-
-#if defined(__linux__)
-        fd = _eventfd;
-#else
-        fd = _fildes[kPipeReadIndex];
-#endif
-        uint64_t value = 0;
-        ::read(fd, &value, sizeof(value));
-        return value;
-    }
-
-    bool EventFd::clear()
-    {
-#if defined(__linux__)
-        if (_eventfd == -1) return false;
-
-        // 0 is a special value ; select will not wake up
-        uint64_t value = 0;
-
-        // we should write 8 bytes for an uint64_t
-        return write(_eventfd, &value, sizeof(value)) == 8;
-#else
-        return true;
-#endif
-    }
-
-    int EventFd::getFd()
-    {
-#if defined(__linux__)
-        return _eventfd;
-#else
-        return _fildes[kPipeReadIndex];
-#endif
-    }
-}

ixwebsocket/IXEventFd.h

@@ -1,37 +0,0 @@
-/*
- *  IXEventFd.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <stdint.h>
-
-namespace ix
-{
-    class EventFd {
-    public:
-        EventFd();
-        virtual ~EventFd();
-
-        bool notify(uint64_t value);
-        bool clear();
-        uint64_t read();
-        int getFd();
-
-    private:
-#if defined(__linux__)
-        int _eventfd;
-#else
-        // Store file descriptors used by the communication pipe. Communication
-        // happens between a control thread and a background thread, which is
-        // blocked on select.
-        int _fildes[2];
-#endif
-
-        // Used to identify the read/write idx
-        static const int kPipeReadIndex;
-        static const int kPipeWriteIndex;
-    };
-}

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,138 @@
+/*
+ *  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::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,122 @@
+/*
+ *  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::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,41 +23,117 @@ 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;
-        bool websocket = false;
 
-        if (!UrlParser::parse(url, protocol, host, path, query, port, websocket))
+        if (!UrlParser::parse(url, protocol, host, path, query, port))
         {
             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";
@@ -64,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";
             }
@@ -110,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 "
@@ -143,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();
@@ -157,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;
@@ -172,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);
@@ -184,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
@@ -216,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:
@@ -232,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;
         }
@@ -255,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;
@@ -265,7 +353,7 @@ namespace ix
                 ss << std::hex << line;
                 ss >> chunkSize;
 
-                if (args.verbose)
+                if (args->verbose)
                 {
                     std::stringstream oss;
                     oss << "Reading " << chunkSize << " bytes"
@@ -273,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;
 
@@ -293,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;
@@ -308,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();
@@ -322,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;
@@ -457,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,160 @@
+/*
+ *  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();
+
+        _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

@@ -0,0 +1,111 @@
+/*
+ *  IXNetSystem.cpp
+ *  Author: Korchynskyi Dmytro
+ *  Copyright (c) 2019 Machine Zone. All rights reserved.
+ */
+
+#include "IXNetSystem.h"
+
+namespace ix
+{
+    bool initNetSystem()
+    {
+#ifdef _WIN32
+        WORD wVersionRequested;
+        WSADATA wsaData;
+        int err;
+
+        // Use the MAKEWORD(lowbyte, highbyte) macro declared in Windef.h
+        wVersionRequested = MAKEWORD(2, 2);
+        err = WSAStartup(wVersionRequested, &wsaData);
+
+        return err == 0;
+#else
+        return true;
+#endif
+    }
+
+    bool uninitNetSystem()
+    {
+#ifdef _WIN32
+        int err = WSACleanup();
+        return err == 0;
+#else
+        return true;
+#endif
+    }
+}
+
+// This function should be in the global namespace
+#ifdef _WIN32
+    //
+    // 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)
+    {
+        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;
+    }
+#endif

ixwebsocket/IXNetSystem.h

@@ -7,19 +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
+typedef unsigned long int nfds_t;
+
+int poll(struct pollfd* fds, nfds_t nfds, int timeout);
+
 #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();
+} // namespace ix

ixwebsocket/IXSelectInterrupt.cpp

@@ -0,0 +1,46 @@
+/*
+ *  IXSelectInterrupt.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXSelectInterrupt.h"
+
+namespace ix
+{
+    SelectInterrupt::SelectInterrupt()
+    {
+        ;
+    }
+
+    SelectInterrupt::~SelectInterrupt()
+    {
+        ;
+    }
+
+    bool SelectInterrupt::init(std::string& /*errorMsg*/)
+    {
+        return true;
+    }
+
+    bool SelectInterrupt::notify(uint64_t /*value*/)
+    {
+        return true;
+    }
+
+    uint64_t SelectInterrupt::read()
+    {
+        return 0;
+    }
+
+    bool SelectInterrupt::clear()
+    {
+        return true;
+    }
+
+    int SelectInterrupt::getFd() const
+    {
+        return -1;
+    }
+}
+

ixwebsocket/IXSelectInterrupt.h

@@ -0,0 +1,27 @@
+/*
+ *  IXSelectInterrupt.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterrupt
+    {
+    public:
+        SelectInterrupt();
+        virtual ~SelectInterrupt();
+
+        virtual bool init(std::string& errorMsg);
+
+        virtual bool notify(uint64_t value);
+        virtual bool clear();
+        virtual uint64_t read();
+        virtual int getFd() const;
+    };
+} // namespace ix

ixwebsocket/IXSelectInterruptEventFd.cpp

@@ -0,0 +1,116 @@
+/*
+ *  IXSelectInterruptEventFd.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// On Linux we use eventd to wake up select.
+//
+
+//
+// Linux/Android has a special type of virtual files. select(2) will react
+// when reading/writing to those files, unlike closing sockets.
+//
+// https://linux.die.net/man/2/eventfd
+// http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
+//
+// eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
+// is on Kernel 3.x
+//
+// cf Android/Kernel table here
+// https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
+//
+// On macOS we use UNIX pipes to wake up select.
+//
+
+#include "IXSelectInterruptEventFd.h"
+
+#include <sys/eventfd.h>
+
+#include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
+
+namespace ix
+{
+    SelectInterruptEventFd::SelectInterruptEventFd()
+    {
+        _eventfd = -1;
+    }
+
+    SelectInterruptEventFd::~SelectInterruptEventFd()
+    {
+        ::close(_eventfd);
+    }
+
+    bool SelectInterruptEventFd::init(std::string& errorMsg)
+    {
+        // calling init twice is a programming error
+        assert(_eventfd == -1);
+
+        _eventfd = eventfd(0, 0);
+        if (_eventfd < 0)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in eventfd()"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        if (fcntl(_eventfd, F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in fcntl() call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        return true;
+    }
+
+    bool SelectInterruptEventFd::notify(uint64_t value)
+    {
+        int fd = _eventfd;
+
+        if (fd == -1) return false;
+
+        // we should write 8 bytes for an uint64_t
+        return write(fd, &value, sizeof(value)) == 8;
+    }
+
+    // TODO: return max uint64_t for errors ?
+    uint64_t SelectInterruptEventFd::read()
+    {
+        int fd = _eventfd;
+
+        uint64_t value = 0;
+        ::read(fd, &value, sizeof(value));
+        return value;
+    }
+
+    bool SelectInterruptEventFd::clear()
+    {
+        if (_eventfd == -1) return false;
+
+        // 0 is a special value ; select will not wake up
+        uint64_t value = 0;
+
+        // we should write 8 bytes for an uint64_t
+        return write(_eventfd, &value, sizeof(value)) == 8;
+    }
+
+    int SelectInterruptEventFd::getFd() const
+    {
+        return _eventfd;
+    }
+}

ixwebsocket/IXSelectInterruptEventFd.h

@@ -0,0 +1,31 @@
+/*
+ *  IXSelectInterruptEventFd.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSelectInterrupt.h"
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterruptEventFd final : public SelectInterrupt
+    {
+    public:
+        SelectInterruptEventFd();
+        virtual ~SelectInterruptEventFd();
+
+        bool init(std::string& errorMsg) final;
+
+        bool notify(uint64_t value) final;
+        bool clear() final;
+        uint64_t read() final;
+        int getFd() const final;
+
+    private:
+        int _eventfd;
+    };
+} // namespace ix

ixwebsocket/IXSelectInterruptFactory.cpp

@@ -0,0 +1,25 @@
+/*
+ *  IXSelectInterruptFactory.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXSelectInterruptFactory.h"
+
+#if defined(__linux__) || defined(__APPLE__)
+# include <ixwebsocket/IXSelectInterruptPipe.h>
+#else
+# include <ixwebsocket/IXSelectInterrupt.h>
+#endif
+
+namespace ix
+{
+    std::shared_ptr<SelectInterrupt> createSelectInterrupt()
+    {
+#if defined(__linux__) || defined(__APPLE__)
+        return std::make_shared<SelectInterruptPipe>();
+#else
+        return std::make_shared<SelectInterrupt>();
+#endif
+    }
+}

ixwebsocket/IXSelectInterruptFactory.h

@@ -0,0 +1,15 @@
+/*
+ *  IXSelectInterruptFactory.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <memory>
+
+namespace ix
+{
+    class SelectInterrupt;
+    std::shared_ptr<SelectInterrupt> createSelectInterrupt();
+} // namespace ix

ixwebsocket/IXSelectInterruptPipe.cpp

@@ -0,0 +1,146 @@
+/*
+ *  IXSelectInterruptPipe.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// On macOS we use UNIX pipes to wake up select.
+//
+
+#include "IXSelectInterruptPipe.h"
+
+#include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
+
+namespace ix
+{
+    // File descriptor at index 0 in _fildes is the read end of the pipe
+    // File descriptor at index 1 in _fildes is the write end of the pipe
+    const int SelectInterruptPipe::kPipeReadIndex = 0;
+    const int SelectInterruptPipe::kPipeWriteIndex = 1;
+
+    SelectInterruptPipe::SelectInterruptPipe()
+    {
+        _fildes[kPipeReadIndex] = -1;
+        _fildes[kPipeWriteIndex] = -1;
+    }
+
+    SelectInterruptPipe::~SelectInterruptPipe()
+    {
+        ::close(_fildes[kPipeReadIndex]);
+        ::close(_fildes[kPipeWriteIndex]);
+        _fildes[kPipeReadIndex] = -1;
+        _fildes[kPipeWriteIndex] = -1;
+    }
+
+    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);
+
+        if (pipe(_fildes) < 0)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in pipe() call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeReadIndex], F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., O_NONBLOCK) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., O_NONBLOCK) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+#ifdef F_SETNOSIGPIPE
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETNOSIGPIPE, 1) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(.... F_SETNOSIGPIPE) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETNOSIGPIPE, 1) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., F_SETNOSIGPIPE) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+#endif
+
+        return true;
+    }
+
+    bool SelectInterruptPipe::notify(uint64_t value)
+    {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
+        int fd = _fildes[kPipeWriteIndex];
+        if (fd == -1) return false;
+
+        // we should write 8 bytes for an uint64_t
+        return write(fd, &value, sizeof(value)) == 8;
+    }
+
+    // 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;
+        ::read(fd, &value, sizeof(value));
+
+        return value;
+    }
+
+    bool SelectInterruptPipe::clear()
+    {
+        return true;
+    }
+
+    int SelectInterruptPipe::getFd() const
+    {
+        std::lock_guard<std::mutex> lock(_fildesMutex);
+
+        return _fildes[kPipeReadIndex];
+    }
+}

ixwebsocket/IXSelectInterruptPipe.h

@@ -0,0 +1,40 @@
+/*
+ *  IXSelectInterruptPipe.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSelectInterrupt.h"
+#include <mutex>
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterruptPipe final : public SelectInterrupt
+    {
+    public:
+        SelectInterruptPipe();
+        virtual ~SelectInterruptPipe();
+
+        bool init(std::string& errorMsg) final;
+
+        bool notify(uint64_t value) final;
+        bool clear() final;
+        uint64_t read() final;
+        int getFd() const final;
+
+    private:
+        // Store file descriptors used by the communication pipe. Communication
+        // 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

@@ -7,6 +7,8 @@
 #include "IXSocket.h"
 #include "IXSocketConnect.h"
 #include "IXNetSystem.h"
+#include "IXSelectInterrupt.h"
+#include "IXSelectInterruptFactory.h"
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -17,7 +19,10 @@
 #include <sys/types.h>
 
 #include <algorithm>
-#include <iostream>
+
+#ifdef min
+#undef min
+#endif
 
 namespace ix
 {
@@ -28,7 +33,8 @@ namespace ix
     constexpr size_t Socket::kChunkSize;
 
     Socket::Socket(int fd) :
-        _sockfd(fd)
+        _sockfd(fd),
+        _selectInterrupt(createSelectInterrupt())
     {
         ;
     }
@@ -38,73 +44,126 @@ namespace ix
         close();
     }
 
-    void Socket::poll(const OnPollCallback& onPollCallback, int timeoutSecs)
+    PollResultType Socket::poll(bool readyToRead,
+                                int timeoutMs,
+                                int sockfd,
+                                std::shared_ptr<SelectInterrupt> selectInterrupt)
     {
-        if (_sockfd == -1)
+        //
+        // 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];
+
+        fds[0].fd = sockfd;
+        fds[0].events = (readyToRead) ? POLLIN : POLLOUT;
+        fds[0].events |= POLLERR;
+
+        // File descriptor used to interrupt select when needed
+        int interruptFd = -1;
+        if (selectInterrupt)
         {
-            if (onPollCallback) onPollCallback(PollResultType_Error);
-            return;
+            interruptFd = selectInterrupt->getFd();
+
+            if (interruptFd != -1)
+            {
+                nfds = 2;
+                fds[1].fd = interruptFd;
+                fds[1].events = POLLIN;
+            }
         }
 
-        PollResultType pollResult = select(timeoutSecs, 0);
+        int ret = ::poll(fds, nfds, timeoutMs);
 
-        if (onPollCallback) onPollCallback(pollResult);
-    }
-
-    PollResultType Socket::select(int timeoutSecs, int timeoutMs)
-    {
-        fd_set rfds;
-        FD_ZERO(&rfds);
-        FD_SET(_sockfd, &rfds);
-
-        // File descriptor at index 0 in _fildes is the read end of the pipe
-        int eventfd = _eventfd.getFd();
-        if (eventfd != -1)
-        {
-            FD_SET(eventfd, &rfds);
-        }
-
-        struct timeval timeout;
-        timeout.tv_sec = timeoutSecs;
-        timeout.tv_usec = 1000 * timeoutMs;
-
-        // Compute the highest fd.
-        int sockfd = _sockfd;
-        int nfds = (std::max)(sockfd, eventfd);
-
-        int ret = ::select(nfds + 1, &rfds, nullptr, nullptr,
-                           (timeoutSecs < 0) ? nullptr : &timeout);
-
-        PollResultType pollResult = PollResultType_ReadyForRead;
+        PollResultType pollResult = PollResultType::ReadyForRead;
         if (ret < 0)
         {
-            pollResult = PollResultType_Error;
+            pollResult = PollResultType::Error;
         }
         else if (ret == 0)
         {
-            pollResult = PollResultType_Timeout;
+            pollResult = PollResultType::Timeout;
         }
-        else if (eventfd != -1 && FD_ISSET(eventfd, &rfds))
+        else if (interruptFd != -1 && fds[1].revents & POLLIN)
         {
-            uint64_t value = _eventfd.read();
+            uint64_t value = selectInterrupt->read();
 
             if (value == kSendRequest)
             {
-                pollResult = PollResultType_SendRequest;
+                pollResult = PollResultType::SendRequest;
             }
             else if (value == kCloseRequest)
             {
-                pollResult = PollResultType_CloseRequest;
+                pollResult = PollResultType::CloseRequest;
             }
         }
+        else if (sockfd != -1 && readyToRead && fds[0].revents & POLLIN)
+        {
+            pollResult = PollResultType::ReadyForRead;
+        }
+        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;
     }
 
-    // Wake up from poll/select by writing to the pipe which is watched by select
-    bool Socket::wakeUpFromPoll(uint8_t wakeUpCode)
+    PollResultType Socket::isReadyToRead(int timeoutMs)
     {
-        return _eventfd.notify(wakeUpCode);
+        if (_sockfd == -1)
+        {
+            return PollResultType::Error;
+        }
+
+        bool readyToRead = true;
+        return poll(readyToRead, timeoutMs, _sockfd, _selectInterrupt);
+    }
+
+    PollResultType Socket::isReadyToWrite(int timeoutMs)
+    {
+        if (_sockfd == -1)
+        {
+            return PollResultType::Error;
+        }
+
+        bool readyToRead = false;
+        return poll(readyToRead, timeoutMs, _sockfd, _selectInterrupt);
+    }
+
+    // Wake up from poll/select by writing to the pipe which is watched by select
+    bool Socket::wakeUpFromPoll(uint64_t wakeUpCode)
+    {
+        return _selectInterrupt->notify(wakeUpCode);
     }
 
     bool Socket::connect(const std::string& host,
@@ -114,7 +173,7 @@ namespace ix
     {
         std::lock_guard<std::mutex> lock(_socketMutex);
 
-        if (!_eventfd.clear()) return false;
+        if (!_selectInterrupt->clear()) return false;
 
         _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
         return _sockfd != -1;
@@ -157,11 +216,27 @@ namespace ix
 
     int Socket::getErrno()
     {
+        int err;
+
 #ifdef _WIN32
-        return WSAGetLastError();
+        err = WSAGetLastError();
 #else
-        return errno;
+        err = errno;
 #endif
+
+        return err;
+    }
+
+    bool Socket::isWaitNeeded()
+    {
+        int err = getErrno();
+
+        if (err == EWOULDBLOCK || err == EAGAIN || err == EINPROGRESS)
+        {
+            return true;
+        }
+
+        return false;
     }
 
     void Socket::closeSocket(int fd)
@@ -173,46 +248,39 @@ namespace ix
 #endif
     }
 
-    bool Socket::init()
+    bool Socket::init(std::string& errorMsg)
     {
-#ifdef _WIN32
-        INT rc;
-        WSADATA wsaData;
-
-        rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
-        return rc != 0;
-#else
-        return true;
-#endif
-    }
-
-    void Socket::cleanup()
-    {
-#ifdef _WIN32
-        WSACleanup();
-#endif
+        return _selectInterrupt->init(errorMsg);
     }
 
     bool Socket::writeBytes(const std::string& str,
                             const CancellationRequest& isCancellationRequested)
     {
+        int offset = 0;
+        int len = (int) str.size();
+
         while (true)
         {
-            if (isCancellationRequested()) return false;
+            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 write, try again
-            else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
-                                 getErrno() == EAGAIN))
+            // There is possibly something to be writen, try again
+            else if (ret < 0 && Socket::isWaitNeeded())
             {
                 continue;
             }
@@ -229,7 +297,7 @@ namespace ix
     {
         while (true)
         {
-            if (isCancellationRequested()) return false;
+            if (isCancellationRequested && isCancellationRequested()) return false;
 
             ssize_t ret;
             ret = recv(buffer, 1);
@@ -240,13 +308,11 @@ namespace ix
                 return true;
             }
             // There is possibly something to be read, try again
-            else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
-                                 getErrno() == EAGAIN))
+            else if (ret < 0 && Socket::isWaitNeeded())
             {
-                // Wait with a timeout until something is ready to read.
+                // Wait with a 1ms timeout until the socket is ready to read.
                 // This way we are not busy looping
-                int res = select(0, 1);
-                if (res < 0 && (errno == EBADF || errno == EINVAL))
+                if (isReadyToRead(1) == PollResultType::Error)
                 {
                     return false;
                 }
@@ -293,18 +359,20 @@ namespace ix
         std::vector<uint8_t> output;
         while (output.size() != length)
         {
-            if (isCancellationRequested()) return std::make_pair(false, std::string());
+            if (isCancellationRequested && isCancellationRequested())
+            {
+                return std::make_pair(false, std::string());
+            }
 
-            int size = std::min(kChunkSize, length - output.size());
+            size_t size = std::min(kChunkSize, length - output.size());
             ssize_t ret = recv((char*)&_readBuffer[0], size);
 
-            if (ret <= 0 && (getErrno() != EWOULDBLOCK &&
-                             getErrno() != EAGAIN))
+            if (ret <= 0 && !Socket::isWaitNeeded())
             {
                 // Error
                 return std::make_pair(false, std::string());
             }
-            else if (ret > 0)
+            else
             {
                 output.insert(output.end(),
                               _readBuffer.begin(),
@@ -313,9 +381,12 @@ namespace ix
 
             if (onProgressCallback) onProgressCallback((int) output.size(), (int) length);
 
-            // Wait with a timeout until something is ready to read.
+            // Wait with a 1ms timeout until the socket is ready to read.
             // This way we are not busy looping
-            select(0, 1);
+            if (isReadyToRead(1) == PollResultType::Error)
+            {
+                return std::make_pair(false, std::string());
+            }
         }
 
         return std::make_pair(true, std::string(output.begin(),

ixwebsocket/IXSocket.h

@@ -6,45 +6,62 @@
 
 #pragma once
 
-#include <string>
-#include <functional>
-#include <mutex>
 #include <atomic>
+#include <functional>
+#include <memory>
+#include <mutex>
+#include <string>
 #include <vector>
 
 #ifdef _WIN32
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
+
+#undef EWOULDBLOCK
+#undef EAGAIN
+#undef EINPROGRESS
+#undef EBADF
+#undef EINVAL
+
+// map to WSA error codes
+#define EWOULDBLOCK WSAEWOULDBLOCK
+#define EAGAIN WSATRY_AGAIN
+#define EINPROGRESS WSAEINPROGRESS
+#define EBADF WSAEBADF
+#define EINVAL WSAEINVAL
+
 #endif
 
 #include "IXCancellationRequest.h"
 #include "IXProgressCallback.h"
-#include "IXEventFd.h"
 
 namespace ix
 {
-    enum PollResultType
+    class SelectInterrupt;
+
+    enum class PollResultType
     {
-        PollResultType_ReadyForRead = 0,
-        PollResultType_Timeout = 1,
-        PollResultType_Error = 2,
-        PollResultType_SendRequest = 3,
-        PollResultType_CloseRequest = 4
+        ReadyForRead = 0,
+        ReadyForWrite = 1,
+        Timeout = 2,
+        Error = 3,
+        SendRequest = 4,
+        CloseRequest = 5
     };
 
-    class Socket {
+    class Socket
+    {
     public:
-        using OnPollCallback = std::function<void(PollResultType)>;
-
         Socket(int fd = -1);
         virtual ~Socket();
+        bool init(std::string& errorMsg);
 
-        void configure();
+        // Functions to check whether there is activity on the socket
+        PollResultType poll(int timeoutMs = kDefaultPollTimeout);
+        bool wakeUpFromPoll(uint64_t wakeUpCode);
 
-        PollResultType select(int timeoutSecs, int timeoutMs);
-        virtual void poll(const OnPollCallback& onPollCallback,
-                          int timeoutSecs = kDefaultPollTimeout);
-        virtual bool wakeUpFromPoll(uint8_t wakeUpCode);
+        PollResultType isReadyToWrite(int timeoutMs);
+        PollResultType isReadyToRead(int timeoutMs);
 
         // Virtual methods
         virtual bool connect(const std::string& url,
@@ -59,29 +76,29 @@ 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 init(); // Required on Windows to initialize WinSocket
-        static void cleanup(); // Required on Windows to cleanup WinSocket
+        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;
 
     protected:
-        void closeSocket(int fd);
-
         std::atomic<int> _sockfd;
         std::mutex _socketMutex;
 
@@ -93,6 +110,6 @@ namespace ix
         std::vector<uint8_t> _readBuffer;
         static constexpr size_t kChunkSize = 1 << 15;
 
-        EventFd _eventfd;
+        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

@@ -7,6 +7,7 @@
 #include "IXSocketConnect.h"
 #include "IXDNSLookup.h"
 #include "IXNetSystem.h"
+#include "IXSocket.h"
 
 #include <string.h>
 #include <fcntl.h>
@@ -18,18 +19,6 @@
 # include <linux/tcp.h>
 #endif
 
-namespace
-{
-    void closeSocket(int fd)
-    {
-#ifdef _WIN32
-        closesocket(fd);
-#else
-        ::close(fd);
-#endif
-    }
-}
-
 namespace ix
 {
     //
@@ -56,72 +45,53 @@ namespace ix
         // block us for too long
         SocketConnect::configure(fd);
 
-        if (::connect(fd, address->ai_addr, address->ai_addrlen) == -1
-            && errno != EINPROGRESS)
+        int res = ::connect(fd, address->ai_addr, address->ai_addrlen);
+
+        if (res == -1 && !Socket::isWaitNeeded())
         {
-            closeSocket(fd);
-            errMsg = strerror(errno);
+            errMsg = strerror(Socket::getErrno());
+            Socket::closeSocket(fd);
             return -1;
         }
 
         for (;;)
         {
-            if (isCancellationRequested()) // Must handle timeout as well
+            if (isCancellationRequested && isCancellationRequested()) // Must handle timeout as well
             {
-                closeSocket(fd);
+                Socket::closeSocket(fd);
                 errMsg = "Cancelled";
                 return -1;
             }
 
-            // Use select to check the status of the new connection
-            struct timeval timeout;
-            timeout.tv_sec = 0;
-            timeout.tv_usec = 10 * 1000; // 10ms timeout
-            fd_set wfds;
-            fd_set efds;
+            int timeoutMs = 10;
+            bool readyToRead = false;
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, fd);
 
-            FD_ZERO(&wfds);
-            FD_SET(fd, &wfds);
-            FD_ZERO(&efds);
-            FD_SET(fd, &efds);
-
-            if (select(fd + 1, nullptr, &wfds, &efds, &timeout) < 0 &&
-                (errno == EBADF || errno == EINVAL))
+            if (pollResult == PollResultType::Timeout)
             {
-                closeSocket(fd);
-                errMsg = std::string("Connect error, select error: ") + strerror(errno);
+                continue;
+            }
+            else if (pollResult == PollResultType::Error)
+            {
+                Socket::closeSocket(fd);
+                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)
             {
-                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;
             }
         }
 
-        closeSocket(fd);
+        Socket::closeSocket(fd);
         errMsg = "connect timed out after 60 seconds";
         return -1;
     }
@@ -134,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

@@ -6,12 +6,22 @@
 
 #include "IXSocketFactory.h"
 
-#if defined(__APPLE__) or defined(__linux__)
-# ifdef __APPLE__
+#ifdef IXWEBSOCKET_USE_TLS
+
+# ifdef IXWEBSOCKET_USE_MBED_TLS
+#  include <ixwebsocket/IXSocketMbedTLS.h>
+# elif __APPLE__
 #  include <ixwebsocket/IXSocketAppleSSL.h>
-# else
+# elif defined(_WIN32)
+#  include <ixwebsocket/IXSocketSChannel.h>
+# elif defined(IXWEBSOCKET_USE_OPEN_SSL)
 #  include <ixwebsocket/IXSocketOpenSSL.h>
 # endif
+
+#else
+
+#include <ixwebsocket/IXSocket.h>
+
 #endif
 
 namespace ix
@@ -20,23 +30,49 @@ namespace ix
                                          std::string& errorMsg)
     {
         errorMsg.clear();
+        std::shared_ptr<Socket> socket;
 
         if (!tls)
         {
-            return std::make_shared<Socket>();
+            socket = std::make_shared<Socket>();
         }
         else
         {
 #ifdef IXWEBSOCKET_USE_TLS
-# ifdef __APPLE__
-            return std::make_shared<SocketAppleSSL>();
+# 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>();
 # else
-            return std::make_shared<SocketOpenSSL>();
+            socket = std::make_shared<SocketOpenSSL>();
 # endif
 #else
             errorMsg = "TLS support is not enabled on this platform.";
             return nullptr;
 #endif
         }
+
+        if (!socket->init(errorMsg))
+        {
+            socket.reset();
+        }
+
+        return socket;
+    }
+
+    std::shared_ptr<Socket> createSocket(int fd,
+                                         std::string& errorMsg)
+    {
+        errorMsg.clear();
+
+        std::shared_ptr<Socket> socket = std::make_shared<Socket>(fd);
+        if (!socket->init(errorMsg))
+        {
+            socket.reset();
+        }
+
+        return socket;
     }
 }

ixwebsocket/IXSocketFactory.h

@@ -8,10 +8,12 @@
 #pragma once
 
 #include <memory>
+#include <string>
 
 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);
+} // 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>
 
@@ -21,6 +20,7 @@
 namespace ix
 {
     std::atomic<bool> SocketOpenSSL::_openSSLInitializationSuccessful(false);
+    std::once_flag SocketOpenSSL::_openSSLInitFlag;
 
     SocketOpenSSL::SocketOpenSSL(int fd) : Socket(fd),
         _ssl_connection(nullptr),
@@ -240,7 +240,6 @@ namespace ix
         }
     }
 
-    // No wait support
     bool SocketOpenSSL::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg,
@@ -341,7 +340,7 @@ namespace ix
 
             ERR_clear_error();
             ssize_t write_result = SSL_write(_ssl_connection, buf + sent, (int) nbyte);
-            int reason = SSL_get_error(_ssl_connection, write_result);
+            int reason = SSL_get_error(_ssl_connection, (int) write_result);
 
             if (reason == SSL_ERROR_NONE) {
                 nbyte -= write_result;
@@ -361,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)
@@ -381,7 +379,7 @@ namespace ix
                 return read_result;
             }
 
-            int reason = SSL_get_error(_ssl_connection, read_result);
+            int reason = SSL_get_error(_ssl_connection, (int) read_result);
 
             if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
             {

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
 
-        std::once_flag _openSSLInitFlag;
+        static std::once_flag _openSSLInitFlag;
         static std::atomic<bool> _openSSLInitializationSuccessful;
     };
 
-}
+} // namespace ix

ixwebsocket/IXSocketSChannel.cpp

@@ -18,7 +18,6 @@
 # include <ws2def.h>
 # include <WS2tcpip.h>
 # include <schannel.h>
-# include <sslsock.h>
 # include <io.h>
 
 #define WIN32_LEAN_AND_MEAN
@@ -75,7 +74,7 @@ namespace ix
                                  int port,
                                  std::string& errMsg)
     {
-        return Socket::connect(host, port, errMsg);
+        return Socket::connect(host, port, errMsg, nullptr);
     }
 
 
@@ -89,17 +88,17 @@ namespace ix
         Socket::close();
     }
 
-    int SocketSChannel::send(char* buf, size_t nbyte)
+    ssize_t SocketSChannel::send(char* buf, size_t nbyte)
     {
         return Socket::send(buf, nbyte);
     }
 
-    int SocketSChannel::send(const std::string& buffer)
+    ssize_t SocketSChannel::send(const std::string& buffer)
     {
         return Socket::send(buffer);
     }
 
-    int SocketSChannel::recv(void* buf, size_t nbyte)
+    ssize_t SocketSChannel::recv(void* buf, size_t nbyte)
     {
         return Socket::recv(buf, nbyte);
     }

ixwebsocket/IXSocketSChannel.h

@@ -10,25 +10,23 @@
 
 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
         virtual void secureSocket() final;
 
-        virtual int send(char* buffer, size_t length) final;
-        virtual int send(const std::string& buffer) final;
-        virtual int recv(void* buffer, size_t length) 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:
     };
 
-}
+} // namespace ix

ixwebsocket/IXSocketServer.cpp

@@ -11,8 +11,8 @@
 
 #include <iostream>
 #include <sstream>
-#include <future>
 #include <string.h>
+#include <assert.h>
 
 namespace ix
 {
@@ -29,7 +29,10 @@ namespace ix
         _host(host),
         _backlog(backlog),
         _maxConnections(maxConnections),
-        _stop(false)
+        _serverFd(-1),
+        _stop(false),
+        _stopGc(false),
+        _connectionStateFactory(&ConnectionState::createConnectionState)
     {
 
     }
@@ -75,7 +78,7 @@ namespace ix
                << "at address " << _host << ":" << _port
                << " : " << strerror(Socket::getErrno());
 
-            ::close(_serverFd);
+            Socket::closeSocket(_serverFd);
             return std::make_pair(false, ss.str());
         }
 
@@ -99,7 +102,7 @@ namespace ix
                << "at address " << _host << ":" << _port
                << " : " << strerror(Socket::getErrno());
 
-            ::close(_serverFd);
+            Socket::closeSocket(_serverFd);
             return std::make_pair(false, ss.str());
         }
 
@@ -113,7 +116,7 @@ namespace ix
                << "at address " << _host << ":" << _port
                << " : " << strerror(Socket::getErrno());
 
-            ::close(_serverFd);
+            Socket::closeSocket(_serverFd);
             return std::make_pair(false, ss.str());
         }
 
@@ -122,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()
@@ -133,16 +142,66 @@ namespace ix
         _conditionVariable.wait(lock);
     }
 
+    void SocketServer::stopAcceptingConnections()
+    {
+        _stop = true;
+    }
+
     void SocketServer::stop()
     {
-        if (!_thread.joinable()) return; // nothing to do
+        // Stop accepting connections, and close the 'accept' thread
+        if (_thread.joinable())
+        {
+            _stop = true;
+            _thread.join();
+            _stop = false;
+        }
 
-        _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();
-        ::close(_serverFd);
+        Socket::closeSocket(_serverFd);
+    }
+
+    void SocketServer::setConnectionStateFactory(
+        const ConnectionStateFactory& connectionStateFactory)
+    {
+        _connectionStateFactory = connectionStateFactory;
+    }
+
+    //
+    // join the threads for connections that have been closed
+    //
+    // When a connection is closed by a client, the connection state terminated
+    // 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).
+    //
+    void SocketServer::closeTerminatedThreads()
+    {
+        std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
+        auto it = _connectionsThreads.begin();
+        auto itEnd  = _connectionsThreads.end();
+
+        while (it != itEnd)
+        {
+            auto& connectionState = it->first;
+            auto& thread = it->second;
+
+            if (!connectionState->isTerminated())
+            {
+                ++it;
+                continue;
+            }
+
+            if (thread.joinable()) thread.join();
+            it = _connectionsThreads.erase(it);
+        }
     }
 
     void SocketServer::run()
@@ -150,24 +209,16 @@ namespace ix
         // Set the socket to non blocking mode, so that accept calls are not blocking
         SocketConnect::configure(_serverFd);
 
-        // Return value of std::async, ignored
-        std::future<void> f;
-
         for (;;)
         {
             if (_stop) return;
 
-            // 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
+            // Use poll to check whether a new connection is in progress
+            int timeoutMs = 10;
+            bool readyToRead = true;
+            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, _serverFd);
 
-            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: "
@@ -176,26 +227,26 @@ namespace ix
                 continue;
             }
 
-            if (!FD_ISSET(_serverFd, &rfds))
+            if (pollResult != PollResultType::ReadyForRead)
             {
-                // We reached the select timeout, and no new connections are pending
                 continue;
             }
 
             // Accept a connection.
             struct sockaddr_in client; // client address information
             int clientFd;              // socket connected to client
-            socklen_t addressLen = sizeof(socklen_t);
+            socklen_t addressLen = sizeof(client);
             memset(&client, 0, sizeof(client));
 
             if ((clientFd = accept(_serverFd, (struct sockaddr *)&client, &addressLen)) < 0)
             {
-                if (Socket::getErrno() != EWOULDBLOCK)
+                if (!Socket::isWaitNeeded())
                 {
                     // FIXME: that error should be propagated
+                    int err = Socket::getErrno();
                     std::stringstream ss;
                     ss << "SocketServer::run() error accepting connection: "
-                       << strerror(Socket::getErrno());
+                       << err << ", " << strerror(err);
                     logError(ss.str());
                 }
                 continue;
@@ -209,19 +260,52 @@ namespace ix
                    << "Not accepting connection";
                 logError(ss.str());
 
-                ::close(clientFd);
+                Socket::closeSocket(clientFd);
 
                 continue;
             }
 
+            std::shared_ptr<ConnectionState> connectionState;
+            if (_connectionStateFactory)
+            {
+                connectionState = _connectionStateFactory();
+            }
+
+            if (_stop) return;
+
             // Launch the handleConnection work asynchronously in its own thread.
-            //
-            // the destructor of a future returned by std::async blocks,
-            // so we need to declare it outside of this loop
-            f = std::async(std::launch::async,
-                           &SocketServer::handleConnection,
-                           this,
-                           clientFd);
+            std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
+            _connectionsThreads.push_back(std::make_pair(
+                    connectionState,
+                    std::thread(&SocketServer::handleConnection,
+                                this,
+                                clientFd,
+                                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

@@ -6,20 +6,30 @@
 
 #pragma once
 
-#include <utility> // pair
-#include <string>
-#include <set>
-#include <thread>
-#include <mutex>
-#include <functional>
-#include <memory>
+#include "IXConnectionState.h"
 #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>>;
+
         SocketServer(int port = SocketServer::kDefaultPort,
                      const std::string& host = SocketServer::kDefaultHost,
                      int backlog = SocketServer::kDefaultTcpBacklog,
@@ -27,6 +37,11 @@ namespace ix
         virtual ~SocketServer();
         virtual void stop();
 
+        // It is possible to override ConnectionState through inheritance
+        // this method allows user to change the factory by returning an object
+        // that inherits from ConnectionState but has its own methods.
+        void setConnectionStateFactory(const ConnectionStateFactory& connectionStateFactory);
+
         const static int kDefaultPort;
         const static std::string kDefaultHost;
         const static int kDefaultTcpBacklog;
@@ -37,11 +52,12 @@ namespace ix
         void wait();
 
     protected:
-
         // Logging
         void logError(const std::string& str);
         void logInfo(const std::string& str);
 
+        void stopAcceptingConnections();
+
     private:
         // Member variables
         int _port;
@@ -54,15 +70,33 @@ namespace ix
 
         std::mutex _logMutex;
 
+        // 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;
+        std::mutex _connectionsThreadsMutex;
+
+        // used to have the main control thread for a server
+        // wait for a 'terminate' notification without busy polling
         std::condition_variable _conditionVariable;
         std::mutex _conditionVariableMutex;
 
-        // Methods
-        void run();
-        virtual void handleConnection(int fd) = 0;
+        // the factory to create ConnectionState objects
+        ConnectionStateFactory _connectionStateFactory;
+
+        virtual void handleConnection(int fd, std::shared_ptr<ConnectionState> connectionState) = 0;
         virtual size_t getConnectedClientsCount() = 0;
+
+        // Returns true if all connection threads are joined
+        void closeTerminatedThreads();
+        size_t getConnectionsThreadsCount();
     };
-}
+} // namespace ix

ixwebsocket/IXUrlParser.cpp

@@ -5,43 +5,30 @@
  */
 
 #include "IXUrlParser.h"
-
-#include <iostream>
-#include <sstream>
-
+#include "LUrlParser.h"
 
 namespace ix
 {
-    //
-    // The only difference between those 2 regex is the protocol
-    //
-    std::regex UrlParser::_httpRegex("(http|https)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
-    std::regex UrlParser::_webSocketRegex("(ws|wss)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
-
     bool UrlParser::parse(const std::string& url,
                           std::string& protocol,
                           std::string& host,
                           std::string& path,
                           std::string& query,
-                          int& port,
-                          bool websocket)
+                          int& port)
     {
-        std::cmatch what;
-        if (!regex_match(url.c_str(), what,
-                         websocket ? _webSocketRegex : _httpRegex))
+        LUrlParser::clParseURL res = LUrlParser::clParseURL::ParseURL(url);
+
+        if (!res.IsValid())
         {
             return false;
         }
 
-        std::string portStr;
+        protocol = res.m_Scheme;
+        host     = res.m_Host;
+        path     = res.m_Path;
+        query    = res.m_Query;
 
-        protocol = std::string(what[1].first, what[1].second);
-        host     = std::string(what[2].first, what[2].second);
-        portStr  = std::string(what[3].first, what[3].second);
-        path     = std::string(what[4].first, what[4].second);
-        query    = std::string(what[5].first, what[5].second);
-
-        if (portStr.empty())
+        if (!res.GetPort(&port))
         {
             if (protocol == "ws" || protocol == "http")
             {
@@ -58,12 +45,6 @@ namespace ix
                 return false;
             }
         }
-        else
-        {
-            std::stringstream ss;
-            ss << portStr;
-            ss >> port;
-        }
 
         if (path.empty())
         {
@@ -83,22 +64,4 @@ namespace ix
         return true;
     }
 
-    void UrlParser::printUrl(const std::string& url, bool websocket)
-    {
-        std::string protocol, host, path, query;
-        int port {0};
-
-        if (!parse(url, protocol, host, path, query, port, websocket))
-        {
-            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

@@ -7,7 +7,6 @@
 #pragma once
 
 #include <string>
-#include <regex>
 
 namespace ix
 {
@@ -19,13 +18,6 @@ namespace ix
                           std::string& host,
                           std::string& path,
                           std::string& query,
-                          int& port,
-                          bool websocket);
-
-        static void printUrl(const std::string& url, bool websocket);
-
-    private:
-        static std::regex _httpRegex;
-        static std::regex _webSocketRegex;
+                          int& port);
     };
-}
+} // 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/IXWebSocket.cpp

@@ -7,23 +7,65 @@
 #include "IXWebSocket.h"
 #include "IXSetThreadName.h"
 #include "IXWebSocketHandshake.h"
+#include "IXExponentialBackoff.h"
 
-#include <iostream>
 #include <cmath>
 #include <cassert>
 
 namespace
 {
-    uint64_t calculateRetryWaitMilliseconds(uint64_t retry_count)
+    //
+    // Stolen from here http://www.zedwood.com/article/cpp-is-valid-utf8-string-function
+    // There doesn't seem to be anything in the C++ library so far to do that.
+    // The closest thing is code for converting from utf-8 to utf-16 or utf-32 but 
+    // that isn't working well for some broken input strings.
+    //
+    bool isValidUtf8(const std::string& str)
     {
-        // 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);
+        size_t i = 0;
+        size_t ix = str.length();
+        int c, n, j;
+        
+        for (; i < ix; i++)
+        {
+            c = (unsigned char) str[i];
+            //if (c==0x09 || c==0x0a || c==0x0d || (0x20 <= c && c <= 0x7e) ) n = 0; // is_printable_ascii
+            if (0x00 <= c && c <= 0x7f)
+            {
+                n = 0; // 0bbbbbbb
+            }
+            else if ((c & 0xE0) == 0xC0)
+            {
+                n = 1; // 110bbbbb
+            }
+            else if ( c==0xed && i<(ix-1) && ((unsigned char)str[i+1] & 0xa0)==0xa0)
+            {
+                return false; //U+d800 to U+dfff
+            }
+            else if ((c & 0xF0) == 0xE0)
+            {
+                n = 2; // 1110bbbb
+            }
+            else if ((c & 0xF8) == 0xF0)
+            {
+                n = 3; // 11110bbb
+            }
+            //else if (($c & 0xFC) == 0xF8) n=4; // 111110bb //byte 5, unnecessary in 4 byte UTF-8
+            //else if (($c & 0xFE) == 0xFC) n=5; // 1111110b //byte 6, unnecessary in 4 byte UTF-8
+            else
+            {
+                return false;
+            }
 
-        // 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;
+            for (j=0; j<n && i<ix; j++)
+            {   // n bytes matching 10bbbbbb follow ?
+                if ((++i == ix) || (( (unsigned char)str[i] & 0xC0) != 0x80))
+                {
+                    return false;
+                }
+            }
+        }
+        return true;
     }
 }
 
@@ -31,21 +73,29 @@ namespace ix
 {
     OnTrafficTrackerCallback WebSocket::_onTrafficTrackerCallback = nullptr;
     const int WebSocket::kDefaultHandShakeTimeoutSecs(60);
-    const int WebSocket::kDefaultHeartBeatPeriod(-1);
+    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),
-        _heartBeatPeriod(kDefaultHeartBeatPeriod)
+        _enablePong(kDefaultEnablePong),
+        _pingIntervalSecs(kDefaultPingIntervalSecs),
+        _pingTimeoutSecs(kDefaultPingTimeoutSecs)
     {
         _ws.setOnCloseCallback(
-            [this](uint16_t code, const std::string& reason, size_t wireSize)
+            [this](uint16_t code, const std::string& reason, size_t wireSize, bool remote)
             {
-                _onMessageCallback(WebSocket_MessageType_Close, "", wireSize,
-                                   WebSocketErrorInfo(), WebSocketOpenInfo(),
-                                   WebSocketCloseInfo(code, reason));
+                _onMessageCallback(
+                    std::make_shared<WebSocketMessage>(
+                        WebSocketMessageType::Close, "", wireSize,
+                        WebSocketErrorInfo(), WebSocketOpenInfo(),
+                        WebSocketCloseInfo(code, reason, remote)));
             }
         );
     }
@@ -60,6 +110,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
     {
@@ -79,16 +134,71 @@ namespace ix
         return _perMessageDeflateOptions;
     }
 
-    void WebSocket::setHeartBeatPeriod(int hearBeatPeriod)
+    void WebSocket::setHeartBeatPeriod(int heartBeatPeriodSecs)
     {
         std::lock_guard<std::mutex> lock(_configMutex);
-        _heartBeatPeriod = hearBeatPeriod;
+        _pingIntervalSecs = heartBeatPeriodSecs;
     }
 
     int WebSocket::getHeartBeatPeriod() const
     {
         std::lock_guard<std::mutex> lock(_configMutex);
-        return _heartBeatPeriod;
+        return _pingIntervalSecs;
+    }
+
+    void WebSocket::setPingInterval(int pingIntervalSecs)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _pingIntervalSecs = pingIntervalSecs;
+    }
+
+    int WebSocket::getPingInterval() const
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        return _pingIntervalSecs;
+    }
+
+    void WebSocket::setPingTimeout(int pingTimeoutSecs)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _pingTimeoutSecs = pingTimeoutSecs;
+    }
+
+    int WebSocket::getPingTimeout() const
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        return _pingTimeoutSecs;
+    }
+
+    void WebSocket::enablePong()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _enablePong = true;
+    }
+
+    void WebSocket::disablePong()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _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()
@@ -98,26 +208,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)
@@ -125,19 +228,23 @@ namespace ix
         {
             std::lock_guard<std::mutex> lock(_configMutex);
             _ws.configure(_perMessageDeflateOptions,
-                          _heartBeatPeriod);
+                          _enablePong,
+                          _pingIntervalSecs,
+                          _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;
     }
 
@@ -145,7 +252,10 @@ namespace ix
     {
         {
             std::lock_guard<std::mutex> lock(_configMutex);
-            _ws.configure(_perMessageDeflateOptions, _heartBeatPeriod);
+            _ws.configure(_perMessageDeflateOptions,
+                          _enablePong,
+                          _pingIntervalSecs,
+                          _pingTimeoutSecs);
         }
 
         WebSocketInitResult status = _ws.connectToSocket(fd, timeoutSecs);
@@ -154,82 +264,116 @@ 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;
 
+        uint32_t retries = 0;
+        millis duration(0);
+
+        // Try to connect perpertually
         while (true)
         {
-            if (isConnected() || isClosing() || _stop || !_automaticReconnection)
+            if (isConnected() || isClosing() || _stop)
             {
                 break;
             }
 
-            status = connect(_handshakeTimeoutSecs);
-
-            if (!status.success && !_stop)
+            if (!firstConnectionAttempt && !_automaticReconnection)
             {
-                duration = millis(calculateRetryWaitMilliseconds(retries++));
+                // Do not attempt to reconnect
+                break;
+            }
 
-                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());
+            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)
+            {
+                WebSocketErrorInfo connectErr;
+
+                if (_automaticReconnection)
+                {
+                    duration = millis(calculateRetryWaitMilliseconds(retries++, _maxWaitBetweenReconnectionRetries));
+
+                    connectErr.wait_time = duration.count();
+                    connectErr.retries = retries;
+                }
+
+                connectErr.reason      = status.errorStr;
+                connectErr.http_status = status.http_status;
+
+                _onMessageCallback(
+                     std::make_shared<WebSocketMessage>(
+                        WebSocketMessageType::Error, "", 0,
+                        connectErr, WebSocketOpenInfo(),
+                        WebSocketCloseInfo()));
+            }
         }
     }
 
     void WebSocket::run()
     {
-        setThreadName(_url);
+        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,
@@ -238,41 +382,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);
                 });
-
-            // 4. In blocking mode, getting out of this function is triggered by
-            //    an explicit disconnection from the callback, or by the remote end
-            //    closing the connection, ie isConnected() == false.
-            if (!_thread.joinable() && !isConnected() && !_automaticReconnection) return;
         }
     }
 
@@ -299,10 +443,30 @@ namespace ix
         }
     }
 
-    WebSocketSendInfo WebSocket::send(const std::string& text,
+    WebSocketSendInfo WebSocket::send(const std::string& data,
+                                      bool binary,
                                       const OnProgressCallback& onProgressCallback)
     {
-        return sendMessage(text, false, onProgressCallback);
+        return sendMessage(data,
+                           (binary) ? SendMessageKind::Binary: SendMessageKind::Text,
+                           onProgressCallback);
+    }
+
+    WebSocketSendInfo WebSocket::sendBinary(const std::string& text,
+                                            const OnProgressCallback& onProgressCallback)
+    {
+        return sendMessage(text, SendMessageKind::Binary, onProgressCallback);
+    }
+
+    WebSocketSendInfo WebSocket::sendText(const std::string& text,
+                                          const OnProgressCallback& onProgressCallback)
+    {
+        if (!isValidUtf8(text))
+        {
+            stop();
+            return false;
+        }
+        return sendMessage(text, SendMessageKind::Text, onProgressCallback);
     }
 
     WebSocketSendInfo WebSocket::ping(const std::string& text)
@@ -311,11 +475,11 @@ namespace ix
         constexpr size_t pingMaxPayloadSize = 125;
         if (text.size() > pingMaxPayloadSize) return WebSocketSendInfo(false);
 
-        return sendMessage(text, true);
+        return sendMessage(text, SendMessageKind::Ping);
     }
 
     WebSocketSendInfo WebSocket::sendMessage(const std::string& text,
-                                             bool ping,
+                                             SendMessageKind sendMessageKind,
                                              const OnProgressCallback& onProgressCallback)
     {
         if (!isConnected()) return WebSocketSendInfo(false);
@@ -332,13 +496,22 @@ namespace ix
         std::lock_guard<std::mutex> lock(_writeMutex);
         WebSocketSendInfo webSocketSendInfo;
 
-        if (ping)
+        switch (sendMessageKind)
         {
-            webSocketSendInfo = _ws.sendPing(text);
-        }
-        else
-        {
-            webSocketSendInfo = _ws.sendBinary(text, onProgressCallback);
+            case SendMessageKind::Text:
+            {
+                webSocketSendInfo = _ws.sendText(text, onProgressCallback);
+            } break;
+
+            case SendMessageKind::Binary:
+            {
+                webSocketSendInfo = _ws.sendBinary(text, onProgressCallback);
+            } break;
+
+            case SendMessageKind::Ping:
+            {
+                webSocketSendInfo = _ws.sendPing(text);
+            } break;
         }
 
         WebSocket::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize, false);
@@ -350,11 +523,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;
         }
     }
 
@@ -362,11 +535,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";
         }
     }
 
@@ -380,6 +553,11 @@ namespace ix
         _automaticReconnection = false;
     }
 
+    bool WebSocket::isAutomaticReconnectionEnabled() const
+    {
+        return _automaticReconnection;
+    }
+
     size_t WebSocket::bufferedAmount() const
     {
         return _ws.bufferedAmount();

ixwebsocket/IXWebSocket.h

@@ -9,74 +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;
-
-        WebSocketCloseInfo(uint16_t c = 0,
-                           const std::string& r = std::string())
-            : code(c)
-            , reason(r)
-        {
-            ;
-        }
-    };
-
-    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)>;
 
@@ -87,55 +44,80 @@ namespace ix
         ~WebSocket();
 
         void setUrl(const std::string& url);
-        void setPerMessageDeflateOptions(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
-        void setHandshakeTimeout(int handshakeTimeoutSecs);
-        void setHeartBeatPeriod(int hearBeatPeriod);
+
+        // 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;
+        int getPingInterval() const;
+        int getPingTimeout() const;
         size_t bufferedAmount() const;
 
         void enableAutomaticReconnection();
         void disableAutomaticReconnection();
+        bool isAutomaticReconnectionEnabled() const;
+        void setMaxWaitBetweenReconnectionRetries(uint32_t maxWaitBetweenReconnectionRetries);
+        uint32_t getMaxWaitBetweenReconnectionRetries() const;
 
     private:
-
         WebSocketSendInfo sendMessage(const std::string& text,
-                                      bool ping,
+                                      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
 
@@ -143,17 +125,27 @@ 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;
 
-        // Optional Heartbeat
-        int _heartBeatPeriod;
-        static const int kDefaultHeartBeatPeriod;
+        // enable or disable PONG frame response to received PING frame
+        bool _enablePong;
+        static const bool kDefaultEnablePong;
+
+        // Optional ping and pong timeout
+        int _pingIntervalSecs;
+        int _pingTimeoutSecs;
+        static const int kDefaultPingIntervalSecs;
+        static const int kDefaultPingTimeoutSecs;
 
         friend class WebSocketServer;
     };
-}
+} // namespace ix

ixwebsocket/IXWebSocketCloseConstants.cpp

@@ -0,0 +1,26 @@
+/*
+ *  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::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");
+}

ixwebsocket/IXWebSocketCloseConstants.h

@@ -0,0 +1,32 @@
+/*
+ *  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 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;
+    };
+} // 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,12 +7,12 @@
 #include "IXWebSocketHandshake.h"
 #include "IXSocketConnect.h"
 #include "IXUrlParser.h"
+#include "IXHttp.h"
+#include "IXUserAgent.h"
 
 #include "libwshandshake.hpp"
 
-#include <iostream>
 #include <sstream>
-#include <regex>
 #include <random>
 #include <algorithm>
 
@@ -33,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(),
@@ -52,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 =
@@ -114,7 +71,7 @@ namespace ix
         std::stringstream ss;
         ss << "HTTP/1.1 ";
         ss << code;
-        ss << "\r\n";
+        ss << " ";
         ss << reason;
         ss << "\r\n";
 
@@ -132,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,
@@ -171,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();
@@ -244,7 +213,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");
@@ -266,7 +235,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");
             }
         }
 
@@ -296,7 +265,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);
@@ -350,10 +319,10 @@ namespace ix
         }
 
         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\r\n";
+        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";

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.cpp

@@ -6,12 +6,28 @@
 
 #include "IXWebSocketHttpHeaders.h"
 #include "IXSocket.h"
-
-#include <string>
-#include <unordered_map>
+#include <algorithm>
+#include <locale>
 
 namespace ix
 {
+    bool CaseInsensitiveLess::NocaseCompare::operator()(const unsigned char & c1, const unsigned char & c2) const
+    {
+#ifdef _WIN32
+        return std::tolower(c1, std::locale()) < std::tolower(c2, std::locale());
+#else
+        return std::tolower(c1) < std::tolower(c2);
+#endif
+    }
+
+    bool CaseInsensitiveLess::operator()(const std::string & s1, const std::string & s2) const
+    {
+        return std::lexicographical_compare
+                (s1.begin(), s1.end(),   // source range
+                 s2.begin(), s2.end(),   // dest range
+                 NocaseCompare());       // comparison
+    }
+
     std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
         std::shared_ptr<Socket> socket,
         const CancellationRequest& isCancellationRequested)