Deployed dc8807ec with MkDocs version: 1.5.3

.clang-format

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

.dockerignore

@@ -1,5 +0,0 @@
-build
-CMakeCache.txt
-ws/CMakeCache.txt
-test/build
-makefile

.github/workflows/docker.yml

@@ -1,66 +0,0 @@
-name: docker
-
-# When its time to do a release do a build for amd64
-# and push all of them to Docker Hub.
-# Only trigger on semver shaped tags.
-on:
-  push:
-    tags:
-      - "v*.*.*"
-
-jobs:
-  login:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - name: Prepare
-        id: prep
-        run: |
-          DOCKER_IMAGE=machinezone/ws
-          VERSION=edge
-          if [[ $GITHUB_REF == refs/tags/* ]]; then
-            VERSION=${GITHUB_REF#refs/tags/v}
-          fi
-          if [ "${{ github.event_name }}" = "schedule" ]; then
-            VERSION=nightly
-          fi
-          TAGS="${DOCKER_IMAGE}:${VERSION}"
-          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
-            TAGS="$TAGS,${DOCKER_IMAGE}:latest"
-          fi
-          echo ::set-output name=tags::${TAGS}
-
-      - name: Set up Docker Buildx
-        id: buildx
-        uses: docker/setup-buildx-action@master
-
-      - name: Cache Docker layers
-        uses: actions/cache@v2
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-
-      - name: Login to GitHub Package Registry
-        uses: docker/login-action@v1
-        with:
-          registry: ghcr.io
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GHCR_TOKEN }}
-
-      - name: Build and push
-        id: docker_build
-        uses: docker/build-push-action@v2-build-push
-        with:
-          builder: ${{ steps.buildx.outputs.name }}
-          context: .
-          file: ./Dockerfile
-          target: prod
-          platforms: linux/amd64
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.prep.outputs.tags }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/mkdocs.yml

@@ -1,25 +0,0 @@
-name: mkdocs
-on:
-  push:
-    paths:
-    - 'docs/**'
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.8
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.8
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install mkdocs
-        pip install mkdocs-material
-        pip install pygments
-    - name: Build doc
-      run: |
-        git pull
-        mkdocs gh-deploy

.github/workflows/stale.yml

@@ -1,19 +0,0 @@
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: "0 0 * * *"
-
-jobs:
-  stale:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/stale@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'Stale issue message'
-        stale-pr-message: 'Stale pull request message'
-        stale-issue-label: 'no-issue-activity'
-        stale-pr-label: 'no-pr-activity'

.github/workflows/unittest_linux.yml

@@ -1,14 +0,0 @@
-name: linux
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - name: make test
-      run: make -f makefile.dev test

.github/workflows/unittest_linux_asan.yml

@@ -1,14 +0,0 @@
-name: linux_asan
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - name: make test_asan
-      run: make -f makefile.dev test_asan

.github/workflows/unittest_mac_tsan_mbedtls.yml

@@ -1,16 +0,0 @@
-name: mac_tsan_mbedtls
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  mac_tsan_mbedtls:
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - name: install mbedtls
-      run: brew install mbedtls
-    - name: make test
-      run: make -f makefile.dev test_tsan_mbedtls

.github/workflows/unittest_mac_tsan_openssl.yml

@@ -1,16 +0,0 @@
-name: mac_tsan_openssl
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  mac_tsan_openssl:
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - name: install openssl
-      run: brew install openssl@1.1
-    - name: make test
-      run: make -f makefile.dev test_tsan_openssl

.github/workflows/unittest_mac_tsan_sectransport.yml

@@ -1,14 +0,0 @@
-name: mac_tsan_sectransport
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  mac_tsan_sectransport:
-    runs-on: macOS-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - name: make test_tsan_sectransport
-      run: make -f makefile.dev test_tsan_sectransport

.github/workflows/unittest_uwp.yml

@@ -1,44 +0,0 @@
-name: uwp
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  uwp:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-vsdevenv@master
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - run: |
-        mkdir build
-        cd build
-        cmake -GNinja -DCMAKE_TOOLCHAIN_FILE=c:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_SYSTEM_NAME=WindowsStore -DCMAKE_SYSTEM_VERSION="10.0" -DCMAKE_CXX_COMPILER=cl.exe -DCMAKE_C_COMPILER=cl.exe -DUSE_TEST=1 -DUSE_ZLIB=0 ..
-    - run: |
-        cd build
-        ninja
-    - run: |
-        cd build
-        ninja test
-
-#
-#   Windows with OpenSSL is working but disabled as it takes 13 minutes (10 for openssl) to build with vcpkg
-#
-#   windows_openssl:
-#     runs-on: windows-latest
-#     steps:
-#     - uses: actions/checkout@v1
-#     - uses: seanmiddleditch/gha-setup-vsdevenv@master
-#     - run: |
-#         vcpkg install zlib:x64-windows
-#         vcpkg install openssl:x64-windows
-#     - run: |
-#         mkdir build
-#         cd build
-#         cmake -DCMAKE_TOOLCHAIN_FILE=c:/vcpkg/scripts/buildsystems/vcpkg.cmake -DCMAKE_CXX_COMPILER=cl.exe -DUSE_OPEN_SSL=1 -DUSE_TLS=1 -DUSE_WS=1 -DUSE_TEST=1 ..
-#     - run: cmake --build build
-# 
-#     # Running the unittest does not work, the binary cannot be found
-#     #- run: ../build/test/ixwebsocket_unittest.exe
-#     # working-directory: test

.github/workflows/unittest_windows.yml

@@ -1,26 +0,0 @@
-name: windows
-on:
-  push:
-    paths-ignore:
-    - 'docs/**'
-
-jobs:
-  windows:
-    runs-on: windows-latest
-    steps:
-    - uses: actions/checkout@v1
-    - uses: seanmiddleditch/gha-setup-vsdevenv@master
-    - uses: seanmiddleditch/gha-setup-ninja@master
-    - run: |
-        mkdir build
-        cd build
-        cmake -GNinja -DCMAKE_CXX_COMPILER=cl.exe -DCMAKE_C_COMPILER=cl.exe -DUSE_WS=1 -DUSE_TEST=1 -DUSE_ZLIB=0 ..
-    - run: |
-        cd build
-        ninja
-    - run: |
-        cd build
-        ninja test
-
-#- run: ../build/test/ixwebsocket_unittest.exe
-# working-directory: test

.gitignore

@@ -1,10 +0,0 @@
-build
-*.pyc
-venv
-ixsnake/ixsnake/.certs/
-site/
-ws/.certs/
-ws/.srl
-ixhttpd
-makefile
-a.out

.pre-commit-config.yaml

@@ -1,12 +0,0 @@
-repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.5.0
-    hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/pocc/pre-commit-hooks
-    rev: v1.1.1
-    hooks:
-    -    id: clang-format
-         args: [-i, -style=file]

404.html

@@ -0,0 +1,159 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        
+        
+        
+        <link rel="shortcut icon" href="/img/favicon.ico">
+        <title>IXWebSocket</title>
+        <link href="/css/bootstrap.min.css" rel="stylesheet">
+        <link href="/css/font-awesome.min.css" rel="stylesheet">
+        <link href="/css/base.css" rel="stylesheet">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+        <script>hljs.highlightAll();</script> 
+    </head>
+
+    <body>
+        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
+            <div class="container">
+                <a class="navbar-brand" href="/.">IXWebSocket</a>
+                <!-- Expander button -->
+                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <!-- Expanded navigation -->
+                <div id="navbar-collapse" class="navbar-collapse collapse">
+                        <!-- Main navigation -->
+                        <ul class="nav navbar-nav">
+                            <li class="navitem">
+                                <a href="/." class="nav-link">Home</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/CHANGELOG/" class="nav-link">Changelog</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/build/" class="nav-link">Build</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/design/" class="nav-link">Design</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/packages/" class="nav-link">Packages</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/performance/" class="nav-link">Performance</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/usage/" class="nav-link">Examples</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="/ws/" class="nav-link">Ws</a>
+                            </li>
+                        </ul>
+
+                    <ul class="nav navbar-nav ml-auto">
+                        <li class="nav-item">
+                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
+                                <i class="fa fa-search"></i> Search
+                            </a>
+                        </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            <div class="row">
+
+    <div class="row-fluid">
+      <div id="main-content" class="span12">
+        <h1 id="404-page-not-found" style="text-align: center">404</h1>
+        <p style="text-align: center"><strong>Page not found</strong></p>
+      </div>
+    </div>
+
+
+            </div>
+        </div>
+
+        <footer class="col-md-12">
+            <hr>
+            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
+        </footer>
+        <script src="/js/jquery-3.6.0.min.js"></script>
+        <script src="/js/bootstrap.min.js"></script>
+        <script>
+            var base_url = "/",
+                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
+        </script>
+        <script src="/js/base.js"></script>
+        <script src="/search/main.js"></script>
+
+        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="searchModalLabel">Search</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+                <p>From here you can search these documents. Enter your search terms below.</p>
+                <form>
+                    <div class="form-group">
+                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results" data-no-results-text="No results found"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+
+    </body>
+</html>

CMake/FindDeflate.cmake

@@ -1,19 +0,0 @@
-# Find package structure taken from libcurl
-
-include(FindPackageHandleStandardArgs)
-
-find_path(DEFLATE_INCLUDE_DIRS libdeflate.h)
-find_library(DEFLATE_LIBRARY deflate)
-
-find_package_handle_standard_args(Deflate
-    FOUND_VAR
-      DEFLATE_FOUND
-    REQUIRED_VARS
-      DEFLATE_LIBRARY
-      DEFLATE_INCLUDE_DIRS
-    FAIL_MESSAGE
-      "Could NOT find deflate"
-)
-
-set(DEFLATE_INCLUDE_DIRS ${DEFLATE_INCLUDE_DIRS})
-set(DEFLATE_LIBRARIES ${DEFLATE_LIBRARY})

CMake/FindMbedTLS.cmake

@@ -1,13 +0,0 @@
-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)

CMake/FindSpdLog.cmake

@@ -1,19 +0,0 @@
-# Find package structure taken from libcurl
-
-include(FindPackageHandleStandardArgs)
-
-find_path(SPDLOG_INCLUDE_DIRS spdlog/spdlog.h)
-find_library(JSONCPP_LIBRARY spdlog)
-
-find_package_handle_standard_args(SPDLOG
-    FOUND_VAR
-    SPDLOG_FOUND
-    REQUIRED_VARS
-      SPDLOG_LIBRARY
-      SPDLOG_INCLUDE_DIRS
-    FAIL_MESSAGE
-      "Could NOT find spdlog"
-)
-
-set(SPDLOG_INCLUDE_DIRS ${SPDLOG_INCLUDE_DIRS})
-set(SPDLOG_LIBRARIES ${SPDLOG_LIBRARY})

CMakeLists.txt

@@ -1,275 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
-#
-
-cmake_minimum_required(VERSION 3.4.1...3.17.2)
-set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMake;${CMAKE_MODULE_PATH}")
-
-project(ixwebsocket C CXX)
-
-set (CMAKE_CXX_STANDARD 11)
-set (CXX_STANDARD_REQUIRED ON)
-set (CMAKE_CXX_EXTENSIONS OFF)
-
-if (${CMAKE_SYSTEM_NAME} MATCHES "Linux")
-  set(CMAKE_POSITION_INDEPENDENT_CODE ON)
-endif()
-
-if (UNIX)
-  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/IXBench.cpp
-    ixwebsocket/IXCancellationRequest.cpp
-    ixwebsocket/IXConnectionState.cpp
-    ixwebsocket/IXDNSLookup.cpp
-    ixwebsocket/IXExponentialBackoff.cpp
-    ixwebsocket/IXGetFreePort.cpp
-    ixwebsocket/IXGzipCodec.cpp
-    ixwebsocket/IXHttp.cpp
-    ixwebsocket/IXHttpClient.cpp
-    ixwebsocket/IXHttpServer.cpp
-    ixwebsocket/IXNetSystem.cpp
-    ixwebsocket/IXSelectInterrupt.cpp
-    ixwebsocket/IXSelectInterruptFactory.cpp
-    ixwebsocket/IXSelectInterruptPipe.cpp
-    ixwebsocket/IXSetThreadName.cpp
-    ixwebsocket/IXSocket.cpp
-    ixwebsocket/IXSocketConnect.cpp
-    ixwebsocket/IXSocketFactory.cpp
-    ixwebsocket/IXSocketServer.cpp
-    ixwebsocket/IXSocketTLSOptions.cpp
-    ixwebsocket/IXStrCaseCompare.cpp
-    ixwebsocket/IXUdpSocket.cpp
-    ixwebsocket/IXUrlParser.cpp
-    ixwebsocket/IXUuid.cpp
-    ixwebsocket/IXUserAgent.cpp
-    ixwebsocket/IXWebSocket.cpp
-    ixwebsocket/IXWebSocketCloseConstants.cpp
-    ixwebsocket/IXWebSocketHandshake.cpp
-    ixwebsocket/IXWebSocketHttpHeaders.cpp
-    ixwebsocket/IXWebSocketPerMessageDeflate.cpp
-    ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
-    ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
-    ixwebsocket/IXWebSocketProxyServer.cpp
-    ixwebsocket/IXWebSocketServer.cpp
-    ixwebsocket/IXWebSocketTransport.cpp
-)
-
-set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXBench.h
-    ixwebsocket/IXCancellationRequest.h
-    ixwebsocket/IXConnectionState.h
-    ixwebsocket/IXDNSLookup.h
-    ixwebsocket/IXExponentialBackoff.h
-    ixwebsocket/IXGetFreePort.h
-    ixwebsocket/IXGzipCodec.h
-    ixwebsocket/IXHttp.h
-    ixwebsocket/IXHttpClient.h
-    ixwebsocket/IXHttpServer.h
-    ixwebsocket/IXNetSystem.h
-    ixwebsocket/IXProgressCallback.h
-    ixwebsocket/IXSelectInterrupt.h
-    ixwebsocket/IXSelectInterruptFactory.h
-    ixwebsocket/IXSelectInterruptPipe.h
-    ixwebsocket/IXSetThreadName.h
-    ixwebsocket/IXSocket.h
-    ixwebsocket/IXSocketConnect.h
-    ixwebsocket/IXSocketFactory.h
-    ixwebsocket/IXSocketServer.h
-    ixwebsocket/IXSocketTLSOptions.h
-    ixwebsocket/IXStrCaseCompare.h
-    ixwebsocket/IXUdpSocket.h
-    ixwebsocket/IXUrlParser.h
-    ixwebsocket/IXUuid.h
-    ixwebsocket/IXUtf8Validator.h
-    ixwebsocket/IXUserAgent.h
-    ixwebsocket/IXWebSocket.h
-    ixwebsocket/IXWebSocketCloseConstants.h
-    ixwebsocket/IXWebSocketCloseInfo.h
-    ixwebsocket/IXWebSocketErrorInfo.h
-    ixwebsocket/IXWebSocketHandshake.h
-    ixwebsocket/IXWebSocketHandshakeKeyGen.h
-    ixwebsocket/IXWebSocketHttpHeaders.h
-    ixwebsocket/IXWebSocketInitResult.h
-    ixwebsocket/IXWebSocketMessage.h
-    ixwebsocket/IXWebSocketMessageType.h
-    ixwebsocket/IXWebSocketOpenInfo.h
-    ixwebsocket/IXWebSocketPerMessageDeflate.h
-    ixwebsocket/IXWebSocketPerMessageDeflateCodec.h
-    ixwebsocket/IXWebSocketPerMessageDeflateOptions.h
-    ixwebsocket/IXWebSocketProxyServer.h
-    ixwebsocket/IXWebSocketSendInfo.h
-    ixwebsocket/IXWebSocketServer.h
-    ixwebsocket/IXWebSocketTransport.h
-    ixwebsocket/IXWebSocketVersion.h
-)
-
-option(USE_TLS "Enable TLS support" FALSE)
-
-if (USE_TLS)
-    # default to securetranport on Apple if nothing is configured
-    if (APPLE)
-      if (NOT USE_MBED_TLS AND NOT USE_OPEN_SSL) # unless we want something else
-        set(USE_SECURE_TRANSPORT ON)
-      endif()
-    # default to mbedtls on windows if nothing is configured
-    elseif (WIN32)
-      if (NOT USE_OPEN_SSL) # unless we want something else
-        set(USE_MBED_TLS ON)
-      endif()
-    else() # default to OpenSSL on all other platforms
-      if (NOT USE_MBED_TLS) # Unless mbedtls is requested
-        set(USE_OPEN_SSL ON)
-      endif()
-    endif()
-
-    if (USE_MBED_TLS)
-        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketMbedTLS.h)
-        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketMbedTLS.cpp)
-    elseif (USE_SECURE_TRANSPORT)
-        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
-        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.cpp)
-    elseif (USE_OPEN_SSL)
-        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketOpenSSL.h)
-        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketOpenSSL.cpp)
-    else()
-        message(FATAL_ERROR "TLS Configuration error: unknown backend")
-    endif()
-endif()
-
-add_library( ixwebsocket STATIC
-    ${IXWEBSOCKET_SOURCES}
-    ${IXWEBSOCKET_HEADERS}
-)
-
-if (USE_TLS)
-    target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_TLS)
-    if (USE_MBED_TLS)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_MBED_TLS)
-    elseif (USE_OPEN_SSL)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
-    elseif (USE_SECURE_TRANSPORT)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_SECURE_TRANSPORT)
-    else()
-        message(FATAL_ERROR "TLS Configuration error: unknown backend")
-    endif()
-endif()
-
-if (USE_TLS)
-  if (USE_OPEN_SSL)
-    message(STATUS "TLS configured to use openssl")
-
-    # Help finding Homebrew's OpenSSL on macOS
-    if (APPLE)
-      set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /usr/local/opt/openssl/lib)
-      set(CMAKE_INCLUDE_PATH ${CMAKE_INCLUDE_PATH} /usr/local/opt/openssl/include)
-
-      # This is for MacPort OpenSSL 1.0
-      # set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /opt/local/lib/openssl-1.0)
-      # set(CMAKE_INCLUDE_PATH ${CMAKE_INCLUDE_PATH} /opt/local/include/openssl-1.0)
-    endif()
-
-    # Use OPENSSL_ROOT_DIR CMake variable if you need to use your own openssl
-    find_package(OpenSSL REQUIRED) 
-    message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
-
-    add_definitions(${OPENSSL_DEFINITIONS})
-    target_include_directories(ixwebsocket PUBLIC ${OPENSSL_INCLUDE_DIR})
-    target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
-  elseif (USE_MBED_TLS)
-    message(STATUS "TLS configured to use mbedtls")
-
-    find_package(MbedTLS REQUIRED)
-    target_include_directories(ixwebsocket PUBLIC ${MBEDTLS_INCLUDE_DIRS})
-    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
-  elseif (USE_SECURE_TRANSPORT)
-    message(STATUS "TLS configured to use secure transport")
-    target_link_libraries(ixwebsocket "-framework Foundation" "-framework Security")
-  endif()
-endif()
-
-option(USE_ZLIB "Enable zlib support" TRUE)
-
-if (USE_ZLIB)
-  # Use ZLIB_ROOT CMake variable if you need to use your own zlib
-  find_package(ZLIB REQUIRED)
-  include_directories(${ZLIB_INCLUDE_DIRS})
-  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
-
-  target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_ZLIB)
-endif()
-
-# brew install libdeflate
-find_package(Deflate)
-if (DEFLATE_FOUND)
-  include_directories(${DEFLATE_INCLUDE_DIRS})
-  target_link_libraries(ixwebsocket ${DEFLATE_LIBRARIES})
-  target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_DEFLATE)
-endif()
-
-if (WIN32)
-  target_link_libraries(ixwebsocket wsock32 ws2_32 shlwapi)
-  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-
-  if (USE_TLS)
-    target_link_libraries(ixwebsocket Crypt32)
-  endif()
-endif()
-
-if (UNIX)
-  find_package(Threads)
-  target_link_libraries(ixwebsocket ${CMAKE_THREAD_LIBS_INIT})
-endif()
-
-
-set( IXWEBSOCKET_INCLUDE_DIRS
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-    # Build with Multiple Processes
-    target_compile_options(ixwebsocket PRIVATE /MP)
-endif()
-
-target_include_directories(ixwebsocket PUBLIC
-  $<BUILD_INTERFACE:${IXWEBSOCKET_INCLUDE_DIRS}/>
-  $<INSTALL_INTERFACE:include/ixwebsocket>
-)
-
-set_target_properties(ixwebsocket PROPERTIES PUBLIC_HEADER "${IXWEBSOCKET_HEADERS}")
-
-install(TARGETS ixwebsocket
-        EXPORT ixwebsocket
-        ARCHIVE DESTINATION lib
-        PUBLIC_HEADER DESTINATION include/ixwebsocket/
-)
-
-install(EXPORT ixwebsocket
-        FILE ixwebsocket-config.cmake
-        NAMESPACE ixwebsocket::
-        DESTINATION lib/cmake/ixwebsocket)
-
-if (USE_WS OR USE_TEST)
-  include(FetchContent)
-  FetchContent_Declare(spdlog
-      GIT_REPOSITORY "https://github.com/gabime/spdlog"
-      GIT_TAG "v1.8.0"
-      GIT_SHALLOW 1) 
-
-  FetchContent_MakeAvailable(spdlog)
-
-  if (USE_WS)
-    add_subdirectory(ws)
-  endif()
-  if (USE_TEST)
-    enable_testing()
-    add_subdirectory(test)
-  endif()
-endif()

Dockerfile

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

LICENSE.txt

@@ -1,29 +0,0 @@
-Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the
-   distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived
-   from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,135 +0,0 @@
-## Hello world
-
-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.
-
-It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android). It was tested on macOS, iOS, Linux, Android, Windows and FreeBSD. Note that the MinGW compiler is not supported at this point. Two important design goals are simplicity and correctness.
-
-A bad security bug affecting users compiling with SSL enabled and OpenSSL as the backend was just fixed in newly released version 11.0.0. Please upgrade ! (more details in the [https://github.com/machinezone/IXWebSocket/pull/250](PR).
-
-```cpp
-/*
- *  main.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- *
- *  Super simple standalone example. See ws folder, unittest and doc/usage.md for more.
- *
- *  On macOS
- *  $ mkdir -p build ; (cd build ; cmake -DUSE_TLS=1 .. ; make -j ; make install)
- *  $ clang++ --std=c++11 --stdlib=libc++ main.cpp -lixwebsocket -lz -framework Security -framework Foundation
- *  $ ./a.out
- */
-
-#include <ixwebsocket/IXNetSystem.h>
-#include <ixwebsocket/IXWebSocket.h>
-#include <iostream>
-
-int main()
-{
-    // Required on Windows
-    ix::initNetSystem();
-
-    // Our websocket object
-    ix::WebSocket webSocket;
-
-    std::string url("wss://echo.websocket.org");
-    webSocket.setUrl(url);
-
-    std::cout << "Connecting to " << url << "..." << std::endl;
-
-    // Setup a callback to be fired (in a background thread, watch out for race conditions !)
-    // 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 << "received message: " << msg->str << std::endl;
-                std::cout << "> " << std::flush;
-            }
-            else if (msg->type == ix::WebSocketMessageType::Open)
-            {
-                std::cout << "Connection established" << std::endl;
-                std::cout << "> " << std::flush;
-            }
-        }
-    );
-
-    // 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");
-
-    // Display a prompt
-    std::cout << "> " << std::flush;
-
-    std::string text;
-    // Read text from the console and send messages in text mode.
-    // Exit with Ctrl-D on Unix or Ctrl-Z on Windows.
-    while (std::getline(std::cin, text))
-    {
-        webSocket.send(text);
-        std::cout << "> " << std::flush;
-    }
-
-    return 0;
-}
-```
-
-Interested? Go read the [docs](https://machinezone.github.io/IXWebSocket/)! If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.
-
-IXWebSocket is actively being developed, check out the [changelog](https://machinezone.github.io/IXWebSocket/CHANGELOG/) 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).
-
-IXWebSocket client code is autobahn compliant beginning with the 6.0.0 version. See the current [test results](https://bsergean.github.io/autobahn/reports/clients/index.html). Some tests are still failing in the server code.
-
-Starting with the 11.0.8 release, IXWebSocket should be fully C++11 compatible.
-
-## Users
-
-If your company or project is using this library, feel free to open an issue or PR to amend this list.
-
-- [Machine Zone](https://www.mz.com)
-- [Tokio](https://gitlab.com/HCInk/tokio), a discord library focused on audio playback with node bindings.
-- [libDiscordBot](https://github.com/tostc/libDiscordBot/tree/master), an easy to use Discord-bot framework.
-- [gwebsocket](https://github.com/norrbotten/gwebsocket), a websocket (lua) module for Garry's Mod
-- [DisCPP](https://github.com/DisCPP/DisCPP), a simple but feature rich Discord API wrapper
-- [discord.cpp](https://github.com/luccanunes/discord.cpp), a discord library for making bots
-
-## Alternative libraries
-
-There are plenty of great websocket libraries out there, which might work for you. Here are a couple of serious ones.
-
-* [websocketpp](https://github.com/zaphoyd/websocketpp) - C++
-* [beast](https://github.com/boostorg/beast) - C++
-* [libwebsockets](https://libwebsockets.org/) - C
-* [µWebSockets](https://github.com/uNetworking/uWebSockets) - C
-
-[uvweb](https://github.com/bsergean/uvweb) is a library written by the IXWebSocket author which is built on top of [uvw](https://github.com/skypjack/uvw), which is a C++ wrapper for [libuv](https://libuv.org/). It has more dependencies and does not support SSL at this point, but it can be used to open multiple connections within a single OS thread thanks to libuv.
-
-To check the performance of a websocket library, you can look at the [autoroute](https://github.com/bsergean/autoroute) project.
-
-## Continuous Integration
-
-| OS                | TLS               | Sanitizer         | Status            |
-|-------------------|-------------------|-------------------|-------------------|
-| Linux             | OpenSSL           | None              | [![Build2][1]][0] |
-| macOS             | Secure Transport  | Thread Sanitizer  | [![Build2][2]][0] |
-| macOS             | OpenSSL           | Thread Sanitizer  | [![Build2][3]][0] |
-| macOS             | MbedTLS           | Thread Sanitizer  | [![Build2][4]][0] |
-| Windows           | Disabled          | None              | [![Build2][5]][0] |
-| UWP               | Disabled          | None              | [![Build2][6]][0] |
-| Linux             | OpenSSL           | Address Sanitizer | [![Build2][7]][0] |
-
-* ASAN fails on Linux because of a known problem, we need a 
-* Some tests are disabled on Windows/UWP because of a pathing problem
-* TLS and ZLIB are disabled on Windows/UWP because enabling make the CI run takes a lot of time, for setting up vcpkg.
-
-[0]: https://github.com/machinezone/IXWebSocket
-[1]: https://github.com/machinezone/IXWebSocket/workflows/linux/badge.svg
-[2]: https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_sectransport/badge.svg
-[3]: https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_openssl/badge.svg
-[4]: https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_mbedtls/badge.svg
-[5]: https://github.com/machinezone/IXWebSocket/workflows/windows/badge.svg
-[6]: https://github.com/machinezone/IXWebSocket/workflows/uwp/badge.svg
-[7]: https://github.com/machinezone/IXWebSocket/workflows/linux_asan/badge.svg
-

SECURITY.md

@@ -1,11 +0,0 @@
-# Security Policy
-
-## Supported Versions
-
-| Version | Supported          |
-| ------- | ------------------ |
-| 7.x.x   | :white_check_mark: |
-
-## Reporting a Vulnerability
-
-Users should send an email to bsergean@gmail.com to report a vulnerability.

appveyor.yml

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

build/index.html

@@ -0,0 +1,248 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        
+        
+        
+        <link rel="shortcut icon" href="../img/favicon.ico">
+        <title>Build - IXWebSocket</title>
+        <link href="../css/bootstrap.min.css" rel="stylesheet">
+        <link href="../css/font-awesome.min.css" rel="stylesheet">
+        <link href="../css/base.css" rel="stylesheet">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+        <script>hljs.highlightAll();</script> 
+    </head>
+
+    <body>
+        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
+            <div class="container">
+                <a class="navbar-brand" href="..">IXWebSocket</a>
+                <!-- Expander button -->
+                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <!-- Expanded navigation -->
+                <div id="navbar-collapse" class="navbar-collapse collapse">
+                        <!-- Main navigation -->
+                        <ul class="nav navbar-nav">
+                            <li class="navitem">
+                                <a href=".." class="nav-link">Home</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../CHANGELOG/" class="nav-link">Changelog</a>
+                            </li>
+                            <li class="navitem active">
+                                <a href="./" class="nav-link">Build</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../design/" class="nav-link">Design</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../packages/" class="nav-link">Packages</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../performance/" class="nav-link">Performance</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../usage/" class="nav-link">Examples</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../ws/" class="nav-link">Ws</a>
+                            </li>
+                        </ul>
+
+                    <ul class="nav navbar-nav ml-auto">
+                        <li class="nav-item">
+                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
+                                <i class="fa fa-search"></i> Search
+                            </a>
+                        </li>
+                            <li class="nav-item">
+                                <a rel="prev" href="../CHANGELOG/" class="nav-link">
+                                    <i class="fa fa-arrow-left"></i> Previous
+                                </a>
+                            </li>
+                            <li class="nav-item">
+                                <a rel="next" href="../design/" class="nav-link">
+                                    Next <i class="fa fa-arrow-right"></i>
+                                </a>
+                            </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            <div class="row">
+                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
+    <div class="navbar-header">
+        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
+            <span class="fa fa-angle-down"></span>
+        </button>
+    </div>
+
+    
+    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
+        <ul class="nav flex-column">
+            
+            <li class="nav-item" data-level="2"><a href="#build" class="nav-link">Build</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+        </ul>
+    </div>
+</div></div>
+                    <div class="col-md-9" role="main">
+
+<h2 id="build">Build</h2>
+<h3 id="cmake">CMake</h3>
+<p>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.</p>
+<pre><code>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
+</code></pre>
+<p>Headers and a static library will be installed to the target dir.
+There is a unittest which can be executed by typing <code>make test</code>.</p>
+<p>Options for building:</p>
+<ul>
+<li><code>-DBUILD_SHARED_LIBS=ON</code> will build the unittest as a shared libary instead of a static library, which is the default</li>
+<li><code>-DUSE_ZLIB=1</code> will enable zlib support, required for http client + server + websocket per message deflate extension</li>
+<li><code>-DUSE_TLS=1</code> will enable TLS support</li>
+<li><code>-DUSE_OPEN_SSL=1</code> will use <a href="https://www.openssl.org/">openssl</a> for the TLS support (default on Linux and Windows). When using a custom version of openssl (say a prebuilt version, odd runtime problems can happens, as in #319, and special cmake trickery will be required (see this <a href="https://github.com/machinezone/IXWebSocket/issues/175#issuecomment-620231032">comment</a>)</li>
+<li><code>-DUSE_MBED_TLS=1</code> will use <a href="https://tls.mbed.org/">mbedlts</a> for the TLS support</li>
+<li><code>-DUSE_WS=1</code> will build the ws interactive command line tool</li>
+<li><code>-DUSE_TEST=1</code> will build the unittest</li>
+</ul>
+<p>If you are on Windows, look at the <a href="https://github.com/machinezone/IXWebSocket/blob/master/appveyor.yml">appveyor</a> file (not maintained much though) or rather the <a href="https://github.com/machinezone/IXWebSocket/blob/master/.github/workflows/unittest_windows.yml">github actions</a> which have instructions for building dependencies.</p>
+<p>It is also possible to externally include the project, so that everything is fetched over the wire when you build like so:</p>
+<pre><code>    ExternalProject_Add(
+        IXWebSocket
+        GIT_REPOSITORY https://github.com/machinezone/IXWebSocket.git
+        ...
+    )
+</code></pre>
+<h3 id="vcpkg">vcpkg</h3>
+<p>It is possible to get IXWebSocket through Microsoft <a href="https://github.com/microsoft/vcpkg">vcpkg</a>.</p>
+<pre><code>vcpkg install ixwebsocket
+</code></pre>
+<p>To use the installed package within a cmake project, use the following:</p>
+<pre><code class="language-cmake"> set(CMAKE_TOOLCHAIN_FILE &quot;$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake&quot; CACHE STRING &quot;&quot;) # this is super important in order for cmake to include the vcpkg search/lib paths!
+
+ # find library and its headers
+ find_path(IXWEBSOCKET_INCLUDE_DIR ixwebsocket/IXWebSocket.h)
+ find_library(IXWEBSOCKET_LIBRARY ixwebsocket)
+ # include headers
+ include_directories(${IXWEBSOCKET_INCLUDE_DIR})
+ # ...
+ target_link_libraries(${PROJECT_NAME} ... ${IXWEBSOCKET_LIBRARY}) # Cmake will automatically fail the generation if the lib was not found, i.e is set to NOTFOUND
+
+</code></pre>
+<h3 id="conan">Conan</h3>
+<p><a href="https://bintray.com/conan/conan-center/ixwebsocket%3A_/_latestVersion"> <img alt="Download" src="https://api.bintray.com/packages/conan/conan-center/ixwebsocket%3A_/images/download.svg" /> </a></p>
+<p>Conan is currently supported through a recipe in <a href="https://github.com/conan-io/conan-center-index/tree/master/recipes/ixwebsocket">Conan Center</a> (<a href="https://bintray.com/conan/conan-center/ixwebsocket%3A_">Bintray entry</a>).</p>
+<p>Package reference</p>
+<ul>
+<li>Conan 1.21.0 and up: <code>ixwebsocket/7.9.2</code></li>
+<li>Earlier versions: <code>ixwebsocket/7.9.2@_/_</code></li>
+</ul>
+<p>Note that the version listed here might not be the latest one. See Bintray or the recipe itself for the latest version. If you're migrating from the previous, custom Bintray remote, note that the package reference <em>has</em> to be lower-case.</p>
+<h3 id="docker">Docker</h3>
+<p>There is a Dockerfile for running the unittest on Linux, and to run the <code>ws</code> tool. It is also available on the docker registry.</p>
+<pre><code>docker run docker.pkg.github.com/machinezone/ixwebsocket/ws:latest --help
+</code></pre>
+<p>To use docker-compose you must make a docker container first.</p>
+<pre><code>$ make docker
+...
+$ docker compose up &amp;
+...
+$ docker exec -it ixwebsocket_ws_1 bash
+app@ca2340eb9106:~$ ws --help
+ws is a websocket tool
+...
+</code></pre></div>
+            </div>
+        </div>
+
+        <footer class="col-md-12">
+            <hr>
+            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
+        </footer>
+        <script src="../js/jquery-3.6.0.min.js"></script>
+        <script src="../js/bootstrap.min.js"></script>
+        <script>
+            var base_url = "..",
+                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
+        </script>
+        <script src="../js/base.js"></script>
+        <script src="../search/main.js"></script>
+
+        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="searchModalLabel">Search</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+                <p>From here you can search these documents. Enter your search terms below.</p>
+                <form>
+                    <div class="form-group">
+                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results" data-no-results-text="No results found"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+
+    </body>
+</html>

css/base.css

@@ -0,0 +1,325 @@
+html {
+    /* csslint ignore:start */
+    /* The nav header is 3.5rem high, plus 20px for the margin-top of the
+       main container. */
+    scroll-padding-top: calc(3.5rem + 20px);
+    /* csslint ignore:end */
+}
+
+/* Replacement for `body { background-attachment: fixed; }`, which has
+   performance issues when scrolling on large displays. See #1394. */
+body::before {
+    content: ' ';
+    position: fixed;
+    width: 100%;
+    height: 100%;
+    top: 0;
+    left: 0;
+    background-color: #f8f8f8;
+    background: url(../img/grid.png) repeat-x;
+    will-change: transform;
+    z-index: -1;
+}
+
+body > .container {
+    margin-top: 20px;
+    min-height: 400px;
+}
+
+.navbar.fixed-top { /* csslint allow: adjoining-classes */
+    /* csslint ignore:start */
+    position: -webkit-sticky;
+    position: sticky;
+    /* csslint ignore:end */
+}
+
+.source-links {
+    float: right;
+}
+
+.col-md-9 img {
+    max-width: 100%;
+    display: inline-block;
+    padding: 4px;
+    line-height: 1.428571429;
+    background-color: #fff;
+    border: 1px solid #ddd;
+    border-radius: 4px;
+    margin: 20px auto 30px auto;
+}
+
+h1 {
+    color: #444;
+    font-weight: 400;
+    font-size: 42px;
+}
+
+h2, h3, h4, h5, h6 {
+    color: #444;
+    font-weight: 300;
+}
+
+hr {
+    border-top: 1px solid #aaa;
+}
+
+pre, .rst-content tt {
+    max-width: 100%;
+    background: #fff;
+    border: solid 1px #e1e4e5;
+    color: #333;
+    overflow-x: auto;
+}
+
+code.code-large, .rst-content tt.code-large {
+    font-size: 90%;
+}
+
+code {
+    padding: 2px 5px;
+    background: #fff;
+    border: solid 1px #e1e4e5;
+    color: #333;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+}
+
+pre code {
+    display: block;
+    background: transparent;
+    border: none;
+    white-space: pre;
+    word-wrap: normal;
+    font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
+    font-size: 12px;
+}
+
+kbd {
+    padding: 2px 4px;
+    font-size: 90%;
+    color: #fff;
+    background-color: #333;
+    border-radius: 3px;
+    -webkit-box-shadow: inset 0 -1px 0 rgba(0,0,0,.25);
+    box-shadow: inset 0 -1px 0 rgba(0,0,0,.25);
+}
+
+a code {
+    color: #2FA4E7;
+}
+
+a:hover code, a:focus code {
+    color: #157AB5;
+}
+
+footer {
+    margin-top: 30px;
+    margin-bottom: 10px;
+    text-align: center;
+    font-weight: 200;
+}
+
+.modal-dialog {
+    margin-top: 60px;
+}
+
+/*
+ * Side navigation
+ *
+ * Scrollspy and affixed enhanced navigation to highlight sections and secondary
+ * sections of docs content.
+ */
+
+.bs-sidebar.affix { /* csslint allow: adjoining-classes */
+    /* csslint ignore:start */
+    position: -webkit-sticky;
+    position: sticky;
+    /* csslint ignore:end */
+    /* The nav header is 3.5rem high, plus 20px for the margin-top of the
+       main container. */
+    top: calc(3.5rem + 20px);
+}
+
+.bs-sidebar.card { /* csslint allow: adjoining-classes */
+    padding: 0;
+    max-height: 90%;
+    overflow-y: auto;
+}
+
+/* Toggle (vertically flip) sidebar collapse icon */
+.bs-sidebar .navbar-toggler span {
+    -moz-transform: scale(1, -1);
+    -webkit-transform: scale(1, -1);
+    -o-transform: scale(1, -1);
+    -ms-transform: scale(1, -1);
+    transform: scale(1, -1);
+}
+
+.bs-sidebar .navbar-toggler.collapsed span { /* csslint allow: adjoining-classes */
+    -moz-transform: scale(1, 1);
+    -webkit-transform: scale(1, 1);
+    -o-transform: scale(1, 1);
+    -ms-transform: scale(1, 1);
+    transform: scale(1, 1);
+}
+
+/* First level of nav */
+.bs-sidebar > .navbar-collapse > .nav {
+    padding-top:    10px;
+    padding-bottom: 10px;
+    border-radius: 5px;
+    width: 100%;
+}
+
+/* All levels of nav */
+.bs-sidebar .nav > li > a {
+    display: block;
+    padding: 5px 20px;
+    z-index: 1;
+}
+.bs-sidebar .nav > li > a:hover,
+.bs-sidebar .nav > li > a:focus {
+    text-decoration: none;
+    border-right: 1px solid;
+}
+.bs-sidebar .nav > li > a.active,
+.bs-sidebar .nav > li > a.active:hover,
+.bs-sidebar .nav > li > a.active:focus {
+    font-weight: bold;
+    background-color: transparent;
+    border-right: 1px solid;
+}
+
+.bs-sidebar .nav .nav .nav {
+    margin-left: 1em;
+}
+
+.bs-sidebar .nav > li > a {
+    font-weight: bold;
+}
+
+.bs-sidebar .nav .nav > li > a {
+    font-weight: normal;
+}
+
+.headerlink {
+    font-family: FontAwesome;
+    font-size: 14px;
+    display: none;
+    padding-left: .5em;
+}
+
+h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink {
+    display:inline-block;
+}
+
+blockquote {
+    padding-left: 10px;
+    border-left: 4px solid #e6e6e6;
+}
+
+.admonition, details {
+    padding: 15px;
+    margin-bottom: 20px;
+    border: 1px solid transparent;
+    border-radius: 4px;
+    text-align: left;
+}
+
+.admonition.note, details.note { /* csslint allow: adjoining-classes */
+    color: #2e6b89;
+    background-color: #e2f0f7;
+    border-color: #bce8f1;
+}
+
+.admonition.warning, details.warning { /* csslint allow: adjoining-classes */
+    color: #7a6032;
+    background-color: #fffae5;
+    border-color: #fbeed5;
+}
+
+.admonition.danger, details.danger { /* csslint allow: adjoining-classes */
+    color: #7f3130;
+    background-color: #fde3e3;
+    border-color: #eed3d7;
+}
+
+.admonition-title, summary {
+    font-weight: bold;
+    text-align: left;
+}
+
+.admonition>p:last-child, details>p:last-child {
+    margin-bottom: 0;
+}
+
+@media (max-width: 991.98px) {
+    .navbar-collapse.show { /* csslint allow: adjoining-classes */
+        overflow-y: auto;
+        max-height: calc(100vh - 3.5rem);
+    }
+}
+
+.dropdown-item.open { /* csslint allow: adjoining-classes */
+    color: #fff;
+    background-color: #2FA4E7;
+}
+
+.dropdown-submenu > .dropdown-menu {
+    margin: 0 0 0 1.5rem;
+    padding: 0;
+    border-width: 0;
+}
+
+.dropdown-submenu > a::after {
+    display: block;
+    content: " ";
+    float: right;
+    width: 0;
+    height: 0;
+    border-color: transparent;
+    border-style: solid;
+    border-width: 5px 0 5px 5px;
+    border-left-color: #ccc;
+    margin-top: 5px;
+    margin-right: -10px;
+}
+
+.dropdown-submenu:hover > a::after {
+    border-left-color: #fff;
+}
+
+@media (min-width: 992px) {
+    .dropdown-menu {
+        overflow-y: auto;
+        max-height: calc(100vh - 3.5rem);
+    }
+
+    .dropdown-submenu {
+        position: relative;
+    }
+
+    .dropdown-submenu > .dropdown-menu {
+        /* csslint ignore:start */
+        position: fixed !important;
+        /* csslint ignore:end */
+        margin-top: -9px;
+        margin-left: -2px;
+        border-width: 1px;
+        padding: 0.5rem 0;
+    }
+
+    .dropdown-submenu.pull-left { /* csslint allow: adjoining-classes */
+        float: none;
+    }
+
+    .dropdown-submenu.pull-left > .dropdown-menu { /* csslint allow: adjoining-classes */
+        left: -100%;
+        margin-left: 10px;
+    }
+}
+
+@media print {
+    /* Remove sidebar when print */
+    .col-md-3 { display: none; }
+}

design/index.html

@@ -0,0 +1,247 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        
+        
+        
+        <link rel="shortcut icon" href="../img/favicon.ico">
+        <title>Design - IXWebSocket</title>
+        <link href="../css/bootstrap.min.css" rel="stylesheet">
+        <link href="../css/font-awesome.min.css" rel="stylesheet">
+        <link href="../css/base.css" rel="stylesheet">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+        <script>hljs.highlightAll();</script> 
+    </head>
+
+    <body>
+        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
+            <div class="container">
+                <a class="navbar-brand" href="..">IXWebSocket</a>
+                <!-- Expander button -->
+                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <!-- Expanded navigation -->
+                <div id="navbar-collapse" class="navbar-collapse collapse">
+                        <!-- Main navigation -->
+                        <ul class="nav navbar-nav">
+                            <li class="navitem">
+                                <a href=".." class="nav-link">Home</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../CHANGELOG/" class="nav-link">Changelog</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../build/" class="nav-link">Build</a>
+                            </li>
+                            <li class="navitem active">
+                                <a href="./" class="nav-link">Design</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../packages/" class="nav-link">Packages</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../performance/" class="nav-link">Performance</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../usage/" class="nav-link">Examples</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="../ws/" class="nav-link">Ws</a>
+                            </li>
+                        </ul>
+
+                    <ul class="nav navbar-nav ml-auto">
+                        <li class="nav-item">
+                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
+                                <i class="fa fa-search"></i> Search
+                            </a>
+                        </li>
+                            <li class="nav-item">
+                                <a rel="prev" href="../build/" class="nav-link">
+                                    <i class="fa fa-arrow-left"></i> Previous
+                                </a>
+                            </li>
+                            <li class="nav-item">
+                                <a rel="next" href="../packages/" class="nav-link">
+                                    Next <i class="fa fa-arrow-right"></i>
+                                </a>
+                            </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            <div class="row">
+                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
+    <div class="navbar-header">
+        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
+            <span class="fa fa-angle-down"></span>
+        </button>
+    </div>
+
+    
+    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
+        <ul class="nav flex-column">
+            
+            <li class="nav-item" data-level="2"><a href="#implementation-details" class="nav-link">Implementation details</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            
+            <li class="nav-item" data-level="2"><a href="#limitations" class="nav-link">Limitations</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            
+            <li class="nav-item" data-level="2"><a href="#c-code-organization" class="nav-link">C++ code organization</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+        </ul>
+    </div>
+</div></div>
+                    <div class="col-md-9" role="main">
+
+<h2 id="implementation-details">Implementation details</h2>
+<h3 id="per-message-deflate-compression">Per Message Deflate compression.</h3>
+<p>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.</p>
+<h3 id="tlsssl">TLS/SSL</h3>
+<p>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 and mbedTLS can be used on Android, Linux and Windows.</p>
+<p>If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.</p>
+<h3 id="polling-and-background-thread-work">Polling and background thread work</h3>
+<p>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 <a href="http://man7.org/linux/man-pages/man2/select.2.html">system</a> 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 <a href="https://linux.die.net/man/2/select_tut">select law</a>. 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 <a href="https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid">possible</a> since system socket implementations allow concurrent read/writes.</p>
+<h3 id="automatic-reconnection">Automatic reconnection</h3>
+<p>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.</p>
+<h3 id="large-messages">Large messages</h3>
+<p>Large frames are broken up into smaller chunks or messages to avoid filling up the os tcp buffers, which is permitted thanks to WebSocket <a href="https://tools.ietf.org/html/rfc6455#section-5.4">fragmentation</a>. Messages up to 1G were sent and received succesfully.</p>
+<h3 id="testing">Testing</h3>
+<p>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.</p>
+<p>The unittest tries to be comprehensive, and has been running on multiple platforms, with different sanitizers such as a thread sanitizer to catch data races or the undefined behavior sanitizer.</p>
+<p>The regression test is running after each commit on github actions for multiple configurations.</p>
+<h2 id="limitations">Limitations</h2>
+<ul>
+<li>On some configuration (mostly Android) certificate validation needs to be setup so that SocketTLSOptions.caFile point to a pem file, such as the one distributed by Firefox. Unless that setup is done connecting to a wss endpoint will display an error. With mbedtls the message will contain <code>error in handshake : X509 - Certificate verification failed, e.g. CRL, CA or signature check failed</code>.</li>
+<li>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 <code>recv</code> and <code>send</code> error codes. <a href="https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program">Here</a> 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.</li>
+<li>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.</li>
+</ul>
+<h2 id="c-code-organization">C++ code organization</h2>
+<p>Here is a simplistic diagram which explains how the code is structured in term of class/modules.</p>
+<pre><code>+-----------------------+ --- 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.
+|                       |
++-----------------------+
+</code></pre></div>
+            </div>
+        </div>
+
+        <footer class="col-md-12">
+            <hr>
+            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
+        </footer>
+        <script src="../js/jquery-3.6.0.min.js"></script>
+        <script src="../js/bootstrap.min.js"></script>
+        <script>
+            var base_url = "..",
+                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
+        </script>
+        <script src="../js/base.js"></script>
+        <script src="../search/main.js"></script>
+
+        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="searchModalLabel">Search</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+                <p>From here you can search these documents. Enter your search terms below.</p>
+                <form>
+                    <div class="form-group">
+                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results" data-no-results-text="No results found"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+
+    </body>
+</html>

docker-compose.yml

@@ -1,11 +0,0 @@
-version: "3.3"
-services:
-  push:
-    entrypoint: ws push_server --host 0.0.0.0
-    image: ${DOCKER_REPO}/ws:build
-
-  autoroute:
-    entrypoint: ws autoroute ws://push:8008
-    image: ${DOCKER_REPO}/ws:build
-    depends_on:
-      - push

docker/Dockerfile.alpine

@@ -1,39 +0,0 @@
-FROM alpine:3.12 as build
-
-RUN apk add --no-cache \
-    gcc g++ musl-dev linux-headers \
-    cmake mbedtls-dev make zlib-dev python3-dev ninja git
-
-RUN addgroup -S app && \
-    adduser -S -G app app && \
-    chown -R app:app /opt && \
-    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 -f makefile.dev ws_mbedtls_install && \
-    sh tools/trim_repo_for_docker.sh
-
-FROM alpine:3.12 as runtime
-
-RUN apk add --no-cache libstdc++ mbedtls ca-certificates python3 strace && \
-    addgroup -S app && \
-    adduser -S -G app app
-
-COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
-
-# COPY --chown=app:app --from=build /opt /opt
-
-RUN chmod +x /usr/local/bin/ws && \
-    ldd /usr/local/bin/ws
-
-# Now run in usermode
-USER app
-WORKDIR /home/app
-
-ENTRYPOINT ["ws"]
-EXPOSE 8008

docker/Dockerfile.centos

@@ -1,41 +0,0 @@
-FROM centos:8 as build
-
-RUN yum install -y gcc-c++ make cmake zlib-devel openssl-devel redhat-rpm-config
-
-RUN yum install -y epel-release
-RUN yum install -y mbedtls-devel
-
-RUN groupadd app && useradd -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", "ws_mbedtls_install" ]
-RUN [ "rm", "-rf", "build" ]
-
-FROM centos:8 as runtime
-
-RUN yum install -y gdb strace
-
-RUN yum install -y epel-release
-RUN yum install -y mbedtls
-
-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
-
-# Copy source code for gcc
-COPY --chown=app:app --from=build /opt /opt
-
-# Now run in usermode
-USER app
-WORKDIR /home/app
-
-ENTRYPOINT ["ws"]
-EXPOSE 8008

docker/Dockerfile.centos7

@@ -1,26 +0,0 @@
-FROM centos:7 as build
-
-RUN yum install -y gcc-c++ make zlib-devel openssl-devel redhat-rpm-config
-
-RUN groupadd app && useradd -g app app
-RUN chown -R app:app /opt
-RUN chown -R app:app /usr/local
-
-WORKDIR /tmp
-RUN curl -O https://cmake.org/files/v3.14/cmake-3.14.0-Linux-x86_64.tar.gz
-RUN tar zxvf cmake-3.14.0-Linux-x86_64.tar.gz
-RUN cp -rf cmake-3.14.0-Linux-x86_64/* /usr/
-
-RUN yum install -y git
-
-# 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", "ws_no_python" ]
-RUN [ "rm", "-rf", "build" ]
-
-ENTRYPOINT ["ws"]
-CMD ["--help"]

docker/Dockerfile.debian

@@ -1,52 +0,0 @@
-# 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

@@ -1,43 +0,0 @@
-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

@@ -1,23 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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"]
-CMD ["sh"]

docker/Dockerfile.ubuntu_groovy

@@ -1,23 +0,0 @@
-# Build time
-FROM ubuntu:groovy as build
-
-ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update
-
-RUN apt-get -y install g++ libssl-dev libz-dev make python ninja-build
-RUN apt-get -y install cmake
-RUN apt-get -y install gdb
-
-COPY . /opt
-WORKDIR /opt
-
-#
-# To use the container interactively for debugging/building
-# 1. Build with
-#    CMD ["ls"]
-# 2. Run with
-#    docker run --entrypoint sh -it docker-game-eng-dev.addsrv.com/ws:9.10.6 
-#
-
-RUN ["make", "test"]
-# CMD ["ls"]

docker/Dockerfile.ubuntu_precise

@@ -1,27 +0,0 @@
-# Build time
-FROM ubuntu:precise 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 --no-check-certificate 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
-RUN apt-get -y install git
-
-COPY . .
-
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-RUN ["make", "ws_no_python"]
-
-ENTRYPOINT ["ws"]
-CMD ["--help"]

docker/Dockerfile.ubuntu_trusty

@@ -1,22 +0,0 @@
-# Build time
-FROM ubuntu:trusty 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 --no-check-certificate 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++ libssl-dev libz-dev make python git
-
-COPY . .
-
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-RUN ["make", "ws_no_python"]
-
-ENTRYPOINT ["ws"]
-CMD ["--help"]

docker/Dockerfile.ubuntu_xenial

@@ -1,24 +0,0 @@
-# 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/build.md

@@ -1,93 +0,0 @@
-## 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_ZLIB=1` will enable zlib support, required for http client + server + websocket per message deflate extension
-* `-DUSE_TLS=1` will enable TLS support
-* `-DUSE_OPEN_SSL=1` will use [openssl](https://www.openssl.org/) for the TLS support (default on Linux and Windows)
-* `-DUSE_MBED_TLS=1` will use [mbedlts](https://tls.mbed.org/) for the TLS support
-* `-DUSE_WS=1` will build the ws interactive command line tool
-* `-DUSE_TEST=1` will build the unittest
-* `-DUSE_PYTHON=1` will use Python3 for cobra bots, require Python3 to be installed.
-
-If you are on Windows, look at the [appveyor](https://github.com/machinezone/IXWebSocket/blob/master/appveyor.yml) file (not maintained much though) or rather the [github actions](https://github.com/machinezone/IXWebSocket/blob/master/.github/workflows/unittest_windows.yml) which have instructions for building dependencies.
-
-It is also possible to externally include the project, so that everything is fetched over the wire when you build like so:
-
-```
-    ExternalProject_Add(
-        IXWebSocket
-        GIT_REPOSITORY https://github.com/machinezone/IXWebSocket.git
-        ...
-    )
-```
-
-### vcpkg
-
-It is possible to get IXWebSocket through Microsoft [vcpkg](https://github.com/microsoft/vcpkg).
-
-```
-vcpkg install ixwebsocket
-```
-To use the installed package within a cmake project, use the following:
-```cmake
- set(CMAKE_TOOLCHAIN_FILE "$ENV{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake" CACHE STRING "") # this is super important in order for cmake to include the vcpkg search/lib paths!
-
- # find library and its headers
- find_path(IXWEBSOCKET_INCLUDE_DIR ixwebsocket/IXWebSocket.h)
- find_library(IXWEBSOCKET_LIBRARY ixwebsocket)
- # include headers
- include_directories(${IXWEBSOCKET_INCLUDE_DIR})
- # ...
- target_link_libraries(${PROJECT_NAME} ... ${IXWEBSOCKET_LIBRARY}) # Cmake will automatically fail the generation if the lib was not found, i.e is set to NOTFOUNS
-
-```
-
-### Conan
-
-[ ![Download](https://api.bintray.com/packages/conan/conan-center/ixwebsocket%3A_/images/download.svg) ](https://bintray.com/conan/conan-center/ixwebsocket%3A_/_latestVersion)
-
-Conan is currently supported through a recipe in [Conan Center](https://github.com/conan-io/conan-center-index/tree/master/recipes/ixwebsocket) ([Bintray entry](https://bintray.com/conan/conan-center/ixwebsocket%3A_)).
-
-Package reference
-
-* Conan 1.21.0 and up: `ixwebsocket/7.9.2`
-* Earlier versions: `ixwebsocket/7.9.2@_/_`
-
-Note that the version listed here might not be the latest one. See Bintray or the recipe itself for the latest version. If you're migrating from the previous, custom Bintray remote, note that the package reference _has_ to be lower-case.
-
-### 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 docker.pkg.github.com/machinezone/ixwebsocket/ws:latest --help
-```
-
-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

@@ -1,82 +0,0 @@
-## 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 and mbedTLS can be used on Android, Linux and Windows.
-
-If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.
-
-### 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 platforms, with different sanitizers such as a thread sanitizer to catch data races or the undefined behavior sanitizer.
-
-The regression test is running after each commit on github actions for multiple configurations.
-
-* Linux
-* macOS with thread sanitizer
-* macOS, with OpenSSL, with thread sanitizer
-* macOS, with MbedTLS, with thread sanitizer
-* Windows, with MbedTLS (the unittest is not run yet)
-
-## Limitations
-
-* On some configuration (mostly Android) certificate validation needs to be setup so that SocketTLSOptions.caFile point to a pem file, such as the one distributed by Firefox. Unless that setup is done connecting to a wss endpoint will display an error. With mbedtls the message will contain `error in handshake : X509 - Certificate verification failed, e.g. CRL, CA or signature check failed`.
-* 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

@@ -1,64 +0,0 @@
-## 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
-* FreeBSD
-
-## Example code
-
-```c++
-// 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. IXWebSocket comes with a command line utility named ws which is quite handy, and is now packaged with alpine linux. You can install it with `apk add ws`.
-
-* Few dependencies (only zlib)
-* Simple to use ; uses std::string and std::function callbacks.
-* Complete support of the websocket protocol, and basic http support.
-* Client and Server
-* TLS support
-
-## Alternative libraries
-
-There are plenty of great websocket libraries out there, which might work for you. Here are a couple of serious ones.
-
-* [websocketpp](https://github.com/zaphoyd/websocketpp) - C++
-* [beast](https://github.com/boostorg/beast) - C++
-* [libwebsockets](https://libwebsockets.org/) - C
-* [µWebSockets](https://github.com/uNetworking/uWebSockets) - C
-
-## Contributing
-
-IXWebSocket is developed on [GitHub](https://github.com/machinezone/IXWebSocket). We'd love to hear about how you use it; opening up an issue on GitHub is ok for that. If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.

docs/packages.md

@@ -1,94 +0,0 @@
-Notes on how we can update the different packages for ixwebsocket.
-
-## VCPKG
-
-Visit the [releases](https://github.com/machinezone/IXWebSocket/releases) page on Github. A tag must have been made first.
-
-Download the latest entry.
-
-```
-$ cd /tmp
-/tmp$ curl -s -O -L https://github.com/machinezone/IXWebSocket/archive/v9.1.9.tar.gz
-/tmp$
-/tmp$ openssl sha512 v9.1.9.tar.gz
-SHA512(v9.1.9.tar.gz)= f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
-```
-
-Now go punch those values in the vcpkg ixwebsocket port config files. Here is what the diff look like.
-
-```
-vcpkg$ git diff
-diff --git a/ports/ixwebsocket/CONTROL b/ports/ixwebsocket/CONTROL
-index db9c2adc9..4acae5c3f 100644
---- a/ports/ixwebsocket/CONTROL
-+++ b/ports/ixwebsocket/CONTROL
-@@ -1,5 +1,5 @@
- Source: ixwebsocket
--Version: 8.0.5
-+Version: 9.1.9
- Build-Depends: zlib
- Homepage: https://github.com/machinezone/IXWebSocket
- Description: Lightweight WebSocket Client and Server + HTTP Client and Server
-diff --git a/ports/ixwebsocket/portfile.cmake b/ports/ixwebsocket/portfile.cmake
-index de082aece..68e523a05 100644
---- a/ports/ixwebsocket/portfile.cmake
-+++ b/ports/ixwebsocket/portfile.cmake
-@@ -1,8 +1,8 @@
- vcpkg_from_github(
-     OUT_SOURCE_PATH SOURCE_PATH
-     REPO machinezone/IXWebSocket
--    REF v8.0.5
--    SHA512 9dcc20d9a0629b92c62a68a8bd7c8206f18dbd9e93289b0b687ec13c478ce9ad1f3563b38c399c8277b0d3812cc78ca725786ba1dedbc3445b9bdb9b689e8add
-+    REF v9.1.9
-+    SHA512 f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
- )
-```
-
-You will need a fork of the vcpkg repo to make a pull request.
-
-```
-git fetch upstream
-git co master
-git reset --hard upstream/master
-git push origin master --force
-```
-
-Make the pull request (I use a new branch to do that).
-
-```
-vcpkg$ git co -b feature/ixwebsocket_9.1.9
-M	ports/ixwebsocket/CONTROL
-M	ports/ixwebsocket/portfile.cmake
-Switched to a new branch 'feature/ixwebsocket_9.1.9'
-vcpkg$
-vcpkg$
-vcpkg$ git commit -am 'ixwebsocket: update to 9.1.9'
-[feature/ixwebsocket_9.1.9 8587a4881] ixwebsocket: update to 9.1.9
- 2 files changed, 3 insertions(+), 3 deletions(-)
-vcpkg$
-vcpkg$ git push
-fatal: The current branch feature/ixwebsocket_9.1.9 has no upstream branch.
-To push the current branch and set the remote as upstream, use
-
-    git push --set-upstream origin feature/ixwebsocket_9.1.9
-
-vcpkg$ git push --set-upstream origin feature/ixwebsocket_9.1.9
-
-Enumerating objects: 11, done.
-Counting objects: 100% (11/11), done.
-Delta compression using up to 8 threads
-Compressing objects: 100% (6/6), done.
-Writing objects: 100% (6/6), 621 bytes | 621.00 KiB/s, done.
-Total 6 (delta 4), reused 0 (delta 0)
-remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
-remote:
-remote: Create a pull request for 'feature/ixwebsocket_9.1.9' on GitHub by visiting:
-remote:      https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9
-remote:
-To https://github.com/bsergean/vcpkg.git
- * [new branch]          feature/ixwebsocket_9.1.9 -> feature/ixwebsocket_9.1.9
-Branch 'feature/ixwebsocket_9.1.9' set up to track remote branch 'feature/ixwebsocket_9.1.9' from 'origin' by rebasing.
-vcpkg$
-```
-
-Just visit this url, https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9, printed on the console, to make the pull request.

docs/performance.md

@@ -1,37 +0,0 @@
-
-## WebSocket Client performance
-
-We will run a client and a server on the same machine, connecting to localhost. This bench is run on a MacBook Pro from 2015. We can receive over 200,000 (small) messages per second, another way to put it is that it takes 5 micro-second to receive and process one message. This is an indication about the minimal latency to receive messages.
-
-### Receiving messages
-
-By using the push_server ws sub-command, the server will send the same message in a loop to any connected client.
-
-```
-ws push_server -q --send_msg 'yo'
-```
-
-By using the echo_client ws sub-command, with the -m (mute or no_send), we will display statistics on how many messages we can receive per second.
-
-```
-$ ws echo_client -m ws://localhost:8008
-[2020-08-02 12:31:17.284] [info] ws_echo_client: connected
-[2020-08-02 12:31:17.284] [info] Uri: /
-[2020-08-02 12:31:17.284] [info] Headers:
-[2020-08-02 12:31:17.284] [info] Connection: Upgrade
-[2020-08-02 12:31:17.284] [info] Sec-WebSocket-Accept: byy/pMK2d0PtRwExaaiOnXJTQHo=
-[2020-08-02 12:31:17.284] [info] Server: ixwebsocket/10.1.4 macos ssl/SecureTransport zlib 1.2.11
-[2020-08-02 12:31:17.284] [info] Upgrade: websocket
-[2020-08-02 12:31:17.663] [info] messages received: 0 per second 2595307 total
-[2020-08-02 12:31:18.668] [info] messages received: 79679 per second 2674986 total
-[2020-08-02 12:31:19.668] [info] messages received: 207438 per second 2882424 total
-[2020-08-02 12:31:20.673] [info] messages received: 209207 per second 3091631 total
-[2020-08-02 12:31:21.676] [info] messages received: 216056 per second 3307687 total
-[2020-08-02 12:31:22.680] [info] messages received: 214927 per second 3522614 total
-[2020-08-02 12:31:23.684] [info] messages received: 216960 per second 3739574 total
-[2020-08-02 12:31:24.688] [info] messages received: 215232 per second 3954806 total
-[2020-08-02 12:31:25.691] [info] messages received: 212300 per second 4167106 total
-[2020-08-02 12:31:26.694] [info] messages received: 212501 per second 4379607 total
-[2020-08-02 12:31:27.699] [info] messages received: 212330 per second 4591937 total
-[2020-08-02 12:31:28.702] [info] messages received: 216511 per second 4808448 total
-```

docs/usage.md

@@ -1,590 +0,0 @@
-# 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.
-
-```cpp
-#include <ixwebsocket/IXNetSystem.h>
-
-int main()
-{
-    ix::initNetSystem();
-
-    ...
-
-    ix::uninitNetSystem();
-    return 0;
-}
-```
-
-## WebSocket client API
-
-```cpp
-#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.setPingInterval(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
-
-`WebSocketSendInfo result = websocket.send("foo")` will send a message.
-
-If the connection was closed, sending will fail, and the success field of the result object  will be set to false. There could also be a compression error in which case the compressError field will be set to true. The payloadSize field and wireSize fields will tell you respectively how much bytes the message weight, and how many bytes were sent on the wire (potentially compressed + counting the message header (a few bytes).
-
-There is an optional progress callback that can be passed in as the second argument. If a message is large it will be fragmented into chunks which will be sent independantly. Everytime the we can write a fragment into the OS network cache, the callback will be invoked. If a user wants to cancel a slow send, false should be returned from within the callback.
-
-Here is an example code snippet copied from the ws send sub-command. Each fragment weights 32K, so the total integer is the wireSize divided by 32K. As an example if you are sending 32M of data, uncompressed, total will be 1000. current will be set to 0 for the first fragment, then 1, 2 etc...
-
-```
-auto result =
-    _webSocket.sendBinary(serializedMsg, [this, throttle](int current, int total) -> bool {
-        spdlog::info("ws_send: Step {} out of {}", current + 1, total);
-
-        if (throttle)
-        {
-            std::chrono::duration<double, std::milli> duration(10);
-            std::this_thread::sleep_for(duration);
-        }
-
-        return _connected;
-    });
-```
-
-### 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`.
-
-```cpp
-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.
-
-```cpp
-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.
-
-```cpp
-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.
-
-```cpp
-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.
-
-```cpp
-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.
-
-```cpp
-webSocket.setPingInterval(45);
-```
-
-### Supply extra HTTP headers.
-
-You can set extra HTTP headers to be sent during the WebSocket handshake.
-
-```cpp
-WebSocketHttpHeaders headers;
-headers["foo"] = "bar";
-webSocket.setExtraHeaders(headers);
-```
-
-### Subprotocols
-
-You can specify subprotocols to be set during the WebSocket handshake. For more info you can refer to [this doc](https://hpbn.co/websocket/#subprotocol-negotiation).
-
-```cpp
-webSocket.addSubprotocol("appProtocol-v1");
-webSocket.addSubprotocol("appProtocol-v2");
-```
-
-The protocol that the server did accept is available in the open info `protocol` field.
-
-```cpp
-std::cout << "protocol: " << msg->openInfo.protocol << std::endl;
-```
-
-### 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.
-
-```cpp
-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.
-
-```cpp
-webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s
-uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
-```
-
-## Handshake timeout
-
-You can control how long to wait until timing out while waiting for the websocket handshake to be performed.
-
-```
-int handshakeTimeoutSecs = 1;
-setHandshakeTimeout(handshakeTimeoutSecs);
-```
-
-## WebSocket server API
-
-### Legacy api
-
-This api was actually changed to take a weak_ptr<WebSocket> as the first argument to setOnConnectionCallback ; previously it would take a shared_ptr<WebSocket> which was creating cycles and then memory leaks problems.
-
-```cpp
-#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::weak_ptr<WebSocket> webSocket,
-              std::shared_ptr<ConnectionState> connectionState)
-    {
-        std::cout << "Remote ip: " << connectionState->remoteIp << std::endl;
-
-        auto ws = webSocket.lock();
-        if (ws)
-        {
-            ws->setOnMessageCallback(
-                [webSocket, connectionState, &server](const ix::WebSocketMessagePtr msg)
-                {
-                    if (msg->type == ix::WebSocketMessageType::Open)
-                    {
-                        std::cout << "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::cout << "id: " << connectionState->getId() << std::endl;
-
-                        // The uri the client did connect to.
-                        std::cout << "Uri: " << msg->openInfo.uri << std::endl;
-
-                        std::cout << "Headers:" << std::endl;
-                        for (auto it : msg->openInfo.headers)
-                        {
-                            std::cout << 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.
-                        auto ws = webSocket.lock();
-                        if (ws)
-                        {
-                            ws->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();
-
-```
-
-### New api
-
-The new API does not require to use 2 nested callbacks, which is a bit annoying. The real fix is that there was a memory leak due to a shared_ptr cycle, due to passing down a shared_ptr<WebSocket> down to the callbacks.
-
-The webSocket reference is guaranteed to be always valid ; by design the callback will never be invoked with a null webSocket object.
-
-```cpp
-#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.setOnClientMessageCallback(std::shared_ptr<ConnectionState> connectionState,
-                                  WebSocket& webSocket,
-                                  const WebSocketMessagePtr& msg)
-{
-    // The ConnectionState object contains information about the connection,
-    // at this point only the client ip address and the port.
-    std::cout << "Remote ip: " << connectionState->getRemoteIp();
-
-    if (msg->type == ix::WebSocketMessageType::Open)
-    {
-        std::cout << "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::cout << "id: " << connectionState->getId() << std::endl;
-
-        // The uri the client did connect to.
-        std::cout << "Uri: " << msg->openInfo.uri << std::endl;
-
-        std::cout << "Headers:" << std::endl;
-        for (auto it : msg->openInfo.headers)
-        {
-            std::cout << 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
-
-```cpp
-#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";
-
-// HTTP form data can be passed in as well, for multi-part upload of files
-HttpFormDataParameters httpFormDataParameters;
-httpParameters["baz"] = "booz";
-
-out = httpClient.post(url, httpParameters, httpFormDataParameters, args);
-
-// POST request with a body
-out = httpClient.post(url, std::string("foo=bar"), args);
-
-// PUT and PATCH are available too.
-
-//
-// 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 body = response->body; // 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
-```
-
-See this [issue](https://github.com/machinezone/IXWebSocket/issues/209) for links about uploading files with HTTP multipart.
-
-## HTTP server API
-
-```cpp
-#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.
-
-```cpp
-setOnConnectionCallback(
-    [this](HttpRequestPtr request,
-           std::shared_ptr<ConnectionState> connectionState) -> HttpResponsePtr
-    {
-        // Build a string for the response
-        std::stringstream ss;
-        ss << connectionState->getRemoteIp();
-           << " "
-           << request->method
-           << " "
-           << request->uri;
-
-        std::string content = ss.str();
-
-        return std::make_shared<HttpResponse>(200, "OK",
-                                              HttpErrorCode::Ok,
-                                              WebSocketHttpHeaders(),
-                                              content);
-}
-```
-
-## TLS support and configuration
-
-To leverage TLS features, the library must be compiled with the option `USE_TLS=1`.
-
-If you are using OpenSSL, try to be on a version higher than 1.1.x as there there are thread safety problems with 1.0.x.
-
-Then, secure sockets are automatically used when connecting to a `wss://*` url.
-
-Additional TLS options can be configured by passing a `ix::SocketTLSOptions` instance to the
-`setTLSOptions` on `ix::WebSocket` (or `ix::WebSocketServer` or `ix::HttpServer`)
-
-```cpp
-webSocket.setTLSOptions({
-    .certFile = "path/to/cert/file.pem",
-    .keyFile = "path/to/key/file.pem",
-    .caFile = "path/to/trust/bundle/file.pem", // as a file, or in memory buffer in PEM format
-    .tls = true // required in server mode
-});
-```
-
-Specifying `certFile` and `keyFile` configures the certificate that will be used to communicate with TLS peers.
-
-On a client, this is only necessary for connecting to servers that require a client certificate.
-
-On a server, this is necessary for TLS support.
-
-Specifying `caFile` configures the trusted roots bundle file (in PEM format) that will be used to verify peer certificates.
- - The special value of `SYSTEM` (the default) indicates that the system-configured trust bundle should be used; this is generally what you want when connecting to any publicly exposed API/server.
- - The special value of `NONE` can be used to disable peer verification; this is only recommended to rule out certificate verification when testing connectivity.
- - If the value contain the special value `-----BEGIN CERTIFICATE-----`, the value will be read from memory, and not from a file. This is convenient on platforms like Android where reading / writing to the file system can be challenging without proper permissions, or without knowing the location of a temp directory.
-
-For a client, specifying `caFile` can be used if connecting to a server that uses a self-signed cert, or when using a custom CA in an internal environment.
-
-For a server, specifying `caFile` implies that:
-1. You require clients to present a certificate
-1. It must be signed by one of the trusted roots in the file

docs/ws.md

@@ -1,308 +0,0 @@
-## 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
-  httpd                       HTTP server
-```
-
-## curl
-
-The curl subcommand try to be compatible with the curl syntax, to fetch http pages.
-
-Making a HEAD request with the -I parameter.
-
-```
-$ ws curl -I https://www.google.com/
-
-Accept-Ranges: none
-Alt-Svc: quic=":443"; ma=2592000; v="46,43",h3-Q048=":443"; ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000
-Cache-Control: private, max-age=0
-Content-Type: text/html; charset=ISO-8859-1
-Date: Tue, 08 Oct 2019 21:36:57 GMT
-Expires: -1
-P3P: CP="This is not a P3P policy! See g.co/p3phelp for more info."
-Server: gws
-Set-Cookie: NID=188=ASwfz8GrXQrHCLqAz-AndLOMLcz0rC9yecnf3h0yXZxRL3rTufTU_GDDwERp7qQL7LZ_EB8gCRyPXGERyOSAgaqgnrkoTmvWrwFemRLMaOZ896GrHobi5fV7VLklnSG2w48Gj8xMlwxfP7Z-bX-xR9UZxep1tHM6UmFQdD_GkBE; expires=Wed, 08-Apr-2020 21:36:57 GMT; path=/; domain=.google.com; HttpOnly
-Transfer-Encoding: chunked
-Vary: Accept-Encoding
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 0
-Upload size: 143
-Download size: 0
-Status: 200
-```
-
-Making a POST request with the -F parameter.
-
-```
-$ ws curl -F foo=bar https://httpbin.org/post
-foo: bar
-Downloaded 438 bytes out of 438
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 438
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:47:54 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 219
-Download size: 438
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-Passing in a custom header with -H.
-
-```
-$ ws curl -F foo=bar -H 'my_custom_header: baz' https://httpbin.org/post
-my_custom_header:  baz
-foo: bar
-Downloaded 470 bytes out of 470
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 470
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:50:25 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 243
-Download size: 470
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "My-Custom-Header": "baz",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-## connect
-
-The connect command connects to a websocket endpoint, and starts an interactive prompt. Line editing, such as using the direction keys to fetch the last thing you tried to type) is provided. That command is pretty useful to try to send random data to an endpoint and verify that the service handles it with grace (such as sending invalid json).
-
-```
-ws connect wss://echo.websocket.org
-Type Ctrl-D to exit prompt...
-Connecting to url: wss://echo.websocket.org
-> ws_connect: connected
-Uri: /
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:38:44 GMT
-Sec-WebSocket-Accept: 2j6LBScZveqrMx1W/GJkCWvZo3M=
-sec-websocket-extensions:
-Server: Kaazing Gateway
-Upgrade: websocket
-Received ping
-Received ping
-Received ping
-Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-> Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-```
-
-```
-ws connect 'ws://jeanserge.com/v2?appkey=_pubsub'
-Type Ctrl-D to exit prompt...
-Connecting to url: ws://jeanserge.com/v2?appkey=_pubsub
-> ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:28 GMT
-Sec-WebSocket-Accept: LYHmjh9Gsu/Yw7aumQqyPObOEV4=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-bababababababab
-> ws_connect: connection closed: code 1000 reason
-
-ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:44 GMT
-Sec-WebSocket-Accept: I1rqxdLgTU+opPi5/zKPBTuXdLw=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-```
-
-It is possible to pass custom HTTP header when doing the connection handshake,
-the remote server might process them to implement a simple authorization
-scheme.
-
-```
-src$ ws connect -H Authorization:supersecret ws://localhost:8008
-Type Ctrl-D to exit prompt...
-[2020-12-17 22:35:08.732] [info] Authorization: supersecret
-Connecting to url: ws://localhost:8008
-> [2020-12-17 22:35:08.736] [info] ws_connect: connected
-[2020-12-17 22:35:08.736] [info] Uri: /
-[2020-12-17 22:35:08.736] [info] Headers:
-[2020-12-17 22:35:08.736] [info] Connection: Upgrade
-[2020-12-17 22:35:08.736] [info] Sec-WebSocket-Accept: 2yaTFcdwn8KL6IzSMj2u6Le7KTg=
-[2020-12-17 22:35:08.736] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2020-12-17 22:35:08.736] [info] Server: ixwebsocket/11.0.4 macos ssl/SecureTransport zlib 1.2.11
-[2020-12-17 22:35:08.736] [info] Upgrade: websocket
-[2020-12-17 22:35:08.736] [info] Received 25 bytes
-ws_connect: received message: Authorization suceeded!
-[2020-12-17 22:35:08.736] [info] Received pong ixwebsocket::heartbeat::30s::0
-hello
-> [2020-12-17 22:35:25.157] [info] Received 7 bytes
-ws_connect: received message: hello
-```
-
-If the wrong header is passed in, the server would close the connection with a custom close code (>4000, and <4999).
-
-```
-[2020-12-17 22:39:37.044] [info] Upgrade: websocket
-ws_connect: connection closed: code 4001 reason Permission denied
-```
-
-## echo server
-
-The ws echo server will respond what the client just sent him. If we use the
-simple --http_authorization_header we can enforce that client need to pass a
-special value in the Authorization header to connect.
-
-```
-$ ws echo_server --http_authorization_header supersecret
-[2020-12-17 22:35:06.192] [info] Listening on 127.0.0.1:8008
-[2020-12-17 22:35:08.735] [info] New connection
-[2020-12-17 22:35:08.735] [info] remote ip: 127.0.0.1
-[2020-12-17 22:35:08.735] [info] id: 0
-[2020-12-17 22:35:08.735] [info] Uri: /
-[2020-12-17 22:35:08.735] [info] Headers:
-[2020-12-17 22:35:08.735] [info] Authorization: supersecret
-[2020-12-17 22:35:08.735] [info] Connection: Upgrade
-[2020-12-17 22:35:08.735] [info] Host: localhost:8008
-[2020-12-17 22:35:08.735] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2020-12-17 22:35:08.735] [info] Sec-WebSocket-Key: eFF2Gf25dC7eC15Ab1135G==
-[2020-12-17 22:35:08.735] [info] Sec-WebSocket-Version: 13
-[2020-12-17 22:35:08.735] [info] Upgrade: websocket
-[2020-12-17 22:35:08.735] [info] User-Agent: ixwebsocket/11.0.4 macos ssl/SecureTransport zlib 1.2.11
-[2020-12-17 22:35:25.157] [info] Received 7 bytes
-```
-
-## Websocket proxy
-
-```
-ws proxy_server --remote_host ws://127.0.0.1:9000 -v
-Listening on 127.0.0.1:8008
-```
-
-If you connect to ws://127.0.0.1:8008, the proxy will connect to ws://127.0.0.1:9000 and pass all traffic to this server.
-
-You can also use a more complex setup if you want to redirect to different websocket servers based on the hostname your client is trying to connect to. If you have multiple CNAME aliases that point to the same server.
-
-A JSON config file is used to express that mapping ; here connecting to echo.jeanserge.com will proxy the client to ws://localhost:8008 on the local machine (which actually runs ws echo_server), while connecting to bavarde.jeanserge.com will proxy the client to ws://localhost:5678 where a cobra python server is running. As a side note you will need a wildcard SSL certificate if you want to have SSL enabled on that machine.
-
-```
-echo.jeanserge.com=ws://localhost:8008
-bavarde.jeanserge.com=ws://localhost:5678
-```
-The --config_path option is required to instruct ws proxy_server to read that file.
-
-```
-ws proxy_server --config_path proxyConfig.json --port 8765
-```
-
-## 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
-```

httpd.cpp

@@ -1,46 +0,0 @@
-/*
- *  httpd.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- *
- *  Buid with make httpd
- */
-
-#include <ixwebsocket/IXHttpServer.h>
-#include <sstream>
-#include <iostream>
-
-int main(int argc, char** argv)
-{
-    if (argc != 3)
-    {
-        std::cerr << "Usage: " << argv[0]
-                  << " <port> <host>" << std::endl;
-        std::cerr << " " << argv[0] << " 9090 127.0.0.1" << std::endl;
-        std::cerr << " " << argv[0] << " 9090 0.0.0.0" << std::endl;
-        return 1;
-    }
-
-    int port;
-    std::stringstream ss;
-    ss << argv[1];
-    ss >> port;
-    std::string hostname(argv[2]);
-
-    std::cout << "Listening on " << hostname
-              << ":" << port << std::endl;
-
-    ix::HttpServer server(port, hostname);
-
-    auto res = server.listen();
-    if (!res.first)
-    {
-        std::cout << res.second << std::endl;
-        return 1;
-    }
-
-    server.start();
-    server.wait();
-
-    return 0;
-}

index.html

@@ -0,0 +1,375 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <meta http-equiv="X-UA-Compatible" content="IE=edge">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <meta name="description" content="None">
+        
+        
+        <link rel="shortcut icon" href="img/favicon.ico">
+        <title>IXWebSocket</title>
+        <link href="css/bootstrap.min.css" rel="stylesheet">
+        <link href="css/font-awesome.min.css" rel="stylesheet">
+        <link href="css/base.css" rel="stylesheet">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css">
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script>
+        <script>hljs.highlightAll();</script> 
+    </head>
+
+    <body class="homepage">
+        <div class="navbar fixed-top navbar-expand-lg navbar-dark bg-primary">
+            <div class="container">
+                <a class="navbar-brand" href=".">IXWebSocket</a>
+                <!-- Expander button -->
+                <button type="button" class="navbar-toggler" data-toggle="collapse" data-target="#navbar-collapse">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <!-- Expanded navigation -->
+                <div id="navbar-collapse" class="navbar-collapse collapse">
+                        <!-- Main navigation -->
+                        <ul class="nav navbar-nav">
+                            <li class="navitem active">
+                                <a href="." class="nav-link">Home</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="CHANGELOG/" class="nav-link">Changelog</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="build/" class="nav-link">Build</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="design/" class="nav-link">Design</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="packages/" class="nav-link">Packages</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="performance/" class="nav-link">Performance</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="usage/" class="nav-link">Examples</a>
+                            </li>
+                            <li class="navitem">
+                                <a href="ws/" class="nav-link">Ws</a>
+                            </li>
+                        </ul>
+
+                    <ul class="nav navbar-nav ml-auto">
+                        <li class="nav-item">
+                            <a href="#" class="nav-link" data-toggle="modal" data-target="#mkdocs_search_modal">
+                                <i class="fa fa-search"></i> Search
+                            </a>
+                        </li>
+                            <li class="nav-item">
+                                <a rel="prev" class="nav-link disabled">
+                                    <i class="fa fa-arrow-left"></i> Previous
+                                </a>
+                            </li>
+                            <li class="nav-item">
+                                <a rel="next" href="CHANGELOG/" class="nav-link">
+                                    Next <i class="fa fa-arrow-right"></i>
+                                </a>
+                            </li>
+                    </ul>
+                </div>
+            </div>
+        </div>
+
+        <div class="container">
+            <div class="row">
+                    <div class="col-md-3"><div class="navbar-light navbar-expand-md bs-sidebar hidden-print affix" role="complementary">
+    <div class="navbar-header">
+        <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents">
+            <span class="fa fa-angle-down"></span>
+        </button>
+    </div>
+
+    
+    <div id="toc-collapse" class="navbar-collapse collapse card bg-secondary">
+        <ul class="nav flex-column">
+            
+            <li class="nav-item" data-level="2"><a href="#hello-world" class="nav-link">Hello world</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            
+            <li class="nav-item" data-level="2"><a href="#users" class="nav-link">Users</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            
+            <li class="nav-item" data-level="2"><a href="#alternative-libraries" class="nav-link">Alternative libraries</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+            
+            <li class="nav-item" data-level="2"><a href="#continuous-integration" class="nav-link">Continuous Integration</a>
+              <ul class="nav flex-column">
+              </ul>
+            </li>
+        </ul>
+    </div>
+</div></div>
+                    <div class="col-md-9" role="main">
+
+<h2 id="hello-world">Hello world</h2>
+<p>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.</p>
+<p>It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android). It was tested on macOS, iOS, Linux, Android, Windows and FreeBSD. Note that the MinGW compiler is not supported at this point. Two important design goals are simplicity and correctness.</p>
+<p>A bad security bug affecting users compiling with SSL enabled and OpenSSL as the backend was just fixed in newly released version 11.0.0. Please upgrade ! (more details in the <a href="PR">https://github.com/machinezone/IXWebSocket/pull/250</a>.</p>
+<pre><code class="language-cpp">/*
+ *  main.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
+ *
+ *  Super simple standalone example. See ws folder, unittest and doc/usage.md for more.
+ *
+ *  On macOS
+ *  $ mkdir -p build ; (cd build ; cmake -DUSE_TLS=1 .. ; make -j ; make install)
+ *  $ clang++ --std=c++11 --stdlib=libc++ main.cpp -lixwebsocket -lz -framework Security -framework Foundation
+ *  $ ./a.out
+ *
+ *  Or use cmake -DBUILD_DEMO=ON option for other platforms
+ */
+
+#include &lt;ixwebsocket/IXNetSystem.h&gt;
+#include &lt;ixwebsocket/IXWebSocket.h&gt;
+#include &lt;ixwebsocket/IXUserAgent.h&gt;
+#include &lt;iostream&gt;
+
+int main()
+{
+    // Required on Windows
+    ix::initNetSystem();
+
+    // Our websocket object
+    ix::WebSocket webSocket;
+
+    // Connect to a server with encryption
+    // See https://machinezone.github.io/IXWebSocket/usage/#tls-support-and-configuration
+    std::string url(&quot;wss://echo.websocket.org&quot;);
+    webSocket.setUrl(url);
+
+    std::cout &lt;&lt; &quot;Connecting to &quot; &lt;&lt; url &lt;&lt; &quot;...&quot; &lt;&lt; std::endl;
+
+    // Setup a callback to be fired (in a background thread, watch out for race conditions !)
+    // when a message or an event (open, close, error) is received
+    webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr&amp; msg)
+        {
+            if (msg-&gt;type == ix::WebSocketMessageType::Message)
+            {
+                std::cout &lt;&lt; &quot;received message: &quot; &lt;&lt; msg-&gt;str &lt;&lt; std::endl;
+                std::cout &lt;&lt; &quot;&gt; &quot; &lt;&lt; std::flush;
+            }
+            else if (msg-&gt;type == ix::WebSocketMessageType::Open)
+            {
+                std::cout &lt;&lt; &quot;Connection established&quot; &lt;&lt; std::endl;
+                std::cout &lt;&lt; &quot;&gt; &quot; &lt;&lt; std::flush;
+            }
+            else if (msg-&gt;type == ix::WebSocketMessageType::Error)
+            {
+                // Maybe SSL is not configured properly
+                std::cout &lt;&lt; &quot;Connection error: &quot; &lt;&lt; msg-&gt;errorInfo.reason &lt;&lt; std::endl;
+                std::cout &lt;&lt; &quot;&gt; &quot; &lt;&lt; std::flush;
+            }
+        }
+    );
+
+    // 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(&quot;hello world&quot;);
+
+    // Display a prompt
+    std::cout &lt;&lt; &quot;&gt; &quot; &lt;&lt; std::flush;
+
+    std::string text;
+    // Read text from the console and send messages in text mode.
+    // Exit with Ctrl-D on Unix or Ctrl-Z on Windows.
+    while (std::getline(std::cin, text))
+    {
+        webSocket.send(text);
+        std::cout &lt;&lt; &quot;&gt; &quot; &lt;&lt; std::flush;
+    }
+
+    return 0;
+}
+</code></pre>
+<p>Interested? Go read the <a href="https://machinezone.github.io/IXWebSocket/">docs</a>! If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.</p>
+<p>IXWebSocket is actively being developed, check out the <a href="https://machinezone.github.io/IXWebSocket/CHANGELOG/">changelog</a> 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 <a href="https://github.com/machinezone/cobra">cobra</a>.</p>
+<p>IXWebSocket client code is autobahn compliant beginning with the 6.0.0 version. See the current <a href="https://bsergean.github.io/autobahn/reports/clients/index.html">test results</a>. Some tests are still failing in the server code.</p>
+<p>Starting with the 11.0.8 release, IXWebSocket should be fully C++11 compatible.</p>
+<h2 id="users">Users</h2>
+<p>If your company or project is using this library, feel free to open an issue or PR to amend this list.</p>
+<ul>
+<li><a href="https://www.mz.com">Machine Zone</a></li>
+<li><a href="https://gitlab.com/HCInk/tokio">Tokio</a>, a discord library focused on audio playback with node bindings.</li>
+<li><a href="https://github.com/tostc/libDiscordBot/tree/master">libDiscordBot</a>, an easy to use Discord-bot framework.</li>
+<li><a href="https://github.com/norrbotten/gwebsocket">gwebsocket</a>, a websocket (lua) module for Garry's Mod</li>
+<li><a href="https://github.com/DisCPP/DisCPP">DisCPP</a>, a simple but feature rich Discord API wrapper</li>
+<li><a href="https://github.com/luccanunes/discord.cpp">discord.cpp</a>, a discord library for making bots</li>
+<li><a href="http://teleportconnect.com/">Teleport</a>, Teleport is your own personal remote robot avatar</li>
+</ul>
+<h2 id="alternative-libraries">Alternative libraries</h2>
+<p>There are plenty of great websocket libraries out there, which might work for you. Here are a couple of serious ones.</p>
+<ul>
+<li><a href="https://github.com/zaphoyd/websocketpp">websocketpp</a> - C++</li>
+<li><a href="https://github.com/boostorg/beast">beast</a> - C++</li>
+<li><a href="https://libwebsockets.org/">libwebsockets</a> - C</li>
+<li><a href="https://github.com/uNetworking/uWebSockets">µWebSockets</a> - C</li>
+<li><a href="https://github.com/tatsuhiro-t/wslay">wslay</a> - C</li>
+</ul>
+<p><a href="https://github.com/bsergean/uvweb">uvweb</a> is a library written by the IXWebSocket author which is built on top of <a href="https://github.com/skypjack/uvw">uvw</a>, which is a C++ wrapper for <a href="https://libuv.org/">libuv</a>. It has more dependencies and does not support SSL at this point, but it can be used to open multiple connections within a single OS thread thanks to libuv.</p>
+<p>To check the performance of a websocket library, you can look at the <a href="https://github.com/bsergean/autoroute">autoroute</a> project.</p>
+<h2 id="continuous-integration">Continuous Integration</h2>
+<table>
+<thead>
+<tr>
+<th>OS</th>
+<th>TLS</th>
+<th>Sanitizer</th>
+<th>Status</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Linux</td>
+<td>OpenSSL</td>
+<td>None</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/linux/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>macOS</td>
+<td>Secure Transport</td>
+<td>Thread Sanitizer</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_sectransport/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>macOS</td>
+<td>OpenSSL</td>
+<td>Thread Sanitizer</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_openssl/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>macOS</td>
+<td>MbedTLS</td>
+<td>Thread Sanitizer</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/mac_tsan_mbedtls/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>Windows</td>
+<td>Disabled</td>
+<td>None</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/windows/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>UWP</td>
+<td>Disabled</td>
+<td>None</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/uwp/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>Linux</td>
+<td>OpenSSL</td>
+<td>Address Sanitizer</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/linux_asan/badge.svg" /></a></td>
+</tr>
+<tr>
+<td>Mingw</td>
+<td>Disabled</td>
+<td>None</td>
+<td><a href="https://github.com/machinezone/IXWebSocket"><img alt="Build2" src="https://github.com/machinezone/IXWebSocket/workflows/unittest_windows_gcc/badge.svg" /></a></td>
+</tr>
+</tbody>
+</table>
+<ul>
+<li>ASAN fails on Linux because of a known problem, we need a </li>
+<li>Some tests are disabled on Windows/UWP because of a pathing problem</li>
+<li>TLS and ZLIB are disabled on Windows/UWP because enabling make the CI run takes a lot of time, for setting up vcpkg.</li>
+</ul></div>
+            </div>
+        </div>
+
+        <footer class="col-md-12">
+            <hr>
+            <p>Documentation built with <a href="https://www.mkdocs.org/">MkDocs</a>.</p>
+        </footer>
+        <script src="js/jquery-3.6.0.min.js"></script>
+        <script src="js/bootstrap.min.js"></script>
+        <script>
+            var base_url = ".",
+                shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83};
+        </script>
+        <script src="js/base.js"></script>
+        <script src="search/main.js"></script>
+
+        <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="searchModalLabel" aria-hidden="true">
+    <div class="modal-dialog modal-lg">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="searchModalLabel">Search</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+                <p>From here you can search these documents. Enter your search terms below.</p>
+                <form>
+                    <div class="form-group">
+                        <input type="search" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here">
+                    </div>
+                </form>
+                <div id="mkdocs-search-results" data-no-results-text="No results found"></div>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="keyboardModalLabel" aria-hidden="true">
+    <div class="modal-dialog">
+        <div class="modal-content">
+            <div class="modal-header">
+                <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
+                <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button>
+            </div>
+            <div class="modal-body">
+              <table class="table">
+                <thead>
+                  <tr>
+                    <th style="width: 20%;">Keys</th>
+                    <th>Action</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <td class="help shortcut"><kbd>?</kbd></td>
+                    <td>Open this help</td>
+                  </tr>
+                  <tr>
+                    <td class="next shortcut"><kbd>n</kbd></td>
+                    <td>Next page</td>
+                  </tr>
+                  <tr>
+                    <td class="prev shortcut"><kbd>p</kbd></td>
+                    <td>Previous page</td>
+                  </tr>
+                  <tr>
+                    <td class="search shortcut"><kbd>s</kbd></td>
+                    <td>Search</td>
+                  </tr>
+                </tbody>
+              </table>
+            </div>
+            <div class="modal-footer">
+            </div>
+        </div>
+    </div>
+</div>
+
+    </body>
+</html>
+
+<!--
+MkDocs version : 1.5.3
+Build Date UTC : 2024-03-28 05:13:08.815010+00:00
+-->

ixwebsocket/IXBench.cpp

@@ -1,61 +0,0 @@
-/*
- *  IXBench.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXBench.h"
-
-#include <iostream>
-
-namespace ix
-{
-    Bench::Bench(const std::string& description)
-        : _description(description)
-    {
-        reset();
-    }
-
-    Bench::~Bench()
-    {
-        if (!_reported)
-        {
-            report();
-        }
-    }
-
-    void Bench::reset()
-    {
-        _start = std::chrono::high_resolution_clock::now();
-        _reported = false;
-    }
-
-    void Bench::report()
-    {
-        auto now = std::chrono::high_resolution_clock::now();
-        auto microseconds = std::chrono::duration_cast<std::chrono::microseconds>(now - _start);
-
-        _duration = microseconds.count();
-        std::cerr << _description << " completed in " << _duration << " us" << std::endl;
-
-        setReported();
-    }
-
-    void Bench::record()
-    {
-        auto now = std::chrono::high_resolution_clock::now();
-        auto microseconds = std::chrono::duration_cast<std::chrono::microseconds>(now - _start);
-
-        _duration = microseconds.count();
-    }
-
-    void Bench::setReported()
-    {
-        _reported = true;
-    }
-
-    uint64_t Bench::getDuration() const
-    {
-        return _duration;
-    }
-} // namespace ix

ixwebsocket/IXBench.h

@@ -1,32 +0,0 @@
-/*
- *  IXBench.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- */
-#pragma once
-
-#include <chrono>
-#include <stdint.h>
-#include <string>
-
-namespace ix
-{
-    class Bench
-    {
-    public:
-        Bench(const std::string& description);
-        ~Bench();
-
-        void reset();
-        void record();
-        void report();
-        void setReported();
-        uint64_t getDuration() const;
-
-    private:
-        std::string _description;
-        std::chrono::time_point<std::chrono::high_resolution_clock> _start;
-        uint64_t _duration;
-        bool _reported;
-    };
-} // namespace ix

ixwebsocket/IXCancellationRequest.cpp

@@ -1,35 +0,0 @@
-/*
- *  IXCancellationRequest.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXCancellationRequest.h"
-
-#include <cassert>
-#include <chrono>
-
-namespace ix
-{
-    CancellationRequest makeCancellationRequestWithTimeout(
-        int secs, std::atomic<bool>& requestInitCancellation)
-    {
-        assert(secs > 0);
-
-        auto start = std::chrono::system_clock::now();
-        auto timeout = std::chrono::seconds(secs);
-
-        auto isCancellationRequested = [&requestInitCancellation, start, timeout]() -> bool {
-            // Was an explicit cancellation requested ?
-            if (requestInitCancellation) return true;
-
-            auto now = std::chrono::system_clock::now();
-            if ((now - start) > timeout) return true;
-
-            // No cancellation request
-            return false;
-        };
-
-        return isCancellationRequested;
-    }
-} // namespace ix

ixwebsocket/IXCancellationRequest.h

@@ -1,18 +0,0 @@
-/*
- *  IXCancellationRequest.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <functional>
-
-namespace ix
-{
-    using CancellationRequest = std::function<bool()>;
-
-    CancellationRequest makeCancellationRequestWithTimeout(
-        int seconds, std::atomic<bool>& requestInitCancellation);
-} // namespace ix

ixwebsocket/IXConnectionState.cpp

@@ -1,73 +0,0 @@
-/*
- *  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>();
-    }
-
-    void ConnectionState::setOnSetTerminatedCallback(const OnSetTerminatedCallback& callback)
-    {
-        _onSetTerminatedCallback = callback;
-    }
-
-    bool ConnectionState::isTerminated() const
-    {
-        return _terminated;
-    }
-
-    void ConnectionState::setTerminated()
-    {
-        _terminated = true;
-
-        if (_onSetTerminatedCallback)
-        {
-            _onSetTerminatedCallback();
-        }
-    }
-
-    const std::string& ConnectionState::getRemoteIp()
-    {
-        return _remoteIp;
-    }
-
-    int ConnectionState::getRemotePort()
-    {
-        return _remotePort;
-    }
-
-    void ConnectionState::setRemoteIp(const std::string& remoteIp)
-    {
-        _remoteIp = remoteIp;
-    }
-
-    void ConnectionState::setRemotePort(int remotePort)
-    {
-        _remotePort = remotePort;
-    }
-} // namespace ix

ixwebsocket/IXConnectionState.h

@@ -1,54 +0,0 @@
-/*
- *  IXConnectionState.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <functional>
-#include <memory>
-#include <stdint.h>
-#include <string>
-
-namespace ix
-{
-    using OnSetTerminatedCallback = std::function<void()>;
-
-    class ConnectionState
-    {
-    public:
-        ConnectionState();
-        virtual ~ConnectionState() = default;
-
-        virtual void computeId();
-        virtual const std::string& getId() const;
-
-        void setTerminated();
-        bool isTerminated() const;
-
-        const std::string& getRemoteIp();
-        int getRemotePort();
-
-        static std::shared_ptr<ConnectionState> createConnectionState();
-
-    private:
-        void setOnSetTerminatedCallback(const OnSetTerminatedCallback& callback);
-
-        void setRemoteIp(const std::string& remoteIp);
-        void setRemotePort(int remotePort);
-
-    protected:
-        std::atomic<bool> _terminated;
-        std::string _id;
-        OnSetTerminatedCallback _onSetTerminatedCallback;
-
-        static std::atomic<uint64_t> _globalId;
-
-        std::string _remoteIp;
-        int _remotePort;
-
-        friend class SocketServer;
-    };
-} // namespace ix

ixwebsocket/IXDNSLookup.cpp

@@ -1,189 +0,0 @@
-/*
- *  IXDNSLookup.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-//
-// On Windows Universal Platform (uwp), gai_strerror defaults behavior is to returns wchar_t
-// which is different from all other platforms. We want the non unicode version.
-// See https://github.com/microsoft/vcpkg/pull/11030
-// We could do this in IXNetSystem.cpp but so far we are only using gai_strerror in here.
-//
-#ifdef _UNICODE
-#undef _UNICODE
-#endif
-#ifdef UNICODE
-#undef UNICODE
-#endif
-
-#include "IXDNSLookup.h"
-
-#include "IXNetSystem.h"
-#include <chrono>
-#include <string.h>
-#include <thread>
-
-namespace ix
-{
-    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)
-    {
-        ;
-    }
-
-    struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname,
-                                            int port,
-                                            std::string& errMsg)
-    {
-        struct addrinfo hints;
-        memset(&hints, 0, sizeof(hints));
-        hints.ai_flags = AI_ADDRCONFIG | AI_NUMERICSERV;
-        hints.ai_family = AF_UNSPEC;
-        hints.ai_socktype = SOCK_STREAM;
-
-        std::string sport = std::to_string(port);
-
-        struct addrinfo* res;
-        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(), &hints, &res);
-        if (getaddrinfo_result)
-        {
-            errMsg = gai_strerror(getaddrinfo_result);
-            res = nullptr;
-        }
-        return res;
-    }
-
-    struct addrinfo* DNSLookup::resolve(std::string& errMsg,
-                                        const CancellationRequest& isCancellationRequested,
-                                        bool cancellable)
-    {
-        return cancellable ? resolveCancellable(errMsg, isCancellationRequested)
-                           : resolveUnCancellable(errMsg, isCancellationRequested);
-    }
-
-    void DNSLookup::release(struct addrinfo* addr)
-    {
-        freeaddrinfo(addr);
-    }
-
-    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())
-        {
-            errMsg = "cancellation requested";
-            return nullptr;
-        }
-
-        return getAddrInfo(_hostname, _port, errMsg);
-    }
-
-    struct addrinfo* DNSLookup::resolveCancellable(
-        std::string& errMsg, const CancellationRequest& isCancellationRequested)
-    {
-        errMsg = "no error";
-
-        // Can only be called once, otherwise we would have to manage a pool
-        // of background thread which is overkill for our usage.
-        if (_done)
-        {
-            return nullptr; // programming error, create a second DNSLookup instance
-                            // if you need a second lookup.
-        }
-
-        //
-        // Good resource on thread forced termination
-        // https://www.bo-yang.net/2017/11/19/cpp-kill-detached-thread
-        //
-        auto ptr = shared_from_this();
-        std::weak_ptr<DNSLookup> self(ptr);
-
-        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 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())
-            {
-                errMsg = "cancellation requested";
-                return nullptr;
-            }
-        }
-
-        // Maybe a cancellation request got in before the bg terminated ?
-        if (isCancellationRequested())
-        {
-            errMsg = "cancellation requested";
-            return nullptr;
-        }
-
-        errMsg = getErrMsg();
-        return getRes();
-    }
-
-    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
-        // getAddrInfo needs to work.
-        std::string errMsg;
-        struct addrinfo* res = getAddrInfo(hostname, port, errMsg);
-
-        if (auto lock = self.lock())
-        {
-            // Copy result into the member variables
-            setRes(res);
-            setErrMsg(errMsg);
-
-            _done = true;
-        }
-    }
-
-    void DNSLookup::setErrMsg(const std::string& errMsg)
-    {
-        std::lock_guard<std::mutex> lock(_errMsgMutex);
-        _errMsg = errMsg;
-    }
-
-    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;
-    }
-} // namespace ix

ixwebsocket/IXDNSLookup.h

@@ -1,67 +0,0 @@
-/*
- *  IXDNSLookup.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- *
- *  Resolve a hostname+port to a struct addrinfo obtained with getaddrinfo
- *  Does this in a background thread so that it can be cancelled, since
- *  getaddrinfo is a blocking call, and we don't want to block the main thread on Mobile.
- */
-
-#pragma once
-
-#include "IXCancellationRequest.h"
-#include <atomic>
-#include <memory>
-#include <mutex>
-#include <set>
-#include <string>
-
-struct addrinfo;
-
-namespace ix
-{
-    class DNSLookup : public std::enable_shared_from_this<DNSLookup>
-    {
-    public:
-        DNSLookup(const std::string& hostname, int port, int64_t wait = DNSLookup::kDefaultWait);
-        ~DNSLookup() = default;
-
-        struct addrinfo* resolve(std::string& errMsg,
-                                 const CancellationRequest& isCancellationRequested,
-                                 bool cancellable = true);
-
-        void release(struct addrinfo* addr);
-
-    private:
-        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(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;
-        const static int64_t kDefaultWait;
-
-        struct addrinfo* _res;
-        std::mutex _resMutex;
-
-        std::string _errMsg;
-        std::mutex _errMsgMutex;
-
-        std::atomic<bool> _done;
-    };
-} // namespace ix

ixwebsocket/IXExponentialBackoff.cpp

@@ -1,25 +0,0 @@
-/*
- *  IXExponentialBackoff.cpp
- *  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 = (retry_count < 26) ? (std::pow(2, retry_count) * 100) : 0;
-
-        if (wait_time > maxWaitBetweenReconnectionRetries || wait_time == 0)
-        {
-            wait_time = maxWaitBetweenReconnectionRetries;
-        }
-
-        return wait_time;
-    }
-} // namespace ix

ixwebsocket/IXExponentialBackoff.h

@@ -1,15 +0,0 @@
-/*
- *  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/IXGetFreePort.cpp

@@ -1,97 +0,0 @@
-/*
- *  IXGetFreePort.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-// Using inet_addr will trigger an error on uwp without this
-// FIXME: use a different api
-#ifdef _WIN32
-#ifndef _WINSOCK_DEPRECATED_NO_WARNINGS
-#define _WINSOCK_DEPRECATED_NO_WARNINGS
-#endif
-#endif
-
-#include "IXGetFreePort.h"
-
-#include <ixwebsocket/IXNetSystem.h>
-#include <ixwebsocket/IXSocket.h>
-#include <random>
-#include <string>
-
-namespace ix
-{
-    int getAnyFreePortRandom()
-    {
-        std::random_device rd;
-        std::uniform_int_distribution<int> dist(1024 + 1, 65535);
-
-        return dist(rd);
-    }
-
-    int getAnyFreePort()
-    {
-        socket_t sockfd;
-        if ((sockfd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
-        {
-            return getAnyFreePortRandom();
-        }
-
-        int enable = 1;
-        if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, (char*) &enable, sizeof(enable)) < 0)
-        {
-            return getAnyFreePortRandom();
-        }
-
-        // Bind to port 0. This is the standard way to get a free port.
-        struct sockaddr_in server; // server address information
-        server.sin_family = AF_INET;
-        server.sin_port = htons(0);
-        server.sin_addr.s_addr = inet_addr("127.0.0.1");
-
-        if (bind(sockfd, (struct sockaddr*) &server, sizeof(server)) < 0)
-        {
-            Socket::closeSocket(sockfd);
-            return getAnyFreePortRandom();
-        }
-
-        struct sockaddr_in sa; // server address information
-        socklen_t len = sizeof(sa);
-        if (getsockname(sockfd, (struct sockaddr*) &sa, &len) < 0)
-        {
-            Socket::closeSocket(sockfd);
-            return getAnyFreePortRandom();
-        }
-
-        int port = ntohs(sa.sin_port);
-        Socket::closeSocket(sockfd);
-
-        return port;
-    }
-
-    int getFreePort()
-    {
-        while (true)
-        {
-#if defined(__has_feature)
-#if __has_feature(address_sanitizer)
-            int port = getAnyFreePortRandom();
-#else
-            int port = getAnyFreePort();
-#endif
-#else
-            int port = getAnyFreePort();
-#endif
-            //
-            // Only port above 1024 can be used by non root users, but for some
-            // reason I got port 7 returned with macOS when binding on port 0...
-            //
-            if (port > 1024)
-            {
-                return port;
-            }
-        }
-
-        return -1;
-    }
-} // namespace ix

ixwebsocket/IXGetFreePort.h

@@ -1,12 +0,0 @@
-/*
- *  IXGetFreePort.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-namespace ix
-{
-    int getFreePort();
-} // namespace ix

ixwebsocket/IXGzipCodec.cpp

@@ -1,183 +0,0 @@
-/*
- *  IXGzipCodec.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXGzipCodec.h"
-
-#include "IXBench.h"
-#include <array>
-#include <string.h>
-
-#ifdef IXWEBSOCKET_USE_ZLIB
-#include <zlib.h>
-#endif
-
-#ifdef IXWEBSOCKET_USE_DEFLATE
-#include <libdeflate.h>
-#endif
-
-namespace ix
-{
-    std::string gzipCompress(const std::string& str)
-    {
-#ifndef IXWEBSOCKET_USE_ZLIB
-        return std::string();
-#else
-#ifdef IXWEBSOCKET_USE_DEFLATE
-        int compressionLevel = 6;
-        struct libdeflate_compressor* compressor;
-
-        compressor = libdeflate_alloc_compressor(compressionLevel);
-
-        const void* uncompressed_data = str.data();
-        size_t uncompressed_size = str.size();
-        void* compressed_data;
-        size_t actual_compressed_size;
-        size_t max_compressed_size;
-
-        max_compressed_size = libdeflate_gzip_compress_bound(compressor, uncompressed_size);
-        compressed_data = malloc(max_compressed_size);
-
-        if (compressed_data == NULL)
-        {
-            return std::string();
-        }
-
-        actual_compressed_size = libdeflate_gzip_compress(
-            compressor, uncompressed_data, uncompressed_size, compressed_data, max_compressed_size);
-
-        libdeflate_free_compressor(compressor);
-
-        if (actual_compressed_size == 0)
-        {
-            free(compressed_data);
-            return std::string();
-        }
-
-        std::string out;
-        out.assign(reinterpret_cast<char*>(compressed_data), actual_compressed_size);
-        free(compressed_data);
-
-        return out;
-#else
-        z_stream zs; // z_stream is zlib's control structure
-        memset(&zs, 0, sizeof(zs));
-
-        // deflateInit2 configure the file format: request gzip instead of deflate
-        const int windowBits = 15;
-        const int GZIP_ENCODING = 16;
-
-        deflateInit2(&zs,
-                     Z_DEFAULT_COMPRESSION,
-                     Z_DEFLATED,
-                     windowBits | GZIP_ENCODING,
-                     8,
-                     Z_DEFAULT_STRATEGY);
-
-        zs.next_in = (Bytef*) str.data();
-        zs.avail_in = (uInt) str.size(); // set the z_stream's input
-
-        int ret;
-        char outbuffer[32768];
-        std::string outstring;
-
-        // retrieve the compressed bytes blockwise
-        do
-        {
-            zs.next_out = reinterpret_cast<Bytef*>(outbuffer);
-            zs.avail_out = sizeof(outbuffer);
-
-            ret = deflate(&zs, Z_FINISH);
-
-            if (outstring.size() < zs.total_out)
-            {
-                // append the block to the output string
-                outstring.append(outbuffer, zs.total_out - outstring.size());
-            }
-        } while (ret == Z_OK);
-
-        deflateEnd(&zs);
-
-        return outstring;
-#endif // IXWEBSOCKET_USE_DEFLATE
-#endif // IXWEBSOCKET_USE_ZLIB
-    }
-
-#ifdef IXWEBSOCKET_USE_DEFLATE
-    static uint32_t loadDecompressedGzipSize(const uint8_t* p)
-    {
-        return ((uint32_t) p[0] << 0) | ((uint32_t) p[1] << 8) | ((uint32_t) p[2] << 16) |
-               ((uint32_t) p[3] << 24);
-    }
-#endif
-
-    bool gzipDecompress(const std::string& in, std::string& out)
-    {
-#ifndef IXWEBSOCKET_USE_ZLIB
-        return false;
-#else
-#ifdef IXWEBSOCKET_USE_DEFLATE
-        struct libdeflate_decompressor* decompressor;
-        decompressor = libdeflate_alloc_decompressor();
-
-        const void* compressed_data = in.data();
-        size_t compressed_size = in.size();
-
-        // Retrieve uncompressed size from the trailer of the gziped data
-        const uint8_t* ptr = reinterpret_cast<const uint8_t*>(&in.front());
-        auto uncompressed_size = loadDecompressedGzipSize(&ptr[compressed_size - 4]);
-
-        // Use it to redimension our output buffer
-        out.resize(uncompressed_size);
-
-        libdeflate_result result = libdeflate_gzip_decompress(
-            decompressor, compressed_data, compressed_size, &out.front(), uncompressed_size, NULL);
-
-        libdeflate_free_decompressor(decompressor);
-        return result == LIBDEFLATE_SUCCESS;
-#else
-        z_stream inflateState;
-        memset(&inflateState, 0, sizeof(inflateState));
-
-        inflateState.zalloc = Z_NULL;
-        inflateState.zfree = Z_NULL;
-        inflateState.opaque = Z_NULL;
-        inflateState.avail_in = 0;
-        inflateState.next_in = Z_NULL;
-
-        if (inflateInit2(&inflateState, 16 + MAX_WBITS) != Z_OK)
-        {
-            return false;
-        }
-
-        inflateState.avail_in = (uInt) in.size();
-        inflateState.next_in = (unsigned char*) (const_cast<char*>(in.data()));
-
-        const int kBufferSize = 1 << 14;
-        std::array<unsigned char, kBufferSize> compressBuffer;
-
-        do
-        {
-            inflateState.avail_out = (uInt) kBufferSize;
-            inflateState.next_out = &compressBuffer.front();
-
-            int ret = inflate(&inflateState, Z_SYNC_FLUSH);
-
-            if (ret == Z_NEED_DICT || ret == Z_DATA_ERROR || ret == Z_MEM_ERROR)
-            {
-                inflateEnd(&inflateState);
-                return false;
-            }
-
-            out.append(reinterpret_cast<char*>(&compressBuffer.front()),
-                       kBufferSize - inflateState.avail_out);
-        } while (inflateState.avail_out == 0);
-
-        inflateEnd(&inflateState);
-        return true;
-#endif // IXWEBSOCKET_USE_DEFLATE
-#endif // IXWEBSOCKET_USE_ZLIB
-    }
-} // namespace ix

ixwebsocket/IXGzipCodec.h

@@ -1,15 +0,0 @@
-/*
- *  IXGzipCodec.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2020 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <string>
-
-namespace ix
-{
-    std::string gzipCompress(const std::string& str);
-    bool gzipDecompress(const std::string& in, std::string& out);
-} // namespace ix

ixwebsocket/IXHttp.cpp

@@ -1,213 +0,0 @@
-/*
- *  IXHttp.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXHttp.h"
-
-#include "IXCancellationRequest.h"
-#include "IXGzipCodec.h"
-#include "IXSocket.h"
-#include <sstream>
-#include <vector>
-
-namespace ix
-{
-    std::string Http::trim(const std::string& str)
-    {
-        std::string out;
-        for (auto c : str)
-        {
-            if (c != ' ' && c != '\n' && c != '\r')
-            {
-                out += c;
-            }
-        }
-
-        return out;
-    }
-
-    std::pair<std::string, int> Http::parseStatusLine(const std::string& line)
-    {
-        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
-        std::string token;
-        std::stringstream tokenStream(line);
-        std::vector<std::string> tokens;
-
-        // Split by ' '
-        while (std::getline(tokenStream, token, ' '))
-        {
-            tokens.push_back(token);
-        }
-
-        std::string httpVersion;
-        if (tokens.size() >= 1)
-        {
-            httpVersion = trim(tokens[0]);
-        }
-
-        int statusCode = -1;
-        if (tokens.size() >= 2)
-        {
-            std::stringstream ss;
-            ss << trim(tokens[1]);
-            ss >> statusCode;
-        }
-
-        return std::make_pair(httpVersion, statusCode);
-    }
-
-    std::tuple<std::string, std::string, std::string> Http::parseRequestLine(
-        const std::string& line)
-    {
-        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
-        std::string token;
-        std::stringstream tokenStream(line);
-        std::vector<std::string> tokens;
-
-        // Split by ' '
-        while (std::getline(tokenStream, token, ' '))
-        {
-            tokens.push_back(token);
-        }
-
-        std::string method;
-        if (tokens.size() >= 1)
-        {
-            method = trim(tokens[0]);
-        }
-
-        std::string requestUri;
-        if (tokens.size() >= 2)
-        {
-            requestUri = trim(tokens[1]);
-        }
-
-        std::string httpVersion;
-        if (tokens.size() >= 3)
-        {
-            httpVersion = trim(tokens[2]);
-        }
-
-        return std::make_tuple(method, requestUri, httpVersion);
-    }
-
-    std::tuple<bool, std::string, HttpRequestPtr> Http::parseRequest(
-        std::unique_ptr<Socket>& socket, int timeoutSecs)
-    {
-        HttpRequestPtr httpRequest;
-
-        std::atomic<bool> requestInitCancellation(false);
-
-        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);
-        }
-
-        std::string body;
-        if (headers.find("Content-Length") != headers.end())
-        {
-            int contentLength = 0;
-            try
-            {
-                contentLength = std::stoi(headers["Content-Length"]);
-            }
-            catch (std::exception)
-            {
-                return std::make_tuple(
-                    false, "Error parsing HTTP Header 'Content-Length'", httpRequest);
-            }
-
-            if (contentLength < 0)
-            {
-                return std::make_tuple(
-                    false, "Error: 'Content-Length' should be a positive integer", httpRequest);
-            }
-
-            auto res = socket->readBytes(contentLength, nullptr, isCancellationRequested);
-            if (!res.first)
-            {
-                return std::make_tuple(
-                    false, std::string("Error reading request: ") + res.second, httpRequest);
-            }
-            body = res.second;
-        }
-
-        // If the content was compressed with gzip, decode it
-        if (headers["Content-Encoding"] == "gzip")
-        {
-#ifdef IXWEBSOCKET_USE_ZLIB
-            std::string decompressedPayload;
-            if (!gzipDecompress(body, decompressedPayload))
-            {
-                return std::make_tuple(
-                    false, std::string("Error during gzip decompression of the body"), httpRequest);
-            }
-            body = decompressedPayload;
-#else
-            std::string errorMsg("ixwebsocket was not compiled with gzip support on");
-            return std::make_tuple(false, errorMsg, httpRequest);
-#endif
-        }
-
-        httpRequest = std::make_shared<HttpRequest>(uri, method, httpVersion, body, headers);
-        return std::make_tuple(true, "", httpRequest);
-    }
-
-    bool Http::sendResponse(HttpResponsePtr response, std::unique_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->body.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->body.empty() ? true : socket->writeBytes(response->body, nullptr);
-    }
-} // namespace ix

ixwebsocket/IXHttp.h

@@ -1,130 +0,0 @@
-/*
- *  IXHttp.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXProgressCallback.h"
-#include "IXWebSocketHttpHeaders.h"
-#include <tuple>
-#include <unordered_map>
-
-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 body;
-        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& b = std::string(),
-                     const std::string& e = std::string(),
-                     uint64_t u = 0,
-                     uint64_t d = 0)
-            : statusCode(s)
-            , description(des)
-            , errorCode(c)
-            , headers(h)
-            , body(b)
-            , errorMsg(e)
-            , uploadSize(u)
-            , downloadSize(d)
-        {
-            ;
-        }
-    };
-
-    using HttpResponsePtr = std::shared_ptr<HttpResponse>;
-    using HttpParameters = std::unordered_map<std::string, std::string>;
-    using HttpFormDataParameters = std::unordered_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;
-        std::string multipartBoundary;
-        int connectTimeout = 60;
-        int transferTimeout = 1800;
-        bool followRedirects = true;
-        int maxRedirects = 5;
-        bool verbose = false;
-        bool compress = true;
-        bool compressRequest = false;
-        Logger logger;
-        OnProgressCallback onProgressCallback;
-    };
-
-    using HttpRequestArgsPtr = std::shared_ptr<HttpRequestArgs>;
-
-    struct HttpRequest
-    {
-        std::string uri;
-        std::string method;
-        std::string version;
-        std::string body;
-        WebSocketHttpHeaders headers;
-
-        HttpRequest(const std::string& u,
-                    const std::string& m,
-                    const std::string& v,
-                    const std::string& b,
-                    const WebSocketHttpHeaders& h = WebSocketHttpHeaders())
-            : uri(u)
-            , method(m)
-            , version(v)
-            , body(b)
-            , headers(h)
-        {
-        }
-    };
-
-    using HttpRequestPtr = std::shared_ptr<HttpRequest>;
-
-    class Http
-    {
-    public:
-        static std::tuple<bool, std::string, HttpRequestPtr> parseRequest(
-            std::unique_ptr<Socket>& socket, int timeoutSecs);
-        static bool sendResponse(HttpResponsePtr response, std::unique_ptr<Socket>& socket);
-
-        static std::pair<std::string, int> parseStatusLine(const std::string& line);
-        static std::tuple<std::string, std::string, std::string> parseRequestLine(
-            const std::string& line);
-        static std::string trim(const std::string& str);
-    };
-} // namespace ix

ixwebsocket/IXHttpClient.cpp

@@ -1,750 +0,0 @@
-/*
- *  IXHttpClient.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXHttpClient.h"
-
-#include "IXGzipCodec.h"
-#include "IXSocketFactory.h"
-#include "IXUrlParser.h"
-#include "IXUserAgent.h"
-#include "IXWebSocketHttpHeaders.h"
-#include <assert.h>
-#include <cstring>
-#include <iomanip>
-#include <random>
-#include <sstream>
-#include <vector>
-
-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";
-    const std::string HttpClient::kPatch = "PATCH";
-
-    HttpClient::HttpClient(bool async)
-        : _async(async)
-        , _stop(false)
-        , _forceBody(false)
-    {
-        if (!_async) return;
-
-        _thread = std::thread(&HttpClient::run, this);
-    }
-
-    HttpClient::~HttpClient()
-    {
-        if (!_thread.joinable()) return;
-
-        _stop = true;
-        _condition.notify_one();
-        _thread.join();
-    }
-
-    void HttpClient::setTLSOptions(const SocketTLSOptions& tlsOptions)
-    {
-        _tlsOptions = tlsOptions;
-    }
-
-    void HttpClient::setForceBody(bool value)
-    {
-        _forceBody = value;
-    }
-
-    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,
-                                        HttpRequestArgsPtr args,
-                                        int redirects)
-    {
-        // We only have one socket connection, so we cannot
-        // make multiple requests concurrently.
-        std::lock_guard<std::recursive_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;
-
-        if (!UrlParser::parse(url, protocol, host, path, query, port))
-        {
-            std::stringstream ss;
-            ss << "Cannot parse url: " << url;
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::UrlMalformed,
-                                                  headers,
-                                                  payload,
-                                                  ss.str(),
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        bool tls = protocol == "https";
-        std::string errorMsg;
-        _socket = createSocket(tls, -1, errorMsg, _tlsOptions);
-
-        if (!_socket)
-        {
-            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";
-
-#ifdef IXWEBSOCKET_USE_ZLIB
-        if (args->compress)
-        {
-            ss << "Accept-Encoding: gzip"
-               << "\r\n";
-        }
-#endif
-
-        // Append extra headers
-        for (auto&& it : args->extraHeaders)
-        {
-            ss << it.first << ": " << it.second << "\r\n";
-        }
-
-        // 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 || verb == kPatch || _forceBody)
-        {
-            // Set request compression header
-#ifdef IXWEBSOCKET_USE_ZLIB
-            if (args->compressRequest)
-            {
-                ss << "Content-Encoding: gzip"
-                   << "\r\n";
-            }
-#endif
-
-            ss << "Content-Length: " << body.size() << "\r\n";
-
-            // Set default Content-Type if unspecified
-            if (args->extraHeaders.find("Content-Type") == args->extraHeaders.end())
-            {
-                if (args->multipartBoundary.empty())
-                {
-                    ss << "Content-Type: application/x-www-form-urlencoded"
-                       << "\r\n";
-                }
-                else
-                {
-                    ss << "Content-Type: multipart/form-data; boundary=" << args->multipartBoundary
-                       << "\r\n";
-                }
-            }
-            ss << "\r\n";
-            ss << body;
-        }
-        else
-        {
-            ss << "\r\n";
-        }
-
-        std::string req(ss.str());
-        std::string errMsg;
-
-        // Make a cancellation object dealing with connection timeout
-        auto isCancellationRequested =
-            makeCancellationRequestWithTimeout(args->connectTimeout, _stop);
-
-        bool success = _socket->connect(host, port, errMsg, isCancellationRequested);
-        if (!success)
-        {
-            std::stringstream ss;
-            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, _stop);
-
-        if (args->verbose)
-        {
-            std::stringstream ss;
-            ss << "Sending " << verb << " request "
-               << "to " << host << ":" << port << std::endl
-               << "request size: " << req.size() << " bytes" << std::endl
-               << "=============" << std::endl
-               << req << "=============" << std::endl
-               << std::endl;
-
-            log(ss.str(), args);
-        }
-
-        if (!_socket->writeBytes(req, isCancellationRequested))
-        {
-            std::string errorMsg("Cannot send request");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::SendError,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        uploadSize = req.size();
-
-        auto lineResult = _socket->readLine(isCancellationRequested);
-        auto lineValid = lineResult.first;
-        auto line = lineResult.second;
-
-        if (!lineValid)
-        {
-            std::string errorMsg("Cannot retrieve status line");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotReadStatusLine,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        if (args->verbose)
-        {
-            std::stringstream ss;
-            ss << "Status line " << line;
-            log(ss.str(), args);
-        }
-
-        if (sscanf(line.c_str(), "HTTP/1.1 %d", &code) != 1)
-        {
-            std::string errorMsg("Cannot parse response code from status line");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::MissingStatus,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        auto result = parseHttpHeaders(_socket, isCancellationRequested);
-        auto headersValid = result.first;
-        headers = result.second;
-
-        if (!headersValid)
-        {
-            std::string errorMsg("Cannot parse http headers");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::HeaderParsingError,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        // Redirect ?
-        if ((code >= 301 && code <= 308) && args->followRedirects)
-        {
-            if (headers.find("Location") == headers.end())
-            {
-                std::string errorMsg("Missing location header for redirect");
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::MissingLocation,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
-            }
-
-            if (redirects >= args->maxRedirects)
-            {
-                std::stringstream ss;
-                ss << "Too many redirects: " << redirects;
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::TooManyRedirects,
-                                                      headers,
-                                                      payload,
-                                                      ss.str(),
-                                                      uploadSize,
-                                                      downloadSize);
-            }
-
-            // Recurse
-            std::string location = headers["Location"];
-            return request(location, verb, body, args, redirects + 1);
-        }
-
-        if (verb == "HEAD")
-        {
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::Ok,
-                                                  headers,
-                                                  payload,
-                                                  std::string(),
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        // Parse response:
-        if (headers.find("Content-Length") != headers.end())
-        {
-            ssize_t contentLength = -1;
-            ss.str("");
-            ss << headers["Content-Length"];
-            ss >> contentLength;
-
-            payload.reserve(contentLength);
-
-            auto chunkResult = _socket->readBytes(
-                contentLength, args->onProgressCallback, isCancellationRequested);
-            if (!chunkResult.first)
-            {
-                errorMsg = "Cannot read chunk";
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::ChunkReadError,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
-            }
-            payload += chunkResult.second;
-        }
-        else if (headers.find("Transfer-Encoding") != headers.end() &&
-                 headers["Transfer-Encoding"] == "chunked")
-        {
-            std::stringstream ss;
-
-            while (true)
-            {
-                lineResult = _socket->readLine(isCancellationRequested);
-                line = lineResult.second;
-
-                if (!lineResult.first)
-                {
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
-                }
-
-                uint64_t chunkSize;
-                ss.str("");
-                ss << std::hex << line;
-                ss >> chunkSize;
-
-                if (args->verbose)
-                {
-                    std::stringstream oss;
-                    oss << "Reading " << chunkSize << " bytes" << std::endl;
-                    log(oss.str(), args);
-                }
-
-                payload.reserve(payload.size() + (size_t) chunkSize);
-
-                // Read a chunk
-                auto chunkResult = _socket->readBytes(
-                    (size_t) chunkSize, args->onProgressCallback, isCancellationRequested);
-                if (!chunkResult.first)
-                {
-                    errorMsg = "Cannot read chunk";
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
-                }
-                payload += chunkResult.second;
-
-                // Read the line that terminates the chunk (\r\n)
-                lineResult = _socket->readLine(isCancellationRequested);
-
-                if (!lineResult.first)
-                {
-                    return std::make_shared<HttpResponse>(code,
-                                                          description,
-                                                          HttpErrorCode::ChunkReadError,
-                                                          headers,
-                                                          payload,
-                                                          errorMsg,
-                                                          uploadSize,
-                                                          downloadSize);
-                }
-
-                if (chunkSize == 0) break;
-            }
-        }
-        else if (code == 204)
-        {
-            ; // 204 is NoContent response code
-        }
-        else
-        {
-            std::string errorMsg("Cannot read http body");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::CannotReadBody,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-        }
-
-        downloadSize = payload.size();
-
-        // If the content was compressed with gzip, decode it
-        if (headers["Content-Encoding"] == "gzip")
-        {
-#ifdef IXWEBSOCKET_USE_ZLIB
-            std::string decompressedPayload;
-            if (!gzipDecompress(payload, decompressedPayload))
-            {
-                std::string errorMsg("Error decompressing payload");
-                return std::make_shared<HttpResponse>(code,
-                                                      description,
-                                                      HttpErrorCode::Gzip,
-                                                      headers,
-                                                      payload,
-                                                      errorMsg,
-                                                      uploadSize,
-                                                      downloadSize);
-            }
-            payload = decompressedPayload;
-#else
-            std::string errorMsg("ixwebsocket was not compiled with gzip support on");
-            return std::make_shared<HttpResponse>(code,
-                                                  description,
-                                                  HttpErrorCode::Gzip,
-                                                  headers,
-                                                  payload,
-                                                  errorMsg,
-                                                  uploadSize,
-                                                  downloadSize);
-#endif
-        }
-
-        return std::make_shared<HttpResponse>(code,
-                                              description,
-                                              HttpErrorCode::Ok,
-                                              headers,
-                                              payload,
-                                              std::string(),
-                                              uploadSize,
-                                              downloadSize);
-    }
-
-    HttpResponsePtr HttpClient::get(const std::string& url, HttpRequestArgsPtr args)
-    {
-        return request(url, kGet, std::string(), args);
-    }
-
-    HttpResponsePtr HttpClient::head(const std::string& url, HttpRequestArgsPtr args)
-    {
-        return request(url, kHead, std::string(), args);
-    }
-
-    HttpResponsePtr HttpClient::del(const std::string& url, HttpRequestArgsPtr args)
-    {
-        return request(url, kDel, std::string(), args);
-    }
-
-    HttpResponsePtr HttpClient::request(const std::string& url,
-                                        const std::string& verb,
-                                        const HttpParameters& httpParameters,
-                                        const HttpFormDataParameters& httpFormDataParameters,
-                                        HttpRequestArgsPtr args)
-    {
-        std::string body;
-
-        if (httpFormDataParameters.empty())
-        {
-            body = serializeHttpParameters(httpParameters);
-        }
-        else
-        {
-            std::string multipartBoundary = generateMultipartBoundary();
-            args->multipartBoundary = multipartBoundary;
-            body = serializeHttpFormDataParameters(
-                multipartBoundary, httpFormDataParameters, httpParameters);
-        }
-
-#ifdef IXWEBSOCKET_USE_ZLIB
-        if (args->compressRequest)
-        {
-            body = gzipCompress(body);
-        }
-#endif
-
-        return request(url, verb, body, args);
-    }
-
-    HttpResponsePtr HttpClient::post(const std::string& url,
-                                     const HttpParameters& httpParameters,
-                                     const HttpFormDataParameters& httpFormDataParameters,
-                                     HttpRequestArgsPtr args)
-    {
-        return request(url, kPost, httpParameters, httpFormDataParameters, 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,
-                                    const HttpFormDataParameters& httpFormDataParameters,
-                                    HttpRequestArgsPtr args)
-    {
-        return request(url, kPut, httpParameters, httpFormDataParameters, args);
-    }
-
-    HttpResponsePtr HttpClient::put(const std::string& url,
-                                    const std::string& body,
-                                    const HttpRequestArgsPtr args)
-    {
-        return request(url, kPut, body, args);
-    }
-
-    HttpResponsePtr HttpClient::patch(const std::string& url,
-                                      const HttpParameters& httpParameters,
-                                      const HttpFormDataParameters& httpFormDataParameters,
-                                      HttpRequestArgsPtr args)
-    {
-        return request(url, kPatch, httpParameters, httpFormDataParameters, args);
-    }
-
-    HttpResponsePtr HttpClient::patch(const std::string& url,
-                                      const std::string& body,
-                                      const HttpRequestArgsPtr args)
-    {
-        return request(url, kPatch, body, args);
-    }
-
-    std::string HttpClient::urlEncode(const std::string& value)
-    {
-        std::ostringstream escaped;
-        escaped.fill('0');
-        escaped << std::hex;
-
-        for (std::string::const_iterator i = value.begin(), n = value.end(); i != n; ++i)
-        {
-            std::string::value_type c = (*i);
-
-            // Keep alphanumeric and other accepted characters intact
-            if (isalnum(c) || c == '-' || c == '_' || c == '.' || c == '~')
-            {
-                escaped << c;
-                continue;
-            }
-
-            // Any other characters are percent-encoded
-            escaped << std::uppercase;
-            escaped << '%' << std::setw(2) << int((unsigned char) c);
-            escaped << std::nouppercase;
-        }
-
-        return escaped.str();
-    }
-
-    std::string HttpClient::serializeHttpParameters(const HttpParameters& httpParameters)
-    {
-        std::stringstream ss;
-        size_t count = httpParameters.size();
-        size_t i = 0;
-
-        for (auto&& it : httpParameters)
-        {
-            ss << urlEncode(it.first) << "=" << urlEncode(it.second);
-
-            if (i++ < (count - 1))
-            {
-                ss << "&";
-            }
-        }
-        return ss.str();
-    }
-
-    std::string HttpClient::serializeHttpFormDataParameters(
-        const std::string& multipartBoundary,
-        const HttpFormDataParameters& httpFormDataParameters,
-        const HttpParameters& httpParameters)
-    {
-        //
-        // --AaB03x
-        // Content-Disposition: form-data; name="submit-name"
-
-        // Larry
-        // --AaB03x
-        // Content-Disposition: form-data; name="foo.txt"; filename="file1.txt"
-        // Content-Type: text/plain
-
-        // ... contents of file1.txt ...
-        // --AaB03x--
-        //
-        std::stringstream ss;
-
-        for (auto&& it : httpFormDataParameters)
-        {
-            ss << "--" << multipartBoundary << "\r\n"
-               << "Content-Disposition:"
-               << " form-data; name=\"" << it.first << "\";"
-               << " filename=\"" << it.first << "\""
-               << "\r\n"
-               << "Content-Type: application/octet-stream"
-               << "\r\n"
-               << "\r\n"
-               << it.second << "\r\n";
-        }
-
-        for (auto&& it : httpParameters)
-        {
-            ss << "--" << multipartBoundary << "\r\n"
-               << "Content-Disposition:"
-               << " form-data; name=\"" << it.first << "\";"
-               << "\r\n"
-               << "\r\n"
-               << it.second << "\r\n";
-        }
-
-        ss << "--" << multipartBoundary << "--\r\n";
-
-        return ss.str();
-    }
-
-    void HttpClient::log(const std::string& msg, HttpRequestArgsPtr args)
-    {
-        if (args->logger)
-        {
-            args->logger(msg);
-        }
-    }
-
-    std::string HttpClient::generateMultipartBoundary()
-    {
-        std::string str("0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz");
-
-        static std::random_device rd;
-        static std::mt19937 generator(rd());
-
-        std::shuffle(str.begin(), str.end(), generator);
-
-        return str;
-    }
-} // namespace ix

ixwebsocket/IXHttpClient.h

@@ -1,123 +0,0 @@
-/*
- *  IXHttpClient.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXHttp.h"
-#include "IXSocket.h"
-#include "IXSocketTLSOptions.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
-{
-    class HttpClient
-    {
-    public:
-        HttpClient(bool async = false);
-        ~HttpClient();
-
-        HttpResponsePtr get(const std::string& url, HttpRequestArgsPtr args);
-        HttpResponsePtr head(const std::string& url, HttpRequestArgsPtr args);
-        HttpResponsePtr del(const std::string& url, HttpRequestArgsPtr args);
-
-        HttpResponsePtr post(const std::string& url,
-                             const HttpParameters& httpParameters,
-                             const HttpFormDataParameters& httpFormDataParameters,
-                             HttpRequestArgsPtr args);
-        HttpResponsePtr post(const std::string& url,
-                             const std::string& body,
-                             HttpRequestArgsPtr args);
-
-        HttpResponsePtr put(const std::string& url,
-                            const HttpParameters& httpParameters,
-                            const HttpFormDataParameters& httpFormDataParameters,
-                            HttpRequestArgsPtr args);
-        HttpResponsePtr put(const std::string& url,
-                            const std::string& body,
-                            HttpRequestArgsPtr args);
-
-        HttpResponsePtr patch(const std::string& url,
-                              const HttpParameters& httpParameters,
-                              const HttpFormDataParameters& httpFormDataParameters,
-                              HttpRequestArgsPtr args);
-        HttpResponsePtr patch(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);
-
-        HttpResponsePtr request(const std::string& url,
-                                const std::string& verb,
-                                const HttpParameters& httpParameters,
-                                const HttpFormDataParameters& httpFormDataParameters,
-                                HttpRequestArgsPtr args);
-
-        void setForceBody(bool value);
-
-        // Async API
-        HttpRequestArgsPtr createRequest(const std::string& url = std::string(),
-                                         const std::string& verb = HttpClient::kGet);
-
-        bool performRequest(HttpRequestArgsPtr request,
-                            const OnResponseCallback& onResponseCallback);
-
-        // TLS
-        void setTLSOptions(const SocketTLSOptions& tlsOptions);
-
-        std::string serializeHttpParameters(const HttpParameters& httpParameters);
-
-        std::string serializeHttpFormDataParameters(
-            const std::string& multipartBoundary,
-            const HttpFormDataParameters& httpFormDataParameters,
-            const HttpParameters& httpParameters = HttpParameters());
-
-        std::string generateMultipartBoundary();
-
-        std::string urlEncode(const std::string& value);
-
-        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;
-        const static std::string kPatch;
-
-    private:
-        void log(const std::string& msg, HttpRequestArgsPtr args);
-
-        // 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::unique_ptr<Socket> _socket;
-        std::recursive_mutex _mutex; // to protect accessing the _socket (only one socket per
-                                     // client) the mutex needs to be recursive as this function
-                                     // might be called recursively to follow HTTP redirections
-
-        SocketTLSOptions _tlsOptions;
-
-        bool _forceBody;
-    };
-} // namespace ix

ixwebsocket/IXHttpServer.cpp

@@ -1,229 +0,0 @@
-/*
- *  IXHttpServer.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXHttpServer.h"
-
-#include "IXGzipCodec.h"
-#include "IXNetSystem.h"
-#include "IXSocketConnect.h"
-#include "IXUserAgent.h"
-#include <cstring>
-#include <fstream>
-#include <sstream>
-#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
-
-namespace ix
-{
-    const int HttpServer::kDefaultTimeoutSecs(30);
-
-    HttpServer::HttpServer(int port,
-                           const std::string& host,
-                           int backlog,
-                           size_t maxConnections,
-                           int addressFamily,
-                           int timeoutSecs)
-        : SocketServer(port, host, backlog, maxConnections, addressFamily)
-        , _connectedClientsCount(0)
-        , _timeoutSecs(timeoutSecs)
-    {
-        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(std::unique_ptr<Socket> socket,
-                                      std::shared_ptr<ConnectionState> connectionState)
-    {
-        _connectedClientsCount++;
-
-        auto ret = Http::parseRequest(socket, _timeoutSecs);
-        // 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";
-                }
-
-                WebSocketHttpHeaders headers;
-                headers["Server"] = userAgent();
-
-                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;
-
-#ifdef IXWEBSOCKET_USE_ZLIB
-                std::string acceptEncoding = request->headers["Accept-encoding"];
-                if (acceptEncoding == "*" || acceptEncoding.find("gzip") != std::string::npos)
-                {
-                    content = gzipCompress(content);
-                    headers["Content-Encoding"] = "gzip";
-                }
-#endif
-
-                // Log request
-                std::stringstream ss;
-                ss << connectionState->getRemoteIp() << ":" << connectionState->getRemotePort()
-                   << " " << request->method << " " << request->headers["User-Agent"] << " "
-                   << request->uri << " " << content.size();
-                logInfo(ss.str());
-
-                // 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);
-            });
-    }
-
-    void HttpServer::makeRedirectServer(const std::string& redirectUrl)
-    {
-        //
-        // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections
-        //
-        setOnConnectionCallback(
-            [this,
-             redirectUrl](HttpRequestPtr request,
-                          std::shared_ptr<ConnectionState> connectionState) -> HttpResponsePtr {
-                WebSocketHttpHeaders headers;
-                headers["Server"] = userAgent();
-
-                // Log request
-                std::stringstream ss;
-                ss << connectionState->getRemoteIp() << ":" << connectionState->getRemotePort()
-                   << " " << request->method << " " << request->headers["User-Agent"] << " "
-                   << request->uri;
-                logInfo(ss.str());
-
-                if (request->method == "POST")
-                {
-                    return std::make_shared<HttpResponse>(
-                        200, "OK", HttpErrorCode::Ok, headers, std::string());
-                }
-
-                headers["Location"] = redirectUrl;
-
-                return std::make_shared<HttpResponse>(
-                    301, "OK", HttpErrorCode::Ok, headers, std::string());
-            });
-    }
-
-    //
-    // Display the client parameter and body on the console
-    //
-    void HttpServer::makeDebugServer()
-    {
-        setOnConnectionCallback(
-            [this](HttpRequestPtr request,
-                   std::shared_ptr<ConnectionState> connectionState) -> HttpResponsePtr {
-                WebSocketHttpHeaders headers;
-                headers["Server"] = userAgent();
-
-                // Log request
-                std::stringstream ss;
-                ss << connectionState->getRemoteIp() << ":" << connectionState->getRemotePort()
-                   << " " << request->method << " " << request->headers["User-Agent"] << " "
-                   << request->uri;
-                logInfo(ss.str());
-
-                logInfo("== Headers == ");
-                for (auto&& it : request->headers)
-                {
-                    std::ostringstream oss;
-                    oss << it.first << ": " << it.second;
-                    logInfo(oss.str());
-                }
-                logInfo("");
-
-                logInfo("== Body == ");
-                logInfo(request->body);
-                logInfo("");
-
-                return std::make_shared<HttpResponse>(
-                    200, "OK", HttpErrorCode::Ok, headers, std::string("OK"));
-            });
-    }
-} // namespace ix

ixwebsocket/IXHttpServer.h

@@ -1,58 +0,0 @@
-/*
- *  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,
-                   int addressFamily = SocketServer::kDefaultAddressFamily,
-                   int timeoutSecs = HttpServer::kDefaultTimeoutSecs);
-        virtual ~HttpServer();
-        virtual void stop() final;
-
-        void setOnConnectionCallback(const OnConnectionCallback& callback);
-
-        void makeRedirectServer(const std::string& redirectUrl);
-
-        void makeDebugServer();
-
-    private:
-        // Member variables
-        OnConnectionCallback _onConnectionCallback;
-        std::atomic<int> _connectedClientsCount;
-
-        const static int kDefaultTimeoutSecs;
-        int _timeoutSecs;
-
-        // Methods
-        virtual void handleConnection(std::unique_ptr<Socket>,
-                                      std::shared_ptr<ConnectionState> connectionState) final;
-        virtual size_t getConnectedClientsCount() final;
-
-        void setDefaultConnectionCallback();
-    };
-} // namespace ix

ixwebsocket/IXNetSystem.cpp

@@ -1,127 +0,0 @@
-/*
- *  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
-    }
-
-    //
-    // That function could 'return WSAPoll(pfd, nfds, timeout);'
-    // but WSAPoll is said to have weird behaviors on the internet
-    // (the curl folks have had problems with it).
-    //
-    // So we make it a select wrapper
-    //
-    int poll(struct pollfd* fds, nfds_t nfds, int timeout)
-    {
-#ifdef _WIN32
-        socket_t maxfd = 0;
-        fd_set readfds, writefds, errorfds;
-        FD_ZERO(&readfds);
-        FD_ZERO(&writefds);
-        FD_ZERO(&errorfds);
-
-        for (nfds_t i = 0; i < nfds; ++i)
-        {
-            struct pollfd* fd = &fds[i];
-
-            if (fd->fd > maxfd)
-            {
-                maxfd = fd->fd;
-            }
-            if ((fd->events & POLLIN))
-            {
-                FD_SET(fd->fd, &readfds);
-            }
-            if ((fd->events & POLLOUT))
-            {
-                FD_SET(fd->fd, &writefds);
-            }
-            if ((fd->events & POLLERR))
-            {
-                FD_SET(fd->fd, &errorfds);
-            }
-        }
-
-        struct timeval tv;
-        tv.tv_sec = timeout / 1000;
-        tv.tv_usec = (timeout % 1000) * 1000;
-
-        int ret = select(maxfd + 1, &readfds, &writefds, &errorfds, timeout != -1 ? &tv : NULL);
-
-        if (ret < 0)
-        {
-            return ret;
-        }
-
-        for (nfds_t i = 0; i < nfds; ++i)
-        {
-            struct pollfd* fd = &fds[i];
-            fd->revents = 0;
-
-            if (FD_ISSET(fd->fd, &readfds))
-            {
-                fd->revents |= POLLIN;
-            }
-            if (FD_ISSET(fd->fd, &writefds))
-            {
-                fd->revents |= POLLOUT;
-            }
-            if (FD_ISSET(fd->fd, &errorfds))
-            {
-                fd->revents |= POLLERR;
-            }
-        }
-
-        return ret;
-#else
-        //
-        // It was reported that on Android poll can fail and return -1 with
-        // errno == EINTR, which should be a temp error and should typically
-        // be handled by retrying in a loop.
-        // Maybe we need to put all syscall / C functions in
-        // a new IXSysCalls.cpp and wrap them all.
-        //
-        // The style from libuv is as such.
-        //
-        int ret = -1;
-        do
-        {
-            ret = ::poll(fds, nfds, timeout);
-        } while (ret == -1 && errno == EINTR);
-
-        return ret;
-#endif
-    }
-
-} // namespace ix

ixwebsocket/IXNetSystem.h

@@ -1,47 +0,0 @@
-/*
- *  IXNetSystem.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-#ifdef _WIN32
-#include <WS2tcpip.h>
-#include <WinSock2.h>
-#include <basetsd.h>
-#include <io.h>
-#include <ws2def.h>
-
-// Define our own poll on Windows, as a wrapper on top of select
-typedef unsigned long int nfds_t;
-
-#else
-#include <arpa/inet.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <netdb.h>
-#include <netinet/in.h>
-#include <netinet/ip.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
-{
-#ifdef _WIN32
-    typedef SOCKET socket_t;
-#else
-    typedef int socket_t;
-#endif
-
-    bool initNetSystem();
-    bool uninitNetSystem();
-
-    int poll(struct pollfd* fds, nfds_t nfds, int timeout);
-} // namespace ix

ixwebsocket/IXProgressCallback.h

@@ -1,14 +0,0 @@
-/*
- *  IXProgressCallback.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <functional>
-
-namespace ix
-{
-    using OnProgressCallback = std::function<bool(int current, int total)>;
-}

ixwebsocket/IXSelectInterrupt.cpp

@@ -1,48 +0,0 @@
-/*
- *  IXSelectInterrupt.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXSelectInterrupt.h"
-
-namespace ix
-{
-    const uint64_t SelectInterrupt::kSendRequest = 1;
-    const uint64_t SelectInterrupt::kCloseRequest = 2;
-
-    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;
-    }
-} // namespace ix

ixwebsocket/IXSelectInterrupt.h

@@ -1,34 +0,0 @@
-/*
- *  IXSelectInterrupt.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <memory>
-#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;
-
-        // Used as special codes for pipe communication
-        static const uint64_t kSendRequest;
-        static const uint64_t kCloseRequest;
-    };
-
-    using SelectInterruptPtr = std::unique_ptr<SelectInterrupt>;
-} // namespace ix

ixwebsocket/IXSelectInterruptFactory.cpp

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

ixwebsocket/IXSelectInterruptFactory.h

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

ixwebsocket/IXSelectInterruptPipe.cpp

@@ -1,161 +0,0 @@
-/*
- *  IXSelectInterruptPipe.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
- */
-
-//
-// On UNIX we use pipes to wake up select. There is no way to do that
-// on Windows so this file is compiled out on Windows.
-//
-#ifndef _WIN32
-
-#include "IXSelectInterruptPipe.h"
-
-#include <assert.h>
-#include <errno.h>
-#include <fcntl.h>
-#include <sstream>
-#include <string.h> // for strerror
-#include <unistd.h> // for write
-
-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;
-
-        ssize_t ret = -1;
-        do
-        {
-            ret = ::write(fd, &value, sizeof(value));
-        } while (ret == -1 && errno == EINTR);
-
-        // we should write 8 bytes for an uint64_t
-        return ret == 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;
-
-        ssize_t ret = -1;
-        do
-        {
-            ret = ::read(fd, &value, sizeof(value));
-        } while (ret == -1 && errno == EINTR);
-
-        return value;
-    }
-
-    bool SelectInterruptPipe::clear()
-    {
-        return true;
-    }
-
-    int SelectInterruptPipe::getFd() const
-    {
-        std::lock_guard<std::mutex> lock(_fildesMutex);
-
-        return _fildes[kPipeReadIndex];
-    }
-} // namespace ix
-
-#endif // !_WIN32

ixwebsocket/IXSelectInterruptPipe.h

@@ -1,40 +0,0 @@
-/*
- *  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.cpp

@@ -1,81 +0,0 @@
-/*
- *  IXSetThreadName.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 2020 Machine Zone, Inc. All rights reserved.
- */
-#include "IXSetThreadName.h"
-
-// unix systems
-#if defined(__APPLE__) || defined(__linux__) || defined(BSD)
-#include <pthread.h>
-#endif
-
-// freebsd needs this header as well
-#if defined(BSD)
-#include <pthread_np.h>
-#endif
-
-// Windows
-#ifdef _WIN32
-#include <Windows.h>
-#endif
-
-namespace ix
-{
-#ifdef _WIN32
-    const DWORD MS_VC_EXCEPTION = 0x406D1388;
-
-#pragma pack(push, 8)
-    typedef struct tagTHREADNAME_INFO
-    {
-        DWORD dwType;     // Must be 0x1000.
-        LPCSTR szName;    // Pointer to name (in user addr space).
-        DWORD dwThreadID; // Thread ID (-1=caller thread).
-        DWORD dwFlags;    // Reserved for future use, must be zero.
-    } THREADNAME_INFO;
-#pragma pack(pop)
-
-    void SetThreadName(DWORD dwThreadID, const char* threadName)
-    {
-        THREADNAME_INFO info;
-        info.dwType = 0x1000;
-        info.szName = threadName;
-        info.dwThreadID = dwThreadID;
-        info.dwFlags = 0;
-
-        __try
-        {
-            RaiseException(
-                MS_VC_EXCEPTION, 0, sizeof(info) / sizeof(ULONG_PTR), (ULONG_PTR*) &info);
-        }
-        __except (EXCEPTION_EXECUTE_HANDLER)
-        {
-        }
-    }
-#endif
-
-    void setThreadName(const std::string& name)
-    {
-#if defined(__APPLE__)
-        //
-        // Apple reserves 16 bytes for its thread names
-        // Notice that the Apple version of pthread_setname_np
-        // does not take a pthread_t argument
-        //
-        pthread_setname_np(name.substr(0, 63).c_str());
-#elif defined(__linux__)
-        //
-        // Linux only reserves 16 bytes for its thread names
-        // See prctl and PR_SET_NAME property in
-        // http://man7.org/linux/man-pages/man2/prctl.2.html
-        //
-        pthread_setname_np(pthread_self(), name.substr(0, 15).c_str());
-#elif defined(_WIN32)
-        SetThreadName(-1, name.c_str());
-#elif defined(BSD)
-        pthread_set_name_np(pthread_self(), name.substr(0, 15).c_str());
-#else
-        // ... assert here ?
-#endif
-    }
-} // namespace ix

ixwebsocket/IXSetThreadName.h

@@ -1,12 +0,0 @@
-/*
- *  IXSetThreadName.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-#pragma once
-#include <string>
-
-namespace ix
-{
-    void setThreadName(const std::string& name);
-}

ixwebsocket/IXSocket.cpp

@@ -1,405 +0,0 @@
-/*
- *  IXSocket.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXSocket.h"
-
-#include "IXNetSystem.h"
-#include "IXSelectInterrupt.h"
-#include "IXSelectInterruptFactory.h"
-#include "IXSocketConnect.h"
-#include <algorithm>
-#include <array>
-#include <assert.h>
-#include <fcntl.h>
-#include <stdint.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/types.h>
-#include <vector>
-
-#ifdef min
-#undef min
-#endif
-
-namespace ix
-{
-    const int Socket::kDefaultPollNoTimeout = -1; // No poll timeout by default
-    const int Socket::kDefaultPollTimeout = kDefaultPollNoTimeout;
-
-    Socket::Socket(int fd)
-        : _sockfd(fd)
-        , _selectInterrupt(createSelectInterrupt())
-    {
-        ;
-    }
-
-    Socket::~Socket()
-    {
-        close();
-    }
-
-    PollResultType Socket::poll(bool readyToRead,
-                                int timeoutMs,
-                                int sockfd,
-                                const SelectInterruptPtr& selectInterrupt)
-    {
-        //
-        // 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
-        // have 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];
-        memset(fds, 0, sizeof(fds));
-
-        fds[0].fd = sockfd;
-        fds[0].events = (readyToRead) ? POLLIN : POLLOUT;
-
-        // this is ignored by poll, but our select based poll wrapper on Windows needs it
-        fds[0].events |= POLLERR;
-
-        // File descriptor used to interrupt select when needed
-        int interruptFd = -1;
-        if (selectInterrupt)
-        {
-            interruptFd = selectInterrupt->getFd();
-
-            if (interruptFd != -1)
-            {
-                nfds = 2;
-                fds[1].fd = interruptFd;
-                fds[1].events = POLLIN;
-            }
-        }
-
-        int ret = ix::poll(fds, nfds, timeoutMs);
-
-        PollResultType pollResult = PollResultType::ReadyForRead;
-        if (ret < 0)
-        {
-            pollResult = PollResultType::Error;
-        }
-        else if (ret == 0)
-        {
-            pollResult = PollResultType::Timeout;
-        }
-        else if (interruptFd != -1 && fds[1].revents & POLLIN)
-        {
-            uint64_t value = selectInterrupt->read();
-
-            if (value == SelectInterrupt::kSendRequest)
-            {
-                pollResult = PollResultType::SendRequest;
-            }
-            else if (value == SelectInterrupt::kCloseRequest)
-            {
-                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
-        }
-        else if (sockfd != -1 && (fds[0].revents & POLLERR || fds[0].revents & POLLHUP ||
-                                  fds[0].revents & POLLNVAL))
-        {
-            pollResult = PollResultType::Error;
-        }
-
-        return pollResult;
-    }
-
-    PollResultType Socket::isReadyToRead(int timeoutMs)
-    {
-        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::accept(std::string& errMsg)
-    {
-        if (_sockfd == -1)
-        {
-            errMsg = "Socket is uninitialized";
-            return false;
-        }
-        return true;
-    }
-
-    bool Socket::connect(const std::string& host,
-                         int port,
-                         std::string& errMsg,
-                         const CancellationRequest& isCancellationRequested)
-    {
-        std::lock_guard<std::mutex> lock(_socketMutex);
-
-        if (!_selectInterrupt->clear()) return false;
-
-        _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
-        return _sockfd != -1;
-    }
-
-    void Socket::close()
-    {
-        std::lock_guard<std::mutex> lock(_socketMutex);
-
-        if (_sockfd == -1) return;
-
-        closeSocket(_sockfd);
-        _sockfd = -1;
-    }
-
-    ssize_t Socket::send(char* buffer, size_t length)
-    {
-        int flags = 0;
-#ifdef MSG_NOSIGNAL
-        flags = MSG_NOSIGNAL;
-#endif
-
-        return ::send(_sockfd, buffer, length, flags);
-    }
-
-    ssize_t Socket::send(const std::string& buffer)
-    {
-        return send((char*) &buffer[0], buffer.size());
-    }
-
-    ssize_t Socket::recv(void* buffer, size_t length)
-    {
-        int flags = 0;
-#ifdef MSG_NOSIGNAL
-        flags = MSG_NOSIGNAL;
-#endif
-
-        return ::recv(_sockfd, (char*) buffer, length, flags);
-    }
-
-    int Socket::getErrno()
-    {
-        int err;
-
-#ifdef _WIN32
-        err = WSAGetLastError();
-#else
-        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)
-    {
-#ifdef _WIN32
-        closesocket(fd);
-#else
-        ::close(fd);
-#endif
-    }
-
-    bool Socket::init(std::string& errorMsg)
-    {
-        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 && isCancellationRequested()) return false;
-
-            ssize_t ret = send((char*) &str[offset], len);
-
-            // We wrote some bytes, as needed, all good.
-            if (ret > 0)
-            {
-                if (ret == len)
-                {
-                    return true;
-                }
-                else
-                {
-                    offset += ret;
-                    len -= ret;
-                    continue;
-                }
-            }
-            // There is possibly something to be writen, try again
-            else if (ret < 0 && Socket::isWaitNeeded())
-            {
-                continue;
-            }
-            // There was an error during the write, abort
-            else
-            {
-                return false;
-            }
-        }
-    }
-
-    bool Socket::readByte(void* buffer, const CancellationRequest& isCancellationRequested)
-    {
-        while (true)
-        {
-            if (isCancellationRequested && isCancellationRequested()) return false;
-
-            ssize_t ret;
-            ret = recv(buffer, 1);
-
-            // We read one byte, as needed, all good.
-            if (ret == 1)
-            {
-                return true;
-            }
-            // There is possibly something to be read, try again
-            else if (ret < 0 && Socket::isWaitNeeded())
-            {
-                // Wait with a 1ms timeout until the socket is ready to read.
-                // This way we are not busy looping
-                if (isReadyToRead(1) == PollResultType::Error)
-                {
-                    return false;
-                }
-            }
-            // There was an error during the read, abort
-            else
-            {
-                return false;
-            }
-        }
-    }
-
-    std::pair<bool, std::string> Socket::readLine(
-        const CancellationRequest& isCancellationRequested)
-    {
-        char c;
-        std::string line;
-        line.reserve(64);
-
-        for (int i = 0; i < 2 || (line[i - 2] != '\r' && line[i - 1] != '\n'); ++i)
-        {
-            if (!readByte(&c, isCancellationRequested))
-            {
-                // Return what we were able to read
-                return std::make_pair(false, line);
-            }
-
-            line += c;
-        }
-
-        return std::make_pair(true, line);
-    }
-
-    std::pair<bool, std::string> Socket::readBytes(
-        size_t length,
-        const OnProgressCallback& onProgressCallback,
-        const CancellationRequest& isCancellationRequested)
-    {
-        std::array<uint8_t, 1 << 14> readBuffer;
-
-        std::vector<uint8_t> output;
-        while (output.size() != length)
-        {
-            if (isCancellationRequested && isCancellationRequested())
-            {
-                const std::string errorMsg("Cancellation Requested");
-                return std::make_pair(false, errorMsg);
-            }
-
-            size_t size = std::min(readBuffer.size(), length - output.size());
-            ssize_t ret = recv((char*) &readBuffer[0], size);
-
-            if (ret > 0)
-            {
-                output.insert(output.end(), readBuffer.begin(), readBuffer.begin() + ret);
-            }
-            else if (ret <= 0 && !Socket::isWaitNeeded())
-            {
-                const std::string errorMsg("Recv Error");
-                return std::make_pair(false, errorMsg);
-            }
-
-            if (onProgressCallback) onProgressCallback((int) output.size(), (int) length);
-
-            // Wait with a 1ms timeout until the socket is ready to read.
-            // This way we are not busy looping
-            if (isReadyToRead(1) == PollResultType::Error)
-            {
-                const std::string errorMsg("Poll Error");
-                return std::make_pair(false, errorMsg);
-            }
-        }
-
-        return std::make_pair(true, std::string(output.begin(), output.end()));
-    }
-} // namespace ix

ixwebsocket/IXSocket.h

@@ -1,106 +0,0 @@
-/*
- *  IXSocket.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <atomic>
-#include <functional>
-#include <memory>
-#include <mutex>
-#include <string>
-
-#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 "IXSelectInterrupt.h"
-
-namespace ix
-{
-    enum class PollResultType
-    {
-        ReadyForRead = 0,
-        ReadyForWrite = 1,
-        Timeout = 2,
-        Error = 3,
-        SendRequest = 4,
-        CloseRequest = 5
-    };
-
-    class Socket
-    {
-    public:
-        Socket(int fd = -1);
-        virtual ~Socket();
-        bool init(std::string& errorMsg);
-
-        // Functions to check whether there is activity on the socket
-        PollResultType poll(int timeoutMs = kDefaultPollTimeout);
-        bool wakeUpFromPoll(uint64_t wakeUpCode);
-
-        PollResultType isReadyToWrite(int timeoutMs);
-        PollResultType isReadyToRead(int timeoutMs);
-
-        // Virtual methods
-        virtual bool accept(std::string& errMsg);
-
-        virtual bool connect(const std::string& host,
-                             int port,
-                             std::string& errMsg,
-                             const CancellationRequest& isCancellationRequested);
-        virtual void close();
-
-        virtual ssize_t send(char* buffer, size_t length);
-        ssize_t send(const std::string& buffer);
-        virtual ssize_t recv(void* buffer, size_t length);
-
-        // 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);
-
-        std::pair<bool, std::string> readLine(const CancellationRequest& isCancellationRequested);
-        std::pair<bool, std::string> readBytes(size_t length,
-                                               const OnProgressCallback& onProgressCallback,
-                                               const CancellationRequest& isCancellationRequested);
-
-        static int getErrno();
-        static bool isWaitNeeded();
-        static void closeSocket(int fd);
-
-        static PollResultType poll(bool readyToRead,
-                                   int timeoutMs,
-                                   int sockfd,
-                                   const SelectInterruptPtr& selectInterrupt);
-
-    protected:
-        std::atomic<int> _sockfd;
-        std::mutex _socketMutex;
-
-    private:
-        static const int kDefaultPollTimeout;
-        static const int kDefaultPollNoTimeout;
-
-        SelectInterruptPtr _selectInterrupt;
-    };
-} // namespace ix

ixwebsocket/IXSocketAppleSSL.cpp

@@ -1,313 +0,0 @@
-/*
- *  IXSocketAppleSSL.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- *
- *  Adapted from Satori SDK Apple SSL code.
- */
-#ifdef IXWEBSOCKET_USE_SECURE_TRANSPORT
-
-#include "IXSocketAppleSSL.h"
-
-#include "IXSocketConnect.h"
-#include <errno.h>
-#include <fcntl.h>
-#include <netdb.h>
-#include <netinet/tcp.h>
-#include <stdint.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <sys/socket.h>
-#include <sys/time.h>
-#include <sys/types.h>
-#include <unistd.h>
-#define socketerrno errno
-
-#include <Security/SecureTransport.h>
-
-namespace ix
-{
-    SocketAppleSSL::SocketAppleSSL(const SocketTLSOptions& tlsOptions, int fd)
-        : Socket(fd)
-        , _sslContext(nullptr)
-        , _tlsOptions(tlsOptions)
-    {
-        ;
-    }
-
-    SocketAppleSSL::~SocketAppleSSL()
-    {
-        SocketAppleSSL::close();
-    }
-
-    std::string SocketAppleSSL::getSSLErrorDescription(OSStatus status)
-    {
-        std::string errMsg("Unknown SSL error.");
-
-        CFErrorRef error = CFErrorCreate(kCFAllocatorDefault, kCFErrorDomainOSStatus, status, NULL);
-        if (error)
-        {
-            CFStringRef message = CFErrorCopyDescription(error);
-            if (message)
-            {
-                char localBuffer[128];
-                Boolean success;
-                success = CFStringGetCString(message, localBuffer, 128, kCFStringEncodingUTF8);
-                if (success)
-                {
-                    errMsg = localBuffer;
-                }
-                CFRelease(message);
-            }
-            CFRelease(error);
-        }
-
-        return errMsg;
-    }
-
-    OSStatus SocketAppleSSL::readFromSocket(SSLConnectionRef connection, void* data, size_t* len)
-    {
-        int fd = (int) (long) connection;
-        if (fd < 0) return errSSLInternal;
-
-        assert(data != nullptr);
-        assert(len != nullptr);
-
-        size_t requested_sz = *len;
-
-        ssize_t status = read(fd, data, requested_sz);
-
-        if (status > 0)
-        {
-            *len = (size_t) status;
-            if (requested_sz > *len)
-            {
-                return errSSLWouldBlock;
-            }
-            else
-            {
-                return noErr;
-            }
-        }
-        else if (status == 0)
-        {
-            *len = 0;
-            return errSSLClosedGraceful;
-        }
-        else
-        {
-            *len = 0;
-            switch (errno)
-            {
-                case ENOENT: return errSSLClosedGraceful;
-
-                case EAGAIN: return errSSLWouldBlock; // EWOULDBLOCK is a define for EAGAIN on osx
-                case EINPROGRESS: return errSSLWouldBlock;
-
-                case ECONNRESET: return errSSLClosedAbort;
-
-                default: return errSecIO;
-            }
-        }
-    }
-
-    OSStatus SocketAppleSSL::writeToSocket(SSLConnectionRef connection,
-                                           const void* data,
-                                           size_t* len)
-    {
-        int fd = (int) (long) connection;
-        if (fd < 0) return errSSLInternal;
-
-        assert(data != nullptr);
-        assert(len != nullptr);
-
-        size_t to_write_sz = *len;
-        ssize_t status = write(fd, data, to_write_sz);
-
-        if (status > 0)
-        {
-            *len = (size_t) status;
-            if (to_write_sz > *len)
-            {
-                return errSSLWouldBlock;
-            }
-            else
-            {
-                return noErr;
-            }
-        }
-        else if (status == 0)
-        {
-            *len = 0;
-            return errSSLClosedGraceful;
-        }
-        else
-        {
-            *len = 0;
-            switch (errno)
-            {
-                case ENOENT: return errSSLClosedGraceful;
-
-                case EAGAIN: return errSSLWouldBlock; // EWOULDBLOCK is a define for EAGAIN on osx
-                case EINPROGRESS: return errSSLWouldBlock;
-
-                case ECONNRESET: return errSSLClosedAbort;
-
-                default: return errSecIO;
-            }
-        }
-    }
-
-
-    bool SocketAppleSSL::accept(std::string& errMsg)
-    {
-        errMsg = "TLS not supported yet in server mode with apple ssl backend";
-        return false;
-    }
-
-    OSStatus SocketAppleSSL::tlsHandShake(std::string& errMsg,
-                                          const CancellationRequest& isCancellationRequested)
-    {
-        OSStatus status;
-
-        do
-        {
-            status = SSLHandshake(_sslContext);
-
-            // Interrupt the handshake
-            if (isCancellationRequested())
-            {
-                errMsg = "Cancellation requested";
-                return errSSLInternal;
-            }
-        } while (status == errSSLWouldBlock || status == errSSLServerAuthCompleted);
-
-        return status;
-    }
-
-    // No wait support
-    bool SocketAppleSSL::connect(const std::string& host,
-                                 int port,
-                                 std::string& errMsg,
-                                 const CancellationRequest& isCancellationRequested)
-    {
-        OSStatus status;
-        {
-            std::lock_guard<std::mutex> lock(_mutex);
-
-            _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
-            if (_sockfd == -1) return false;
-
-            _sslContext = SSLCreateContext(kCFAllocatorDefault, kSSLClientSide, kSSLStreamType);
-
-            SSLSetIOFuncs(
-                _sslContext, SocketAppleSSL::readFromSocket, SocketAppleSSL::writeToSocket);
-            SSLSetConnection(_sslContext, (SSLConnectionRef)(long) _sockfd);
-            SSLSetProtocolVersionMin(_sslContext, kTLSProtocol12);
-            SSLSetPeerDomainName(_sslContext, host.c_str(), host.size());
-
-            if (_tlsOptions.isPeerVerifyDisabled())
-            {
-                Boolean option(1);
-                SSLSetSessionOption(_sslContext, kSSLSessionOptionBreakOnServerAuth, option);
-
-                status = tlsHandShake(errMsg, isCancellationRequested);
-
-                if (status == errSSLServerAuthCompleted)
-                {
-                    // proceed with the handshake
-                    status = tlsHandShake(errMsg, isCancellationRequested);
-                }
-            }
-            else
-            {
-                status = tlsHandShake(errMsg, isCancellationRequested);
-            }
-        }
-
-        if (status != noErr)
-        {
-            errMsg = getSSLErrorDescription(status);
-            close();
-            return false;
-        }
-
-        return true;
-    }
-
-    void SocketAppleSSL::close()
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        if (_sslContext == nullptr) return;
-
-        SSLClose(_sslContext);
-        CFRelease(_sslContext);
-        _sslContext = nullptr;
-
-        Socket::close();
-    }
-
-    ssize_t SocketAppleSSL::send(char* buf, size_t nbyte)
-    {
-        OSStatus status = errSSLWouldBlock;
-        while (status == errSSLWouldBlock)
-        {
-            size_t processed = 0;
-            std::lock_guard<std::mutex> lock(_mutex);
-            status = SSLWrite(_sslContext, buf, nbyte, &processed);
-
-            if (processed > 0) return (ssize_t) processed;
-
-            // The connection was reset, inform the caller that this
-            // Socket should close
-            if (status == errSSLClosedGraceful || status == errSSLClosedNoNotify ||
-                status == errSSLClosedAbort)
-            {
-                errno = ECONNRESET;
-                return -1;
-            }
-
-            if (status == errSSLWouldBlock)
-            {
-                errno = EWOULDBLOCK;
-                return -1;
-            }
-        }
-        return -1;
-    }
-
-    // No wait support
-    ssize_t SocketAppleSSL::recv(void* buf, size_t nbyte)
-    {
-        OSStatus status = errSSLWouldBlock;
-        while (status == errSSLWouldBlock)
-        {
-            size_t processed = 0;
-            std::lock_guard<std::mutex> lock(_mutex);
-            status = SSLRead(_sslContext, buf, nbyte, &processed);
-
-            if (processed > 0) return (ssize_t) processed;
-
-            // The connection was reset, inform the caller that this
-            // Socket should close
-            if (status == errSSLClosedGraceful || status == errSSLClosedNoNotify ||
-                status == errSSLClosedAbort)
-            {
-                errno = ECONNRESET;
-                return -1;
-            }
-
-            if (status == errSSLWouldBlock)
-            {
-                errno = EWOULDBLOCK;
-                return -1;
-            }
-        }
-        return -1;
-    }
-
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_SECURE_TRANSPORT

ixwebsocket/IXSocketAppleSSL.h

@@ -1,52 +0,0 @@
-/*
- *  IXSocketAppleSSL.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2020 Machine Zone, Inc. All rights reserved.
- */
-#ifdef IXWEBSOCKET_USE_SECURE_TRANSPORT
-
-#pragma once
-
-#include "IXCancellationRequest.h"
-#include "IXSocket.h"
-#include "IXSocketTLSOptions.h"
-#include <Security/SecureTransport.h>
-#include <Security/Security.h>
-#include <mutex>
-
-namespace ix
-{
-    class SocketAppleSSL final : public Socket
-    {
-    public:
-        SocketAppleSSL(const SocketTLSOptions& tlsOptions, int fd = -1);
-        ~SocketAppleSSL();
-
-        virtual bool accept(std::string& errMsg) final;
-
-        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 recv(void* buffer, size_t length) final;
-
-    private:
-        static std::string getSSLErrorDescription(OSStatus status);
-        static OSStatus writeToSocket(SSLConnectionRef connection, const void* data, size_t* len);
-        static OSStatus readFromSocket(SSLConnectionRef connection, void* data, size_t* len);
-
-        OSStatus tlsHandShake(std::string& errMsg,
-                              const CancellationRequest& isCancellationRequested);
-
-        SSLContextRef _sslContext;
-        mutable std::mutex _mutex; // AppleSSL routines are not thread-safe
-
-        SocketTLSOptions _tlsOptions;
-    };
-
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_SECURE_TRANSPORT

ixwebsocket/IXSocketConnect.cpp

@@ -1,155 +0,0 @@
-/*
- *  IXSocketConnect.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXSocketConnect.h"
-
-#include "IXDNSLookup.h"
-#include "IXNetSystem.h"
-#include "IXSelectInterrupt.h"
-#include "IXSocket.h"
-#include "IXUniquePtr.h"
-#include <fcntl.h>
-#include <string.h>
-#include <sys/types.h>
-
-// Android needs extra headers for TCP_NODELAY and IPPROTO_TCP
-#ifdef ANDROID
-#include <linux/in.h>
-#include <linux/tcp.h>
-#endif
-
-namespace ix
-{
-    //
-    // This function can be cancelled every 50 ms
-    // This is important so that we don't block the main UI thread when shutting down a
-    // connection which is already trying to reconnect, and can be blocked waiting for
-    // ::connect to respond.
-    //
-    int SocketConnect::connectToAddress(const struct addrinfo* address,
-                                        std::string& errMsg,
-                                        const CancellationRequest& isCancellationRequested)
-    {
-        errMsg = "no error";
-
-        socket_t fd = socket(address->ai_family, address->ai_socktype, address->ai_protocol);
-        if (fd < 0)
-        {
-            errMsg = "Cannot create a socket";
-            return -1;
-        }
-
-        // Set the socket to non blocking mode, so that slow responses cannot
-        // block us for too long
-        SocketConnect::configure(fd);
-
-        int res = ::connect(fd, address->ai_addr, address->ai_addrlen);
-
-        if (res == -1 && !Socket::isWaitNeeded())
-        {
-            errMsg = strerror(Socket::getErrno());
-            Socket::closeSocket(fd);
-            return -1;
-        }
-
-        for (;;)
-        {
-            if (isCancellationRequested && isCancellationRequested()) // Must handle timeout as well
-            {
-                Socket::closeSocket(fd);
-                errMsg = "Cancelled";
-                return -1;
-            }
-
-            int timeoutMs = 10;
-            bool readyToRead = false;
-            auto selectInterrupt = ix::make_unique<SelectInterrupt>();
-            PollResultType pollResult = Socket::poll(readyToRead, timeoutMs, fd, selectInterrupt);
-
-            if (pollResult == PollResultType::Timeout)
-            {
-                continue;
-            }
-            else if (pollResult == PollResultType::Error)
-            {
-                Socket::closeSocket(fd);
-                errMsg = std::string("Connect error: ") + strerror(Socket::getErrno());
-                return -1;
-            }
-            else if (pollResult == PollResultType::ReadyForWrite)
-            {
-                return fd;
-            }
-            else
-            {
-                Socket::closeSocket(fd);
-                errMsg = std::string("Connect error: ") + strerror(Socket::getErrno());
-                return -1;
-            }
-        }
-
-        Socket::closeSocket(fd);
-        errMsg = "connect timed out after 60 seconds";
-        return -1;
-    }
-
-    int SocketConnect::connect(const std::string& hostname,
-                               int port,
-                               std::string& errMsg,
-                               const CancellationRequest& isCancellationRequested)
-    {
-        //
-        // First do DNS resolution
-        //
-        auto dnsLookup = std::make_shared<DNSLookup>(hostname, port);
-        struct addrinfo* res = dnsLookup->resolve(errMsg, isCancellationRequested);
-        if (res == nullptr)
-        {
-            return -1;
-        }
-
-        int sockfd = -1;
-
-        // iterate through the records to find a working peer
-        struct addrinfo* address;
-        for (address = res; address != nullptr; address = address->ai_next)
-        {
-            //
-            // Second try to connect to the remote host
-            //
-            sockfd = connectToAddress(address, errMsg, isCancellationRequested);
-            if (sockfd != -1)
-            {
-                break;
-            }
-        }
-
-        freeaddrinfo(res);
-        return sockfd;
-    }
-
-    // FIXME: configure is a terrible name
-    void SocketConnect::configure(int sockfd)
-    {
-        // 1. disable Nagle's algorithm
-        int flag = 1;
-        setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY, (char*) &flag, sizeof(flag));
-
-        // 2. make socket non blocking
-#ifdef _WIN32
-        unsigned long nonblocking = 1;
-        ioctlsocket(sockfd, FIONBIO, &nonblocking);
-#else
-        fcntl(sockfd, F_SETFL, O_NONBLOCK); // make socket non blocking
-#endif
-
-        // 3. (apple) prevent SIGPIPE from being emitted when the remote end disconnect
-#ifdef SO_NOSIGPIPE
-        int value = 1;
-        setsockopt(sockfd, SOL_SOCKET, SO_NOSIGPIPE, (void*) &value, sizeof(value));
-#endif
-    }
-} // namespace ix

ixwebsocket/IXSocketConnect.h

@@ -1,31 +0,0 @@
-/*
- *  IXSocketConnect.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXCancellationRequest.h"
-#include <string>
-
-struct addrinfo;
-
-namespace ix
-{
-    class SocketConnect
-    {
-    public:
-        static int connect(const std::string& hostname,
-                           int port,
-                           std::string& errMsg,
-                           const CancellationRequest& isCancellationRequested);
-
-        static void configure(int sockfd);
-
-    private:
-        static int connectToAddress(const struct addrinfo* address,
-                                    std::string& errMsg,
-                                    const CancellationRequest& isCancellationRequested);
-    };
-} // namespace ix

ixwebsocket/IXSocketFactory.cpp

@@ -1,64 +0,0 @@
-/*
- *  IXSocketFactory.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXSocketFactory.h"
-
-#include "IXUniquePtr.h"
-#ifdef IXWEBSOCKET_USE_TLS
-
-#ifdef IXWEBSOCKET_USE_MBED_TLS
-#include "IXSocketMbedTLS.h"
-#elif defined(IXWEBSOCKET_USE_OPEN_SSL)
-#include "IXSocketOpenSSL.h"
-#elif __APPLE__
-#include "IXSocketAppleSSL.h"
-#endif
-
-#else
-
-#include "IXSocket.h"
-
-#endif
-
-namespace ix
-{
-    std::unique_ptr<Socket> createSocket(bool tls,
-                                         int fd,
-                                         std::string& errorMsg,
-                                         const SocketTLSOptions& tlsOptions)
-    {
-        (void) tlsOptions;
-        errorMsg.clear();
-        std::unique_ptr<Socket> socket;
-
-        if (!tls)
-        {
-            socket = ix::make_unique<Socket>(fd);
-        }
-        else
-        {
-#ifdef IXWEBSOCKET_USE_TLS
-#if defined(IXWEBSOCKET_USE_MBED_TLS)
-            socket = ix::make_unique<SocketMbedTLS>(tlsOptions, fd);
-#elif defined(IXWEBSOCKET_USE_OPEN_SSL)
-            socket = ix::make_unique<SocketOpenSSL>(tlsOptions, fd);
-#elif defined(__APPLE__)
-            socket = ix::make_unique<SocketAppleSSL>(tlsOptions, fd);
-#endif
-#else
-            errorMsg = "TLS support is not enabled on this platform.";
-            return nullptr;
-#endif
-        }
-
-        if (!socket->init(errorMsg))
-        {
-            socket.reset();
-        }
-
-        return socket;
-    }
-} // namespace ix

ixwebsocket/IXSocketFactory.h

@@ -1,21 +0,0 @@
-
-/*
- *  IXSocketFactory.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include "IXSocketTLSOptions.h"
-#include <memory>
-#include <string>
-
-namespace ix
-{
-    class Socket;
-    std::unique_ptr<Socket> createSocket(bool tls,
-                                         int fd,
-                                         std::string& errorMsg,
-                                         const SocketTLSOptions& tlsOptions);
-} // namespace ix

ixwebsocket/IXSocketMbedTLS.cpp

@@ -1,352 +0,0 @@
-/*
- *  IXSocketMbedTLS.cpp
- *  Author: Benjamin Sergeant, Max Weisel
- *  Copyright (c) 2019-2020 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
- */
-#ifdef IXWEBSOCKET_USE_MBED_TLS
-
-#include "IXSocketMbedTLS.h"
-
-#include "IXNetSystem.h"
-#include "IXSocket.h"
-#include "IXSocketConnect.h"
-#include <string.h>
-
-namespace ix
-{
-    SocketMbedTLS::SocketMbedTLS(const SocketTLSOptions& tlsOptions, int fd)
-        : Socket(fd)
-        , _tlsOptions(tlsOptions)
-    {
-        initMBedTLS();
-    }
-
-    SocketMbedTLS::~SocketMbedTLS()
-    {
-        SocketMbedTLS::close();
-    }
-
-    void SocketMbedTLS::initMBedTLS()
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        mbedtls_ssl_init(&_ssl);
-        mbedtls_ssl_config_init(&_conf);
-        mbedtls_ctr_drbg_init(&_ctr_drbg);
-        mbedtls_entropy_init(&_entropy);
-        mbedtls_x509_crt_init(&_cacert);
-        mbedtls_x509_crt_init(&_cert);
-        mbedtls_pk_init(&_pkey);
-    }
-
-    bool SocketMbedTLS::loadSystemCertificates(std::string& errorMsg)
-    {
-#ifdef _WIN32
-        DWORD flags = CERT_STORE_READONLY_FLAG | CERT_STORE_OPEN_EXISTING_FLAG |
-                      CERT_SYSTEM_STORE_CURRENT_USER;
-        HCERTSTORE systemStore = CertOpenStore(CERT_STORE_PROV_SYSTEM, 0, 0, flags, L"Root");
-
-        if (!systemStore)
-        {
-            errorMsg = "CertOpenStore failed with ";
-            errorMsg += std::to_string(GetLastError());
-            return false;
-        }
-
-        PCCERT_CONTEXT certificateIterator = NULL;
-
-        int certificateCount = 0;
-        while (certificateIterator = CertEnumCertificatesInStore(systemStore, certificateIterator))
-        {
-            if (certificateIterator->dwCertEncodingType & X509_ASN_ENCODING)
-            {
-                int ret = mbedtls_x509_crt_parse(&_cacert,
-                                                 certificateIterator->pbCertEncoded,
-                                                 certificateIterator->cbCertEncoded);
-                if (ret == 0)
-                {
-                    ++certificateCount;
-                }
-            }
-        }
-
-        CertFreeCertificateContext(certificateIterator);
-        CertCloseStore(systemStore, 0);
-
-        if (certificateCount == 0)
-        {
-            errorMsg = "No certificates found";
-            return false;
-        }
-
-        return true;
-#else
-        // On macOS we can query the system cert location from the keychain
-        // On Linux we could try to fetch some local files based on the distribution
-        // On Android we could use JNI to get to the system certs
-        return false;
-#endif
-    }
-
-    bool SocketMbedTLS::init(const std::string& host, bool isClient, std::string& errMsg)
-    {
-        initMBedTLS();
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        const char* pers = "IXSocketMbedTLS";
-
-        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,
-                                        (isClient) ? MBEDTLS_SSL_IS_CLIENT : MBEDTLS_SSL_IS_SERVER,
-                                        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);
-
-        if (_tlsOptions.hasCertAndKey())
-        {
-            if (mbedtls_x509_crt_parse_file(&_cert, _tlsOptions.certFile.c_str()) < 0)
-            {
-                errMsg = "Cannot parse cert file '" + _tlsOptions.certFile + "'";
-                return false;
-            }
-            if (mbedtls_pk_parse_keyfile(&_pkey, _tlsOptions.keyFile.c_str(), "") < 0)
-            {
-                errMsg = "Cannot parse key file '" + _tlsOptions.keyFile + "'";
-                return false;
-            }
-            if (mbedtls_ssl_conf_own_cert(&_conf, &_cert, &_pkey) < 0)
-            {
-                errMsg = "Problem configuring cert '" + _tlsOptions.certFile + "'";
-                return false;
-            }
-        }
-
-        if (_tlsOptions.isPeerVerifyDisabled())
-        {
-            mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_NONE);
-        }
-        else
-        {
-            // FIXME: should we call mbedtls_ssl_conf_verify ?
-            mbedtls_ssl_conf_authmode(&_conf, MBEDTLS_SSL_VERIFY_REQUIRED);
-
-            if (_tlsOptions.isUsingSystemDefaults())
-            {
-                if (!loadSystemCertificates(errMsg))
-                {
-                    return false;
-                }
-            }
-            else
-            {
-                if (_tlsOptions.isUsingInMemoryCAs())
-                {
-                    const char* buffer = _tlsOptions.caFile.c_str();
-                    size_t bufferSize =
-                        _tlsOptions.caFile.size() + 1; // Needs to include null terminating
-                                                       // character otherwise mbedtls will fail.
-                    if (mbedtls_x509_crt_parse(
-                            &_cacert, (const unsigned char*) buffer, bufferSize) < 0)
-                    {
-                        errMsg = "Cannot parse CA from memory.";
-                        return false;
-                    }
-                }
-                else if (mbedtls_x509_crt_parse_file(&_cacert, _tlsOptions.caFile.c_str()) < 0)
-                {
-                    errMsg = "Cannot parse CA file '" + _tlsOptions.caFile + "'";
-                    return false;
-                }
-            }
-
-            mbedtls_ssl_conf_ca_chain(&_conf, &_cacert, NULL);
-        }
-
-        if (mbedtls_ssl_setup(&_ssl, &_conf) != 0)
-        {
-            errMsg = "SSL setup failed";
-            return false;
-        }
-
-        if (!host.empty() && mbedtls_ssl_set_hostname(&_ssl, host.c_str()) != 0)
-        {
-            errMsg = "SNI setup failed";
-            return false;
-        }
-
-        return true;
-    }
-
-    bool SocketMbedTLS::accept(std::string& errMsg)
-    {
-        bool isClient = false;
-        bool initialized = init(std::string(), isClient, errMsg);
-        if (!initialized)
-        {
-            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;
-
-            if (res == MBEDTLS_ERR_X509_CERT_VERIFY_FAILED)
-            {
-                char verifyBuf[512];
-                uint32_t flags = mbedtls_ssl_get_verify_result(&_ssl);
-
-                mbedtls_x509_crt_verify_info(verifyBuf, sizeof(verifyBuf), "  ! ", flags);
-                errMsg += " : ";
-                errMsg += verifyBuf;
-            }
-
-            close();
-            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;
-        }
-
-        bool isClient = true;
-        bool initialized = init(host, isClient, errMsg);
-        if (!initialized)
-        {
-            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);
-            }
-
-            if (isCancellationRequested())
-            {
-                errMsg = "Cancellation requested";
-                close();
-                return false;
-            }
-        } 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);
-        mbedtls_x509_crt_free(&_cacert);
-        mbedtls_x509_crt_free(&_cert);
-
-        Socket::close();
-    }
-
-    ssize_t SocketMbedTLS::send(char* buf, size_t nbyte)
-    {
-        std::lock_guard<std::mutex> lock(_mutex);
-
-        ssize_t res = mbedtls_ssl_write(&_ssl, (unsigned char*) buf, nbyte);
-
-        if (res > 0)
-        {
-            return res;
-        }
-        else if (res == MBEDTLS_ERR_SSL_WANT_READ || res == MBEDTLS_ERR_SSL_WANT_WRITE)
-        {
-            errno = EWOULDBLOCK;
-            return -1;
-        }
-        else
-        {
-            return -1;
-        }
-    }
-
-    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;
-        }
-    }
-
-} // namespace ix
-
-#endif // IXWEBSOCKET_USE_MBED_TLS