Merge branch 'master' into feature/http

Feature/send large message (#14 )
* introduce send fragment * can pass a fin frame * can send messages which are a perfect multiple of the chunk size * set fin only for last fragment * cleanup * last fragment should be of type CONTINUATION * Add simple send and receive programs * speedups receiving + better way to wait for thing * receive speedup by using linked list of chunks instead of large array * document bug * use chunks to receive data * trailing spaces
2019-02-28 21:53:52 -08:00 · 2019-02-28 21:46:58 -08:00 · 2019-02-28 21:43:09 -08:00 · 2019-02-28 21:18:27 -08:00 · 2019-02-27 18:02:45 -08:00 · 2019-02-27 16:41:48 -08:00
212 changed files with 79543 additions and 11807 deletions
@@ -0,0 +1 @@
 build
@@ -0,0 +1 @@
 build
@@ -0,0 +1,17 @@
 language: cpp
 dist: xenial
 compiler:
  - gcc
  - clang
 os:
  - linux
  - osx
 matrix:
  exclude:
    # GCC fails on recent Travis OSX images.
    - compiler: gcc
      os: osx
 script: python test/run.py
@@ -1,159 +0,0 @@
 <!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>
@@ -0,0 +1,125 @@
 #
 # Author: Benjamin Sergeant
 # Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 #
 cmake_minimum_required(VERSION 3.4.1)
 project(ixwebsocket C CXX)
 set (CMAKE_CXX_STANDARD 14)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 # -Wshorten-64-to-32 does not work with clang
 if (NOT WIN32)
  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 set( IXWEBSOCKET_SOURCES
    ixwebsocket/IXEventFd.cpp
    ixwebsocket/IXSocket.cpp
    ixwebsocket/IXSocketServer.cpp
    ixwebsocket/IXSocketConnect.cpp
    ixwebsocket/IXSocketFactory.cpp
    ixwebsocket/IXDNSLookup.cpp
    ixwebsocket/IXCancellationRequest.cpp
    ixwebsocket/IXWebSocket.cpp
    ixwebsocket/IXWebSocketServer.cpp
    ixwebsocket/IXWebSocketTransport.cpp
    ixwebsocket/IXWebSocketHandshake.cpp
    ixwebsocket/IXWebSocketPerMessageDeflate.cpp
    ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
    ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
    ixwebsocket/IXWebSocketHttpHeaders.cpp
    ixwebsocket/IXHttpClient.cpp
    ixwebsocket/IXUrlParser.cpp
 )
 set( IXWEBSOCKET_HEADERS
    ixwebsocket/IXEventFd.h
    ixwebsocket/IXSocket.h
    ixwebsocket/IXSocketServer.h
    ixwebsocket/IXSocketConnect.h
    ixwebsocket/IXSocketFactory.h
    ixwebsocket/IXSetThreadName.h
    ixwebsocket/IXDNSLookup.h
    ixwebsocket/IXCancellationRequest.h
    ixwebsocket/IXProgressCallback.h
    ixwebsocket/IXWebSocket.h
    ixwebsocket/IXWebSocketServer.h
    ixwebsocket/IXWebSocketTransport.h
    ixwebsocket/IXWebSocketHandshake.h
    ixwebsocket/IXWebSocketSendInfo.h
    ixwebsocket/IXWebSocketErrorInfo.h
    ixwebsocket/IXWebSocketPerMessageDeflate.h
    ixwebsocket/IXWebSocketPerMessageDeflateCodec.h
    ixwebsocket/IXWebSocketPerMessageDeflateOptions.h
    ixwebsocket/IXWebSocketHttpHeaders.h
    ixwebsocket/libwshandshake.hpp
    ixwebsocket/IXHttpClient.h
    ixwebsocket/IXUrlParser.h
 )
 # Platform specific code
 if (APPLE)
    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/apple/IXSetThreadName_apple.cpp)
 elseif (WIN32)
    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
 else()
    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/linux/IXSetThreadName_linux.cpp)
 endif()
 if (USE_TLS)
    add_definitions(-DIXWEBSOCKET_USE_TLS)
    if (APPLE)
        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.cpp)
    elseif (WIN32)
        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketSChannel.h)
        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketSChannel.cpp)
    else()
        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketOpenSSL.h)
        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketOpenSSL.cpp)
    endif()
 endif()
 add_library( ixwebsocket STATIC
    ${IXWEBSOCKET_SOURCES}
    ${IXWEBSOCKET_HEADERS}
 )
 # gcc/Linux needs -pthread
 find_package(Threads)
 if(UNIX AND NOT APPLE)
  find_package(OpenSSL REQUIRED)
  add_definitions(${OPENSSL_DEFINITIONS})
  message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
  include_directories(${OPENSSL_INCLUDE_DIR})
 endif()
 if (WIN32)
  get_filename_component(libz_path
    ${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/release_dynamic/x64/lib/zlib.lib
    ABSOLUTE)
  add_library(libz STATIC IMPORTED)
  set_target_properties(libz PROPERTIES IMPORTED_LOCATION
    ${libz_path})
  include_directories(${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/include)
  target_link_libraries(ixwebsocket libz wsock32 ws2_32)
  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
 else()
  target_link_libraries(ixwebsocket 
    z ${OPENSSL_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
 endif()
 set( IXWEBSOCKET_INCLUDE_DIRS
    .
    ../../shared/OpenSSL/include)
 target_include_directories( ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS} )
 add_subdirectory(ws)
@@ -0,0 +1 @@
 docker/Dockerfile.debian
@@ -0,0 +1,29 @@
 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.
@@ -0,0 +1,378 @@
 # General
 ![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
 ## Introduction
 [*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex
 communication channels over a single TCP connection. *IXWebSocket* is a C++ library for client and server Websocket communication, and for client HTTP communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient) and from the [Satori C SDK](https://github.com/satori-com/satori-rtm-sdk-c). It has been tested on the following platforms.
 * macOS
 * iOS
 * Linux
 * Android 
 * Windows (no TLS support yet)
 ## 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.
 Here is what the client API looks like.
 ```
 ix::WebSocket webSocket;
 std::string url("ws://localhost:8080/");
 webSocket.setUrl(url);
 // Optional heart beat, sent every 45 seconds when there is not any traffic
 // to make sure that load balancers do not kill an idle connection.
 webSocket.setHeartBeatPeriod(45);
 // Setup a callback to be fired when a message or an event (open, close, error) is received
 webSocket.setOnMessageCallback(
    [](ix::WebSocketMessageType messageType,
       const std::string& str,
       size_t wireSize,
       const ix::WebSocketErrorInfo& error,
       const ix::WebSocketCloseInfo& closeInfo,
       const ix::WebSocketHttpHeaders& headers)
    {
        if (messageType == ix::WebSocket_MessageType_Message)
        {
            std::cout << str << std::endl;
        }
 });
 // Now that our callback is setup, we can start our background thread and receive messages
 webSocket.start();
 // Send a message to the server
 webSocket.send("hello world");
 // ... finally ...
 // Stop the connection
 webSocket.stop()
 ```
 Here is what the server API looks like. Note that server support is very recent and subject to changes.
 ```
 // Run a server on localhost at a given port.
 // Bound host name, max connections and listen backlog can also be passed in as parameters.
 ix::WebSocketServer server(port);
 server.setOnConnectionCallback(
    [&server](std::shared_ptr<ix::WebSocket> webSocket)
    {
        webSocket->setOnMessageCallback(
            [webSocket, &server](ix::WebSocketMessageType messageType,
               const std::string& str,
               size_t wireSize,
               const ix::WebSocketErrorInfo& error,
               const ix::WebSocketOpenInfo& openInfo,
               const ix::WebSocketCloseInfo& closeInfo)
            {
                if (messageType == ix::WebSocket_MessageType_Open)
                {
                    std::cerr << "New connection" << std::endl;
                    std::cerr << "Uri: " << openInfo.uri << std::endl;
                    std::cerr << "Headers:" << std::endl;
                    for (auto it : openInfo.headers)
                    {
                        std::cerr << it.first << ": " << it.second << std::endl;
                    }
                }
                else if (messageType == ix::WebSocket_MessageType_Message)
                {
                    // For an echo server, we just send back to the client whatever was received by the server
                    // All connected clients are available in an std::set. See the broadcast cpp example.
                    webSocket->send(str);
                }
            }
        );
    }
 );
 auto res = server.listen();
 if (!res.first)
 {
    // Error handling
    return 1;
 }
 // Run the server in the background. Server can be stoped by calling server.stop()
 server.start();
 // Block until server.stop() is called.
 server.wait();
 ```
 Here is what the HTTP client API looks like. Note that HTTP client support is very recent and subject to changes.
 ```
 //
 // Preparation
 //
 HttpClient httpClient;
 HttpRequestArgs args;
 // Custom headers can be set
 WebSocketHttpHeaders headers;
 headers["Foo"] = "bar";
 args.extraHeaders = parseHeaders(headersData);
 // Timeout options
 args.connectTimeout = connectTimeout;
 args.transferTimeout = transferTimeout;
 // Redirect options
 args.followRedirects = followRedirects;
 args.maxRedirects = maxRedirects;
 // Misc
 args.compress = compress; // Enable gzip compression
 args.verbose = verbose;
 args.logger = [](const std::string& msg)
 {
    std::cout << msg;
 };
 //
 // Request
 //
 HttpResponse out;
 std::string url = "https://www.google.com";
 // HEAD request
 out = httpClient.head(url, args);
 // GET request
 out = httpClient.get(url, args);
 // POST request with parameters
 HttpParameters httpParameters;
 httpParameters["foo"] = "bar";
 out = httpClient.post(url, httpParameters, args);
 // POST request with a body
 out = httpClient.post(url, std::string("foo=bar"), args);
 //
 // Result
 //
 auto statusCode = std::get<0>(out);
 auto errorCode = std::get<1>(out);
 auto responseHeaders = std::get<2>(out);
 auto payload = std::get<3>(out);
 auto errorMsg = std::get<4>(out);
 auto uploadSize = std::get<5>(out);
 auto downloadSize = std::get<6>(out);
 ```
 ## Build
 CMakefiles for the library and the examples are available. This library has few dependencies, so it is possible to just add the source files into your project.
 There is a Dockerfile for running some code on Linux, and a unittest which can be executed by typing `make test`.
 ## Implementation details
 ### Per Message Deflate compression.
 The per message deflate compression option is supported. It can lead to very nice bandbwith savings (20x !) if your messages are similar, which is often the case for example for chat applications. All features of the spec should be supported.
 ### TLS/SSL
 Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, and OpenSSL is used on Android and Linux.
 ### Polling and background thread work
 No manual polling to fetch data is required. Data is sent and received instantly by using a background thread for receiving data and the select [system](http://man7.org/linux/man-pages/man2/select.2.html) call to be notified by the OS of incoming data. No timeout is used for select so that the background thread is only woken up when data is available, to optimize battery life. This is also the recommended way of using select according to the select tutorial, section [select law](https://linux.die.net/man/2/select_tut). Read and Writes to the socket are non blocking. Data is sent right away and not enqueued by writing directly to the socket, which is [possible](https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid) since system socket implementations allow concurrent read/writes. However concurrent writes need to be protected with mutex.
 ### Automatic reconnection
 If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds.
 ### Large messages
 Large frames are broken up into smaller chunks or messages to avoid filling up the os tcp buffers, which is permitted thanks to WebSocket [fragmentation](https://tools.ietf.org/html/rfc6455#section-5.4). Messages up to 500M were sent and received succesfully.
 ## Limitations
 * There is no text support for sending data, only the binary protocol is supported. Sending json or text over the binary protocol works well.
 * Automatic reconnection works at the TCP socket level, and will detect remote end disconnects. However, if the device/computer network become unreachable (by turning off wifi), it is quite hard to reliably and timely detect it at the socket level using `recv` and `send` error codes. [Here](https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program) is a good discussion on the subject. This behavior is consistent with other runtimes such as node.js. One way to detect a disconnected device with low level C code is to do a name resolution with DNS but this can be expensive. Mobile devices have good and reliable API to do that.
 * The server code is using select to detect incoming data, and creates one OS thread per connection. This is not as scalable as strategies using epoll or kqueue.
 ## C++ code organization
 Here is a simplistic diagram which explains how the code is structured in term of class/modules.
 ```
 +-----------------------+ --- Public
 |                       | Start the receiving Background thread. Auto reconnection. Simple websocket Ping.
 |  IXWebSocket          | Interface used by C++ test clients. No IX dependencies.
 |                       | 
 +-----------------------+
 |                       |
 |  IXWebSocketServer    | Run a server and give each connections its own WebSocket object.
 |                       | Each connection is handled in a new OS thread.
 |                       |
 +-----------------------+ --- Private 
 |                       |
 |  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
 |                       |
 +-----------------------+
 |                       |
 |  IXWebSocketHandshake | Establish the connection between client and server.
 |                       |
 +-----------------------+
 |                       |
 |  IXWebSocket          | ws://  Unencrypted Socket handler
 |  IXWebSocketAppleSSL  | wss:// TLS encrypted Socket AppleSSL handler. Used on iOS and macOS
 |  IXWebSocketOpenSSL   | wss:// TLS encrypted Socket OpenSSL handler.  Used on Android and Linux
 |                       |                                               Can be used on macOS too.
 +-----------------------+
 |                       |
 |  IXSocketConnect      | Connect to the remote host (client).
 |                       |
 +-----------------------+
 |                       |
 |  IXDNSLookup          | Does DNS resolution asynchronously so that it can be interrupted.
 |                       |
 +-----------------------+
 ```
 ## API
 ### Sending messages
 `websocket.send("foo")` will send a message.
 If the connection was closed and sending failed, the return value will be set to false.
 ### ReadyState
 `getReadyState()` returns the state of the connection. There are 4 possible states.
 1. WebSocket_ReadyState_Connecting - The connection is not yet open.
 2. WebSocket_ReadyState_Open       - The connection is open and ready to communicate.
 3. WebSocket_ReadyState_Closing    - The connection is in the process of closing.
 4. WebSocket_MessageType_Close     - The connection is closed or could not be opened.
 ### Open and Close notifications
 The onMessage event will be fired when the connection is opened or closed. This is similar to the [Javascript browser API](https://developer.mozilla.org/en-US/docs/Web/API/WebSocket), which has `open` and `close` events notification that can be registered with the browser `addEventListener`.
 ```
 webSocket.setOnMessageCallback(
    [](ix::WebSocketMessageType messageType,
       const std::string& str,
       size_t wireSize,
       const ix::WebSocketErrorInfo& error,
       const ix::WebSocketCloseInfo& closeInfo,
       const ix::WebSocketHttpHeaders& headers)
    {
        if (messageType == ix::WebSocket_MessageType_Open)
        {
            std::cout << "send greetings" << std::endl;
            // Headers can be inspected (pairs of string/string)
            std::cout << "Handshake Headers:" << std::endl;
            for (auto it : headers)
            {
                std::cout << it.first << ": " << it.second << std::endl;
            }
        }
        else if (messageType == ix::WebSocket_MessageType_Close)
        {
            std::cout << "disconnected" << std::endl;
            // The server can send an explicit code and reason for closing.
            // This data can be accessed through the closeInfo object.
            std::cout << closeInfo.code << std::endl;
            std::cout << closeInfo.reason << std::endl;
        }
    }
 );
 ```
 ### Error notification
 A message will be fired when there is an error with the connection. The message type will be `ix::WebSocket_MessageType_Error`. Multiple fields will be available on the event to describe the error.
 ```
 webSocket.setOnMessageCallback(
    [](ix::WebSocketMessageType messageType,
       const std::string& str,
       size_t wireSize,
       const ix::WebSocketErrorInfo& error,
       const ix::WebSocketCloseInfo& closeInfo,
       const ix::WebSocketHttpHeaders& headers)
    {
        if (messageType == ix::WebSocket_MessageType_Error)
        {
            std::stringstream ss;
            ss << "Error: "         << error.reason      << std::endl;
            ss << "#retries: "      << event.retries     << std::endl;
            ss << "Wait time(ms): " << event.wait_time   << std::endl;
            ss << "HTTP Status: "   << event.http_status << std::endl;
            std::cout << ss.str() << std::endl;
        }
    }
 );
 ```
 ### start, stop
 1. `websocket.start()` connect to the remote server and starts the message receiving background thread.
 2. `websocket.stop()` disconnect from the remote server and closes the background thread.
 ### Configuring the remote url
 The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
 ```
 std::string url("wss://example.com");
 websocket.configure(url);
 ```
 ### Ping/Pong support
 Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
 ```
 webSocket.setOnMessageCallback(
    [](ix::WebSocketMessageType messageType,
       const std::string& str,
       size_t wireSize,
       const ix::WebSocketErrorInfo& error,
       const ix::WebSocketCloseInfo& closeInfo,
       const ix::WebSocketHttpHeaders& headers)
    {
        if (messageType == ix::WebSocket_MessageType_Ping ||
            messageType == ix::WebSocket_MessageType_Pong)
        {
            std::cout << "pong data: " << str << std::endl;
        }
    }
 );
 ```
 A ping message can be sent to the server, with an optional data string.
 ```
 websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
 ```
 ### Heartbeat.
 You can configure an optional heart beat / keep-alive, sent every 45 seconds
 when there is not any traffic to make sure that load balancers do not kill an
 idle connection.
 ```
 webSocket.setHeartBeatPeriod(45);
 ```
@@ -0,0 +1,10 @@
 image:
 - Visual Studio 2017
 - Ubuntu
 install:
 - ls -al
 - cmd: call "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
 - python test/run.py
 build: off
@@ -1,248 +0,0 @@
 <!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>
@@ -1,325 +0,0 @@
 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; }
 }
@@ -1,247 +0,0 @@
 <!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>
@@ -0,0 +1,16 @@
 FROM debian:stretch
 # RUN yum install -y gcc-c++ make cmake openssl-devel gdb
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get update 
 RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install gdb
 RUN apt-get -y install screen
 RUN apt-get -y install procps
 RUN apt-get -y install lsof
 COPY . .
 WORKDIR examples/ws_connect
 RUN ["sh", "build_linux.sh"]
@@ -0,0 +1,11 @@
 FROM alpine:3.8
 RUN apk add --no-cache g++ musl-dev make cmake openssl-dev
 COPY . .
 WORKDIR examples/ws_connect
 RUN ["sh", "build_linux.sh"]
 EXPOSE 8765
 CMD ["ws_connect"]
@@ -0,0 +1,11 @@
 FROM alpine:3.8
 RUN apk add --no-cache g++ musl-dev make cmake openssl-dev
 COPY . .
 WORKDIR examples/ws_connect
 RUN ["sh", "build_linux.sh"]
 EXPOSE 8765
 CMD ["ws_connect"]
@@ -0,0 +1,22 @@
 FROM debian:stretch
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get update 
 RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
 RUN apt-get -y install gdb
 RUN apt-get -y install screen
 RUN apt-get -y install procps
 RUN apt-get -y install lsof
 RUN apt-get -y install libz-dev
 RUN apt-get -y install vim
 RUN apt-get -y install make
 RUN apt-get -y install cmake
 COPY . .
 WORKDIR ws
 RUN ["sh", "docker_build.sh"]
 EXPOSE 8765
 CMD ["/ws/ws", "transfer", "8765"]
@@ -0,0 +1,8 @@
 FROM gcc:8
 # RUN yum install -y gcc-c++ make cmake openssl-devel gdb
 COPY . .
 WORKDIR examples/ws_connect
 RUN ["sh", "build_linux.sh"]
@@ -0,0 +1,22 @@
 /*
 *  IXHash.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone. All rights reserved.
 */
 #include <string>
 namespace ix
 {
    uint64_t djb2Hash(const std::string& data)
    {
        uint64_t hashAddress = 5381;
        for (auto& c : data)
        {
            hashAddress = ((hashAddress << 5) + hashAddress) + c;
        }
        return hashAddress;
    }
 }
@@ -0,0 +1,15 @@
 /*
 *  IXHash.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone. All rights reserved.
 */
 #pragma once
 #include <string>
 namespace ix
 {
    uint64_t djb2Hash(const std::string& data);
 }
@@ -0,0 +1,75 @@
 /*
 *  IXUuid.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone. All rights reserved.
 */
 /**
 * Generate a random uuid similar to the uuid python module
 *
 * >>> import uuid
 * >>> uuid.uuid4().hex
 * 'bec08155b37d4050a1f3c3fa0276bf12'
 *
 * Code adapted from https://github.com/r-lyeh-archived/sole
 */
 #include "IXUuid.h"
 #include <sstream>
 #include <string>
 #include <iomanip>
 #include <random>
 namespace ix
 {
    class Uuid
    {
        public:
            Uuid();
            std::string toString() const;
        private:
            uint64_t _ab;
            uint64_t _cd;
    };
    Uuid::Uuid()
    {
        static std::random_device rd;
        static std::uniform_int_distribution<uint64_t> dist(0, (uint64_t)(~0));
        _ab = dist(rd);
        _cd = dist(rd);
        _ab = (_ab & 0xFFFFFFFFFFFF0FFFULL) | 0x0000000000004000ULL;
        _cd = (_cd & 0x3FFFFFFFFFFFFFFFULL) | 0x8000000000000000ULL;
    }
    std::string Uuid::toString() const
    {
        std::stringstream ss;
        ss << std::hex << std::nouppercase << std::setfill('0');
        uint32_t a = (_ab >> 32);
        uint32_t b = (_ab & 0xFFFFFFFF);
        uint32_t c = (_cd >> 32);
        uint32_t d = (_cd & 0xFFFFFFFF);
        ss << std::setw(8) << (a);
        ss << std::setw(4) << (b >> 16);
        ss << std::setw(4) << (b & 0xFFFF);
        ss << std::setw(4) << (c >> 16 );
        ss << std::setw(4) << (c & 0xFFFF);
        ss << std::setw(8) << d;
        return ss.str();
    }
    std::string uuid4()
    {
        Uuid id;
        return id.toString();
    }
 }
@@ -0,0 +1,17 @@
 /*
 *  IXUuid.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017 Machine Zone. All rights reserved.
 */
 #pragma once
 #include <string>
 namespace ix
 {
   /**
    * Generate a random uuid
    */
   std::string uuid4();
 }
@@ -0,0 +1 @@
 build
@@ -0,0 +1,30 @@
 #
 # Author: Benjamin Sergeant
 # Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 #
 cmake_minimum_required (VERSION 3.4.1)
 project (ws_receive)
 # There's -Weverything too for clang
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
 set (CMAKE_CXX_STANDARD 14)
 option(USE_TLS "Add TLS support" ON)
 add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
 include_directories(ws_receive .)
 add_executable(ws_receive 
  jsoncpp/jsoncpp.cpp
  ixcrypto/IXBase64.cpp
  ixcrypto/IXHash.cpp
  ws_receive.cpp)
 if (APPLE AND USE_TLS)
    target_link_libraries(ws_receive "-framework foundation" "-framework security")
 endif()
 target_link_libraries(ws_receive ixwebsocket)
@@ -0,0 +1 @@
 ws_receive is a simple server upload program. It needs to be used in conjonction with ws_send.
@@ -0,0 +1 @@
 ../cobra_publisher/ixcrypto
@@ -0,0 +1,333 @@
 /// Json-cpp amalgated forward header (http://jsoncpp.sourceforge.net/).
 /// It is intended to be used with #include "json/json-forwards.h"
 /// This header provides forward declaration for all JsonCpp types.
 // //////////////////////////////////////////////////////////////////////
 // Beginning of content of file: LICENSE
 // //////////////////////////////////////////////////////////////////////
 /*
 The JsonCpp library's source code, including accompanying documentation,
 tests and demonstration applications, are licensed under the following
 conditions...
 Baptiste Lepilleur and The JsonCpp Authors explicitly disclaim copyright in all
 jurisdictions which recognize such a disclaimer. In such jurisdictions,
 this software is released into the Public Domain.
 In jurisdictions which do not recognize Public Domain property (e.g. Germany as of
 2010), this software is Copyright (c) 2007-2010 by Baptiste Lepilleur and
 The JsonCpp Authors, and is released under the terms of the MIT License (see below).
 In jurisdictions which recognize Public Domain property, the user of this
 software may choose to accept it either as 1) Public Domain, 2) under the
 conditions of the MIT License (see below), or 3) under the terms of dual
 Public Domain/MIT License conditions described here, as they choose.
 The MIT License is about as close to Public Domain as a license can get, and is
 described in clear, concise terms at:
   http://en.wikipedia.org/wiki/MIT_License
 The full text of the MIT License follows:
 ========================================================================
 Copyright (c) 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use, copy,
 modify, merge, publish, distribute, sublicense, and/or sell copies
 of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 ========================================================================
 (END LICENSE TEXT)
 The MIT license is compatible with both the GPL and commercial
 software, affording one all of the rights of Public Domain with the
 minor nuisance of being required to keep the above copyright notice
 and license text in the source code. Note also that by accepting the
 Public Domain "license" you can re-license your copy using whatever
 license you like.
 */
 // //////////////////////////////////////////////////////////////////////
 // End of content of file: LICENSE
 // //////////////////////////////////////////////////////////////////////
 #ifndef JSON_FORWARD_AMALGATED_H_INCLUDED
 # define JSON_FORWARD_AMALGATED_H_INCLUDED
 /// If defined, indicates that the source file is amalgated
 /// to prevent private header inclusion.
 #define JSON_IS_AMALGAMATION
 // //////////////////////////////////////////////////////////////////////
 // Beginning of content of file: include/json/config.h
 // //////////////////////////////////////////////////////////////////////
 // Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 // Distributed under MIT license, or public domain if desired and
 // recognized in your jurisdiction.
 // See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE
 #ifndef JSON_CONFIG_H_INCLUDED
 #define JSON_CONFIG_H_INCLUDED
 #include <stddef.h>
 #include <string> //typedef String
 #include <stdint.h> //typedef int64_t, uint64_t
 /// If defined, indicates that json library is embedded in CppTL library.
 //# define JSON_IN_CPPTL 1
 /// If defined, indicates that json may leverage CppTL library
 //#  define JSON_USE_CPPTL 1
 /// If defined, indicates that cpptl vector based map should be used instead of
 /// std::map
 /// as Value container.
 //#  define JSON_USE_CPPTL_SMALLMAP 1
 // If non-zero, the library uses exceptions to report bad input instead of C
 // assertion macros. The default is to use exceptions.
 #ifndef JSON_USE_EXCEPTION
 #define JSON_USE_EXCEPTION 1
 #endif
 /// If defined, indicates that the source file is amalgated
 /// to prevent private header inclusion.
 /// Remarks: it is automatically defined in the generated amalgated header.
 // #define JSON_IS_AMALGAMATION
 #ifdef JSON_IN_CPPTL
 #include <cpptl/config.h>
 #ifndef JSON_USE_CPPTL
 #define JSON_USE_CPPTL 1
 #endif
 #endif
 #ifdef JSON_IN_CPPTL
 #define JSON_API CPPTL_API
 #elif defined(JSON_DLL_BUILD)
 #if defined(_MSC_VER) || defined(__MINGW32__)
 #define JSON_API __declspec(dllexport)
 #define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
 #endif // if defined(_MSC_VER)
 #elif defined(JSON_DLL)
 #if defined(_MSC_VER) || defined(__MINGW32__)
 #define JSON_API __declspec(dllimport)
 #define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
 #endif // if defined(_MSC_VER)
 #endif // ifdef JSON_IN_CPPTL
 #if !defined(JSON_API)
 #define JSON_API
 #endif
 // If JSON_NO_INT64 is defined, then Json only support C++ "int" type for
 // integer
 // Storages, and 64 bits integer support is disabled.
 // #define JSON_NO_INT64 1
 #if defined(_MSC_VER) // MSVC
 #  if _MSC_VER <= 1200 // MSVC 6
    // Microsoft Visual Studio 6 only support conversion from __int64 to double
    // (no conversion from unsigned __int64).
 #    define JSON_USE_INT64_DOUBLE_CONVERSION 1
    // Disable warning 4786 for VS6 caused by STL (identifier was truncated to '255'
    // characters in the debug information)
    // All projects I've ever seen with VS6 were using this globally (not bothering
    // with pragma push/pop).
 #    pragma warning(disable : 4786)
 #  endif // MSVC 6
 #  if _MSC_VER >= 1500 // MSVC 2008
    /// Indicates that the following function is deprecated.
 #    define JSONCPP_DEPRECATED(message) __declspec(deprecated(message))
 #  endif
 #endif // defined(_MSC_VER)
 // In c++11 the override keyword allows you to explicity define that a function
 // is intended to override the base-class version.  This makes the code more
 // managable and fixes a set of common hard-to-find bugs.
 #if __cplusplus >= 201103L
 # define JSONCPP_OVERRIDE override
 # define JSONCPP_NOEXCEPT noexcept
 #elif defined(_MSC_VER) && _MSC_VER > 1600 && _MSC_VER < 1900
 # define JSONCPP_OVERRIDE override
 # define JSONCPP_NOEXCEPT throw()
 #elif defined(_MSC_VER) && _MSC_VER >= 1900
 # define JSONCPP_OVERRIDE override
 # define JSONCPP_NOEXCEPT noexcept
 #else
 # define JSONCPP_OVERRIDE
 # define JSONCPP_NOEXCEPT throw()
 #endif
 #ifndef JSON_HAS_RVALUE_REFERENCES
 #if defined(_MSC_VER) && _MSC_VER >= 1600 // MSVC >= 2010
 #define JSON_HAS_RVALUE_REFERENCES 1
 #endif // MSVC >= 2010
 #ifdef __clang__
 #if __has_feature(cxx_rvalue_references)
 #define JSON_HAS_RVALUE_REFERENCES 1
 #endif  // has_feature
 #elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
 #if defined(__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
 #define JSON_HAS_RVALUE_REFERENCES 1
 #endif  // GXX_EXPERIMENTAL
 #endif // __clang__ || __GNUC__
 #endif // not defined JSON_HAS_RVALUE_REFERENCES
 #ifndef JSON_HAS_RVALUE_REFERENCES
 #define JSON_HAS_RVALUE_REFERENCES 0
 #endif
 #ifdef __clang__
 #  if __has_extension(attribute_deprecated_with_message)
 #    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
 #  endif
 #elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
 #  if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
 #    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
 #  elif (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
 #    define JSONCPP_DEPRECATED(message)  __attribute__((__deprecated__))
 #  endif  // GNUC version
 #endif // __clang__ || __GNUC__
 #if !defined(JSONCPP_DEPRECATED)
 #define JSONCPP_DEPRECATED(message)
 #endif // if !defined(JSONCPP_DEPRECATED)
 #if __GNUC__ >= 6
 #  define JSON_USE_INT64_DOUBLE_CONVERSION 1
 #endif
 #if !defined(JSON_IS_AMALGAMATION)
 # include "version.h"
 # if JSONCPP_USING_SECURE_MEMORY
 #  include "allocator.h" //typedef Allocator
 # endif
 #endif // if !defined(JSON_IS_AMALGAMATION)
 namespace Json {
 typedef int Int;
 typedef unsigned int UInt;
 #if defined(JSON_NO_INT64)
 typedef int LargestInt;
 typedef unsigned int LargestUInt;
 #undef JSON_HAS_INT64
 #else                 // if defined(JSON_NO_INT64)
 // For Microsoft Visual use specific types as long long is not supported
 #if defined(_MSC_VER) // Microsoft Visual Studio
 typedef __int64 Int64;
 typedef unsigned __int64 UInt64;
 #else                 // if defined(_MSC_VER) // Other platforms, use long long
 typedef int64_t Int64;
 typedef uint64_t UInt64;
 #endif // if defined(_MSC_VER)
 typedef Int64 LargestInt;
 typedef UInt64 LargestUInt;
 #define JSON_HAS_INT64
 #endif // if defined(JSON_NO_INT64)
 #if JSONCPP_USING_SECURE_MEMORY
 #define JSONCPP_STRING        std::basic_string<char, std::char_traits<char>, Json::SecureAllocator<char> >
 #define JSONCPP_OSTRINGSTREAM std::basic_ostringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
 #define JSONCPP_OSTREAM       std::basic_ostream<char, std::char_traits<char>>
 #define JSONCPP_ISTRINGSTREAM std::basic_istringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
 #define JSONCPP_ISTREAM       std::istream
 #else
 #define JSONCPP_STRING        std::string
 #define JSONCPP_OSTRINGSTREAM std::ostringstream
 #define JSONCPP_OSTREAM       std::ostream
 #define JSONCPP_ISTRINGSTREAM std::istringstream
 #define JSONCPP_ISTREAM       std::istream
 #endif // if JSONCPP_USING_SECURE_MEMORY
 } // end namespace Json
 #endif // JSON_CONFIG_H_INCLUDED
 // //////////////////////////////////////////////////////////////////////
 // End of content of file: include/json/config.h
 // //////////////////////////////////////////////////////////////////////
 // //////////////////////////////////////////////////////////////////////
 // Beginning of content of file: include/json/forwards.h
 // //////////////////////////////////////////////////////////////////////
 // Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 // Distributed under MIT license, or public domain if desired and
 // recognized in your jurisdiction.
 // See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE
 #ifndef JSON_FORWARDS_H_INCLUDED
 #define JSON_FORWARDS_H_INCLUDED
 #if !defined(JSON_IS_AMALGAMATION)
 #include "config.h"
 #endif // if !defined(JSON_IS_AMALGAMATION)
 namespace Json {
 // writer.h
 class FastWriter;
 class StyledWriter;
 // reader.h
 class Reader;
 // features.h
 class Features;
 // value.h
 typedef unsigned int ArrayIndex;
 class StaticString;
 class Path;
 class PathArgument;
 class Value;
 class ValueIteratorBase;
 class ValueIterator;
 class ValueConstIterator;
 } // namespace Json
 #endif // JSON_FORWARDS_H_INCLUDED
 // //////////////////////////////////////////////////////////////////////
 // End of content of file: include/json/forwards.h
 // //////////////////////////////////////////////////////////////////////
 #endif //ifndef JSON_FORWARD_AMALGATED_H_INCLUDED
@@ -0,0 +1,29 @@
 {
  "requires": true,
  "lockfileVersion": 1,
  "dependencies": {
    "async-limiter": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.0.tgz",
      "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg=="
    },
    "base-64": {
      "version": "0.1.0",
      "resolved": "https://registry.npmjs.org/base-64/-/base-64-0.1.0.tgz",
      "integrity": "sha1-eAqZyE59YAJgNhURxId2E78k9rs="
    },
    "djb2": {
      "version": "0.0.2",
      "resolved": "https://registry.npmjs.org/djb2/-/djb2-0.0.2.tgz",
      "integrity": "sha1-RAs4kao6uBQrVNRpsXe66p6W5O8="
    },
    "ws": {
      "version": "6.1.4",
      "resolved": "https://registry.npmjs.org/ws/-/ws-6.1.4.tgz",
      "integrity": "sha512-eqZfL+NE/YQc1/ZynhojeV8q+H050oR8AZ2uIev7RU10svA9ZnJUddHcOUZTJLinZ9yEfdA2kSATS2qZK5fhJA==",
      "requires": {
        "async-limiter": "1.0.0"
      }
    }
  }
 }
@@ -0,0 +1,153 @@
 /*
 *  ws_receive.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include <iostream>
 #include <sstream>
 #include <fstream>
 #include <ixwebsocket/IXWebSocketServer.h>
 #include <jsoncpp/json/json.h>
 #include <ixcrypto/IXBase64.h>
 #include <ixcrypto/IXHash.h>
 namespace
 {
    // We should cleanup the file name and full path further to remove .. as well
    std::string extractFilename(const std::string& path)
    {
        std::string filename("filename.conf");
        std::string::size_type idx;
        idx = path.rfind('/');
        if (idx != std::string::npos)
        {
            std::string filename = path.substr(idx+1);
            return filename;
        }
        else
        {
            return std::string();
        }
    }
 }
 namespace ix
 {
    void errorHandler(const std::string& errMsg,
                      const std::string& id,
                      std::shared_ptr<ix::WebSocket> webSocket)
    {
        Json::Value pdu;
        pdu["kind"] = "error";
        pdu["id"] = id;
        pdu["message"] = errMsg;
        webSocket->send(pdu.toStyledString());
    }
    void messageHandler(const std::string& str,
                        std::shared_ptr<ix::WebSocket> webSocket)
    {
        std::cerr << "Received message: " << str.size() << std::endl;
        Json::Value data;
        Json::Reader reader;
        if (!reader.parse(str, data))
        {
            errorHandler("Invalid JSON", std::string(), webSocket);
            return;
        }
        std::cout << "id: " << data["id"].asString() << std::endl;
        std::string content = ix::base64_decode(data["content"].asString());
        std::cout << "Content size: " << content.size() << std::endl;
        // Validate checksum
        uint64_t cksum = ix::djb2Hash(data["content"].asString());
        uint64_t cksumRef = data["djb2_hash"].asUInt64();
        std::cout << "Computed hash: " << cksum << std::endl;
        std::cout << "Reference hash: " << cksumRef << std::endl;
        if (cksum != cksumRef)
        {
            errorHandler("Hash mismatch.", std::string(), webSocket);
            return;
        }
        std::string filename = data["filename"].asString();
        filename = extractFilename(filename);
        std::ofstream out(filename);
        out << content;
        out.close();
        Json::Value pdu;
        pdu["ack"] = true;
        pdu["id"] = data["id"];
        pdu["filename"] = data["filename"];
        webSocket->send(pdu.toStyledString());
    }
 }
 int main(int argc, char** argv)
 {
    int port = 8080;
    if (argc == 2)
    {
        std::stringstream ss;
        ss << argv[1];
        ss >> port;
    }
    ix::WebSocketServer server(port);
    server.setOnConnectionCallback(
        [&server](std::shared_ptr<ix::WebSocket> webSocket)
        {
            webSocket->setOnMessageCallback(
                [webSocket, &server](ix::WebSocketMessageType messageType,
                                     const std::string& str,
                                     size_t wireSize,
                                     const ix::WebSocketErrorInfo& error,
                                     const ix::WebSocketOpenInfo& openInfo,
                                     const ix::WebSocketCloseInfo& closeInfo)
                {
                    if (messageType == ix::WebSocket_MessageType_Open)
                    {
                        std::cerr << "New connection" << std::endl;
                        std::cerr << "Uri: " << openInfo.uri << std::endl;
                        std::cerr << "Headers:" << std::endl;
                        for (auto it : openInfo.headers)
                        {
                            std::cerr << it.first << ": " << it.second << std::endl;
                        }
                    }
                    else if (messageType == ix::WebSocket_MessageType_Close)
                    {
                        std::cerr << "Closed connection" << std::endl;
                    }
                    else if (messageType == ix::WebSocket_MessageType_Message)
                    {
                        messageHandler(str, webSocket);
                    }
                }
            );
        }
    );
    auto res = server.listen();
    if (!res.first)
    {
        std::cerr << res.second << std::endl;
        return 1;
    }
    server.start();
    server.wait();
    return 0;
 }
@@ -0,0 +1,43 @@
 /*
 *  ws_receive.js
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 const WebSocket = require('ws')
 const djb2 = require('djb2')
 const fs = require('fs')
 const wss = new WebSocket.Server({ port: 8080,
                                   perMessageDeflate: false,
                                   maxPayload: 1024 * 1024 * 1024 * 1024});
 wss.on('connection', function connection(ws) {
  ws.on('message', function incoming(data) {
    console.log('Received message')
    let str = data.toString()
    let obj = JSON.parse(str)
    console.log(obj.id)
    console.log(obj.djb2_hash)
    console.log(djb2(obj.content))
    var content = Buffer.from(obj.content, 'base64')
    // let bytes = base64.decode(obj.content)
    let path = obj.filename
    fs.writeFile(path, content, function(err) {
      if (err) {
        throw err
      } else {
        console.log('wrote data to disk')
      }
    });
    let response = {
      id: obj.id
    }
    ws.send(JSON.stringify(response))
  });
 });
@@ -0,0 +1 @@
 build
@@ -0,0 +1,31 @@
 #
 # Author: Benjamin Sergeant
 # Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 #
 cmake_minimum_required (VERSION 3.4.1)
 project (ws_send)
 # There's -Weverything too for clang
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
 set (CMAKE_CXX_STANDARD 14)
 option(USE_TLS "Add TLS support" ON)
 add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
 include_directories(ws_send .)
 add_executable(ws_send 
  jsoncpp/jsoncpp.cpp
  ixcrypto/IXBase64.cpp
  ixcrypto/IXUuid.cpp
  ixcrypto/IXHash.cpp
  ws_send.cpp)
 if (APPLE AND USE_TLS)
    target_link_libraries(ws_send "-framework foundation" "-framework security")
 endif()
 target_link_libraries(ws_send ixwebsocket)
@@ -0,0 +1 @@
 ws_send is a simple upload program. It needs to be used in conjonction with ws_receive.
@@ -0,0 +1 @@
 ../cobra_publisher/ixcrypto
@@ -0,0 +1 @@
 ../cobra_publisher/jsoncpp
@@ -0,0 +1,306 @@
 /*
 *  ws_send.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #include <iostream>
 #include <fstream>
 #include <sstream>
 #include <vector>
 #include <condition_variable>
 #include <mutex>
 #include <chrono>
 #include <ixwebsocket/IXWebSocket.h>
 #include <ixwebsocket/IXSocket.h>
 #include <ixcrypto/IXUuid.h>
 #include <ixcrypto/IXBase64.h>
 #include <ixcrypto/IXHash.h>
 #include <jsoncpp/json/json.h>
 using namespace ix;
 namespace
 {
    void log(const std::string& msg)
    {
        std::cout << msg << std::endl;
    }
    class WebSocketSender
    {
        public:
            WebSocketSender(const std::string& _url,
                            bool enablePerMessageDeflate);
            void subscribe(const std::string& channel);
            void start();
            void stop();
            void waitForConnection();
            void waitForAck();
            void sendMessage(const std::string& filename, bool throttle);
        private:
            std::string _url;
            std::string _id;
            ix::WebSocket _webSocket;
            bool _enablePerMessageDeflate;
            std::mutex _conditionVariableMutex;
            std::condition_variable _condition;
    };
    WebSocketSender::WebSocketSender(const std::string& url,
                                     bool enablePerMessageDeflate) :
        _url(url),
        _enablePerMessageDeflate(enablePerMessageDeflate)
    {
        ;
    }
    void WebSocketSender::stop()
    {
        _webSocket.stop();
    }
    void WebSocketSender::waitForConnection()
    {
        std::cout << "Connecting..." << std::endl;
        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
        _condition.wait(lock);
    }
    void WebSocketSender::waitForAck()
    {
        std::cout << "Waiting for ack..." << std::endl;
        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
        _condition.wait(lock);
    }
    std::string load(const std::string& path)
    {
        // std::vector<uint8_t> memblock;
        std::string str;
        std::ifstream file(path);
        if (!file.is_open()) return std::string();
        file.seekg(0, file.end);
        std::streamoff size = file.tellg();
        file.seekg(0, file.beg);
        str.resize(size);
        file.read((char*)&str.front(), static_cast<std::streamsize>(size));
        return str;
    }
    void WebSocketSender::start()
    {
        _webSocket.setUrl(_url);
        ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(
            _enablePerMessageDeflate, false, false, 15, 15);
        _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
        std::stringstream ss;
        log(std::string("Connecting to url: ") + _url);
        _webSocket.setOnMessageCallback(
            [this](ix::WebSocketMessageType messageType,
               const std::string& str,
               size_t wireSize,
               const ix::WebSocketErrorInfo& error,
               const ix::WebSocketOpenInfo& openInfo,
               const ix::WebSocketCloseInfo& closeInfo)
            {
                std::stringstream ss;
                if (messageType == ix::WebSocket_MessageType_Open)
                {
                    _condition.notify_one();
                    log("ws_send: connected");
                    std::cout << "Uri: " << openInfo.uri << std::endl;
                    std::cout << "Handshake Headers:" << std::endl;
                    for (auto it : openInfo.headers)
                    {
                        std::cout << it.first << ": " << it.second << std::endl;
                    }
                }
                else if (messageType == ix::WebSocket_MessageType_Close)
                {
                    ss << "ws_send: connection closed:";
                    ss << " code " << closeInfo.code;
                    ss << " reason " << closeInfo.reason << std::endl;
                    log(ss.str());
                }
                else if (messageType == ix::WebSocket_MessageType_Message)
                {
                    _condition.notify_one();
                    ss << "ws_send: received message: "
                       << str;
                    log(ss.str());
                    Json::Value data;
                    Json::Reader reader;
                    if (!reader.parse(str, data))
                    {
                        std::cerr << "Invalid JSON response" << std::endl;
                        return;
                    }
                    std::string id = data["id"].asString();
                    if (_id != id)
                    {
                        std::cerr << "Invalid id" << std::endl;
                    }
                }
                else if (messageType == ix::WebSocket_MessageType_Error)
                {
                    ss << "Connection error: " << error.reason      << std::endl;
                    ss << "#retries: "         << error.retries     << std::endl;
                    ss << "Wait time(ms): "    << error.wait_time   << std::endl;
                    ss << "HTTP Status: "      << error.http_status << std::endl;
                    log(ss.str());
                }
                else
                {
                    ss << "Invalid ix::WebSocketMessageType";
                    log(ss.str());
                }
            });
        _webSocket.start();
    }
    class Bench
    {
        public:
            Bench(const std::string& description) :
                _description(description),
                _start(std::chrono::system_clock::now()),
                _reported(false)
            {
                ;
            }
            ~Bench()
            {
                if (!_reported)
                {
                    report();
                }
            }
            void report()
            {
                auto now = std::chrono::system_clock::now();
                auto milliseconds = std::chrono::duration_cast<std::chrono::milliseconds>(now - _start);
                _ms = milliseconds.count();
                std::cout << _description << " completed in "
                          << _ms << "ms" << std::endl;
                _reported = true;
            }
            uint64_t getDuration() const
            {
                return _ms;
            }
        private:
            std::string _description;
            std::chrono::time_point<std::chrono::system_clock> _start;
            uint64_t _ms;
            bool _reported;
    };
    void WebSocketSender::sendMessage(const std::string& filename,
                                      bool throttle)
    {
        std::string content;
        {
            Bench bench("load file from disk");
            content = load(filename);
        }
        _id = uuid4();
        std::string b64Content;
        {
            Bench bench("base 64 encode file");
            b64Content = base64_encode(content, content.size());
        }
        Json::Value pdu;
        pdu["kind"] = "send";
        pdu["id"] = _id;
        pdu["content"] = b64Content;
        pdu["djb2_hash"] = djb2Hash(b64Content);
        pdu["filename"] = filename;
        Bench bench("Sending file through websocket");
        _webSocket.send(pdu.toStyledString(),
                        [throttle](int current, int total) -> bool
        {
            std::cout << "Step " << current << " out of " << total << std::endl;
            if (throttle)
            {
                std::chrono::duration<double, std::milli> duration(10);
                std::this_thread::sleep_for(duration);
            }
            return true;
        });
        bench.report();
        auto duration = bench.getDuration();
        auto transferRate = 1000 * b64Content.size() / duration;
        transferRate /= (1024 * 1024);
        std::cout << "Send transfer rate: " << transferRate << "MB/s" << std::endl;
    }
    void wsSend(const std::string& url,
                const std::string& path,
                bool enablePerMessageDeflate,
                bool throttle)
    {
        WebSocketSender webSocketSender(url, enablePerMessageDeflate);
        webSocketSender.start();
        webSocketSender.waitForConnection();
        std::cout << "Sending..." << std::endl;
        webSocketSender.sendMessage(path, throttle);
        webSocketSender.waitForAck();
        std::cout << "Done !" << std::endl;
        webSocketSender.stop();
    }
 }
 int main(int argc, char** argv)
 {
    if (argc != 3)
    {
        std::cerr << "Usage: ws_send <url> <path>" << std::endl;
        return 1;
    }
    std::string url = argv[1];
    std::string path = argv[2];
    bool throttle = false;
    bool enablePerMessageDeflate = false;
    Socket::init();
    wsSend(url, path, enablePerMessageDeflate, throttle);
    return 0;
 }
@@ -1,375 +0,0 @@
 <!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
 -->
@@ -0,0 +1,33 @@
 /*
 *  IXCancellationRequest.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXCancellationRequest.h"
 #include <chrono>
 namespace ix
 {
    CancellationRequest makeCancellationRequestWithTimeout(int secs,
                                                           std::atomic<bool>& requestInitCancellation)
    {
        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;
    }
 }
@@ -0,0 +1,19 @@
 /*
 *  IXCancellationRequest.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <functional>
 #include <atomic>
 namespace ix
 {
    using CancellationRequest = std::function<bool()>;
    CancellationRequest makeCancellationRequestWithTimeout(int seconds,
                                                           std::atomic<bool>& requestInitCancellation);
 }
@@ -0,0 +1,164 @@
 /*
 *  IXDNSLookup.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXDNSLookup.h"
 #include "IXNetSystem.h"
 #include <string.h>
 #include <chrono>
 namespace ix
 {
    const int64_t DNSLookup::kDefaultWait = 10; // ms
    std::atomic<uint64_t> DNSLookup::_nextId(0);
    std::set<uint64_t> DNSLookup::_activeJobs;
    std::mutex DNSLookup::_activeJobsMutex;
    DNSLookup::DNSLookup(const std::string& hostname, int port, int64_t wait) :
        _hostname(hostname),
        _port(port),
        _wait(wait),
        _res(nullptr),
        _done(false),
        _id(_nextId++)
    {
    }
    DNSLookup::~DNSLookup()
    {
        // Remove this job from the active jobs list
        std::unique_lock<std::mutex> lock(_activeJobsMutex);
        _activeJobs.erase(_id);
    }
    struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname,
                                            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 blocking)
    {
        return blocking ? resolveBlocking(errMsg, isCancellationRequested)
                        : resolveAsync(errMsg, isCancellationRequested);
    }
    struct addrinfo* DNSLookup::resolveBlocking(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::resolveAsync(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.
        }
        // Record job in the active Job set
        {
            std::unique_lock<std::mutex> lock(_activeJobsMutex);
            _activeJobs.insert(_id);
        }
        //
        // Good resource on thread forced termination
        // https://www.bo-yang.net/2017/11/19/cpp-kill-detached-thread
        //
        _thread = std::thread(&DNSLookup::run, this, _id, _hostname, _port);
        _thread.detach();
        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
        while (!_done)
        {
            // Wait for 10 milliseconds on the condition variable, to see
            // if the bg thread has terminated.
            if (_condition.wait_for(lock, std::chrono::milliseconds(_wait)) == std::cv_status::no_timeout)
            {
                // Background thread has terminated, so we can break of this loop
                break;
            }
            // 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;
        }
        return _res;
    }
    void DNSLookup::run(uint64_t id, const 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 this isn't an active job, and the control thread is gone
        // there is not thing to do, and we don't want to touch the defunct
        // object data structure such as _errMsg or _condition
        std::unique_lock<std::mutex> lock(_activeJobsMutex);
        if (_activeJobs.count(id) == 0)
        {
            return;
        }
        // Copy result into the member variables
        _res = res;
        _errMsg = errMsg;
        _condition.notify_one();
        _done = true;
    }
 }
@@ -0,0 +1,66 @@
 /*
 *  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 <string>
 #include <thread>
 #include <atomic>
 #include <condition_variable>
 #include <set>
 struct addrinfo;
 namespace ix
 {
    class DNSLookup {
    public:
        DNSLookup(const std::string& hostname,
                  int port,
                  int64_t wait = DNSLookup::kDefaultWait);
        ~DNSLookup();
        struct addrinfo* resolve(std::string& errMsg,
                                 const CancellationRequest& isCancellationRequested,
                                 bool blocking = false);
    private:
        struct addrinfo* resolveAsync(std::string& errMsg,
                                      const CancellationRequest& isCancellationRequested);
        struct addrinfo* resolveBlocking(std::string& errMsg,
                                         const CancellationRequest& isCancellationRequested);
        static struct addrinfo* getAddrInfo(const std::string& hostname,
                                            int port,
                                            std::string& errMsg);
        void run(uint64_t id, const std::string& hostname, int port); // thread runner
        std::string _hostname;
        int _port;
        int64_t _wait;
        std::string _errMsg;
        struct addrinfo* _res;
        std::atomic<bool> _done;
        std::thread _thread;
        std::condition_variable _condition;
        std::mutex _conditionVariableMutex;
        uint64_t _id;
        static std::atomic<uint64_t> _nextId;
        static std::set<uint64_t> _activeJobs;
        static std::mutex _activeJobsMutex;
        const static int64_t kDefaultWait;
    };
 }
@@ -0,0 +1,82 @@
 /*
 *  IXEventFd.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 //
 // Linux/Android has a special type of virtual files. select(2) will react
 // when reading/writing to those files, unlike closing sockets.
 //
 // https://linux.die.net/man/2/eventfd
 // http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
 //
 // eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
 // is on Kernel 3.x
 //
 // cf Android/Kernel table here
 // https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
 //
 #include "IXEventFd.h"
 #ifdef __linux__
 # include <sys/eventfd.h>
 #endif
 #ifndef _WIN32
 #include <unistd.h> // for write
 #endif
 namespace ix
 {
    EventFd::EventFd() :
        _eventfd(-1)
    {
 #ifdef __linux__
        _eventfd = eventfd(0, 0);
 #endif
    }
    EventFd::~EventFd()
    {
 #ifdef __linux__
        ::close(_eventfd);
 #endif
    }
    bool EventFd::notify()
    {
 #if defined(__linux__)
        if (_eventfd == -1) return false;
        // select will wake up when a non-zero value is written to our eventfd
        uint64_t value = 1;
        // we should write 8 bytes for an uint64_t
        return write(_eventfd, &value, sizeof(value)) == 8;
 #else
        return true;
 #endif
    }
    bool EventFd::clear()
    {
 #if defined(__linux__)
        if (_eventfd == -1) return false;
        // 0 is a special value ; select will not wake up
        uint64_t value = 0;
        // we should write 8 bytes for an uint64_t
        return write(_eventfd, &value, sizeof(value)) == 8;
 #else
        return true;
 #endif
    }
    int EventFd::getFd()
    {
        return _eventfd;
    }
 }
@@ -0,0 +1,23 @@
 /*
 *  IXEventFd.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 namespace ix
 {
    class EventFd {
    public:
        EventFd();
        virtual ~EventFd();
        bool notify();
        bool clear();
        int getFd();
    private:
        int _eventfd;
    };
 }
@@ -0,0 +1,471 @@
 /*
 *  IXHttpClient.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXHttpClient.h"
 #include "IXUrlParser.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXSocketFactory.h"
 #include <sstream>
 #include <iomanip>
 #include <vector>
 #include <cstring>
 #include <zlib.h>
 namespace ix
 {
    const std::string HttpClient::kPost = "POST";
    const std::string HttpClient::kGet = "GET";
    const std::string HttpClient::kHead = "HEAD";
    HttpClient::HttpClient()
    {
    }
    HttpClient::~HttpClient()
    {
    }
    HttpResponse HttpClient::request(
        const std::string& url,
        const std::string& verb,
        const std::string& body,
        const HttpRequestArgs& args,
        int redirects)
    {
        uint64_t uploadSize = 0;
        uint64_t downloadSize = 0;
        int code = 0;
        WebSocketHttpHeaders headers;
        std::string payload;
        std::string protocol, host, path, query;
        int port;
        bool websocket = false;
        if (!UrlParser::parse(url, protocol, host, path, query, port, websocket))
        {
            std::stringstream ss;
            ss << "Cannot parse url: " << url;
            return std::make_tuple(code, HttpErrorCode_UrlMalformed,
                                   headers, payload, ss.str(),
                                   uploadSize, downloadSize);
        }
        bool tls = protocol == "https";
        std::string errorMsg;
        _socket = createSocket(tls, errorMsg);
        if (!_socket)
        {
            return std::make_tuple(code, HttpErrorCode_CannotCreateSocket,
                                   headers, payload, errorMsg,
                                   uploadSize, downloadSize);
        }
        // Build request string
        std::stringstream ss;
        ss << verb << " " << path << " HTTP/1.1\r\n";
        ss << "Host: " << host << "\r\n";
        ss << "User-Agent: ixwebsocket/1.0.0" << "\r\n";
        ss << "Accept: */*" << "\r\n";
        if (args.compress)
        {
            ss << "Accept-Encoding: gzip" << "\r\n";
        }
        // Append extra headers
        for (auto&& it : args.extraHeaders)
        {
            ss << it.first << ": " << it.second << "\r\n";
        }
        if (verb == kPost)
        {
            ss << "Content-Length: " << body.size() << "\r\n";
            // Set default Content-Type if unspecified
            if (args.extraHeaders.find("Content-Type") == args.extraHeaders.end())
            {
                ss << "Content-Type: application/x-www-form-urlencoded" << "\r\n";
            }
            ss << "\r\n";
            ss << body;
        }
        else
        {
            ss << "\r\n";
        }
        std::string req(ss.str());
        std::string errMsg;
        std::atomic<bool> requestInitCancellation(false);
        // Make a cancellation object dealing with connection timeout
        auto isCancellationRequested =
            makeCancellationRequestWithTimeout(args.connectTimeout, requestInitCancellation);
        bool success = _socket->connect(host, port, errMsg, isCancellationRequested);
        if (!success)
        {
            std::stringstream ss;
            ss << "Cannot connect to url: " << url;
            return std::make_tuple(code, HttpErrorCode_CannotConnect,
                                   headers, payload, ss.str(),
                                   uploadSize, downloadSize);
        }
        // Make a new cancellation object dealing with transfer timeout
        isCancellationRequested =
            makeCancellationRequestWithTimeout(args.transferTimeout, requestInitCancellation);
        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_tuple(code, 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_tuple(code, 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_tuple(code, 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_tuple(code, 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_tuple(code, HttpErrorCode_MissingLocation,
                                       headers, payload, errorMsg,
                                       uploadSize, downloadSize);
            }
            if (redirects >= args.maxRedirects)
            {
                std::stringstream ss;
                ss << "Too many redirects: " << redirects;
                return std::make_tuple(code, HttpErrorCode_TooManyRedirects,
                                       headers, payload, ss.str(),
                                       uploadSize, downloadSize);
            }
            // Recurse
            std::string location = headers["Location"];
            return request(location, verb, body, args, redirects+1);
        }
        if (verb == "HEAD")
        {
            return std::make_tuple(code, 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);
            // FIXME: very inefficient way to read bytes, but it works...
            for (int i = 0; i < contentLength; ++i)
            {
                char c;
                if (!_socket->readByte(&c, isCancellationRequested))
                {
                    return std::make_tuple(code, HttpErrorCode_ReadError,
                                           headers, payload, "Cannot read byte",
                                           uploadSize, downloadSize);
                }
                payload += c;
            }
        }
        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_tuple(code, 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() + chunkSize);
                // Read another line
                for (uint64_t i = 0; i < chunkSize; ++i)
                {
                    char c;
                    if (!_socket->readByte(&c, isCancellationRequested))
                    {
                        errorMsg = "Cannot read byte";
                        return std::make_tuple(code, HttpErrorCode_ChunkReadError,
                                               headers, payload, errorMsg,
                                               uploadSize, downloadSize);
                    }
                    payload += c;
                }
                lineResult = _socket->readLine(isCancellationRequested);
                if (!lineResult.first)
                {
                    return std::make_tuple(code, 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_tuple(code, HttpErrorCode_CannotReadBody,
                                   headers, payload, errorMsg,
                                   uploadSize, downloadSize);
        }
        downloadSize = payload.size();
        // If the content was compressed with gzip, decode it
        if (headers["Content-Encoding"] == "gzip")
        {
            std::string decompressedPayload;
            if (!gzipInflate(payload, decompressedPayload))
            {
                std::string errorMsg("Error decompressing payload");
                return std::make_tuple(code, HttpErrorCode_Gzip,
                                       headers, payload, errorMsg,
                                       uploadSize, downloadSize);
            }
            payload = decompressedPayload;
        }
        return std::make_tuple(code, HttpErrorCode_Ok,
                               headers, payload, std::string(),
                               uploadSize, downloadSize);
    }
    HttpResponse HttpClient::get(const std::string& url,
                                 const HttpRequestArgs& args)
    {
        return request(url, kGet, std::string(), args);
    }
    HttpResponse HttpClient::head(const std::string& url,
                                  const HttpRequestArgs& args)
    {
        return request(url, kHead, std::string(), args);
    }
    HttpResponse HttpClient::post(const std::string& url,
                                  const HttpParameters& httpParameters,
                                  const HttpRequestArgs& args)
    {
        return request(url, kPost, serializeHttpParameters(httpParameters), args);
    }
    HttpResponse HttpClient::post(const std::string& url,
                                  const std::string& body,
                                  const HttpRequestArgs& args)
    {
        return request(url, kPost, 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();
    }
    bool HttpClient::gzipInflate(
        const std::string& in,
        std::string& out)
    {
        z_stream inflateState;
        std::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::unique_ptr<unsigned char[]> compressBuffer =
            std::make_unique<unsigned char[]>(kBufferSize);
        do
        {
            inflateState.avail_out = (uInt) kBufferSize;
            inflateState.next_out = compressBuffer.get();
            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.get()),
                kBufferSize - inflateState.avail_out
            );
        } while (inflateState.avail_out == 0);
        inflateEnd(&inflateState);
        return true;
    }
    void HttpClient::log(const std::string& msg,
                         const HttpRequestArgs& args)
    {
        if (args.logger)
        {
            args.logger(msg);
        }
    }
 }
@@ -0,0 +1,106 @@
 /*
 *  IXHttpClient.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <algorithm>
 #include <functional>
 #include <mutex>
 #include <atomic>
 #include <tuple>
 #include <memory>
 #include <map>
 #include "IXSocket.h"
 #include "IXWebSocketHttpHeaders.h"
 namespace ix
 {
    enum HttpErrorCode
    {
        HttpErrorCode_Ok = 0,
        HttpErrorCode_CannotConnect = 1,
        HttpErrorCode_Timeout = 2,
        HttpErrorCode_Gzip = 3,
        HttpErrorCode_UrlMalformed = 4,
        HttpErrorCode_CannotCreateSocket = 5,
        HttpErrorCode_SendError = 6,
        HttpErrorCode_ReadError = 7,
        HttpErrorCode_CannotReadStatusLine = 8,
        HttpErrorCode_MissingStatus = 9,
        HttpErrorCode_HeaderParsingError = 10,
        HttpErrorCode_MissingLocation = 11,
        HttpErrorCode_TooManyRedirects = 12,
        HttpErrorCode_ChunkReadError = 13,
        HttpErrorCode_CannotReadBody = 14
    };
    using HttpResponse = std::tuple<int, // status
                                    HttpErrorCode, // error code
                                    WebSocketHttpHeaders,
                                    std::string, // payload
                                    std::string, // error msg
                                    uint64_t,    // upload size
                                    uint64_t>;   // download size
    using HttpParameters = std::map<std::string, std::string>;
    using Logger = std::function<void(const std::string&)>;
    struct HttpRequestArgs
    {
        std::string url;
        WebSocketHttpHeaders extraHeaders;
        std::string body;
        int connectTimeout;
        int transferTimeout;
        bool followRedirects;
        int maxRedirects;
        bool verbose;
        bool compress;
        Logger logger;
    };
    class HttpClient {
    public:
        HttpClient();
        ~HttpClient();
        HttpResponse get(const std::string& url,
                         const HttpRequestArgs& args);
        HttpResponse head(const std::string& url,
                          const HttpRequestArgs& args);
        HttpResponse post(const std::string& url,
                          const HttpParameters& httpParameters,
                          const HttpRequestArgs& args);
        HttpResponse post(const std::string& url,
                          const std::string& body,
                          const HttpRequestArgs& args);
    private:
        HttpResponse request(const std::string& url,
                             const std::string& verb,
                             const std::string& body,
                             const HttpRequestArgs& args,
                             int redirects = 0);
        std::string serializeHttpParameters(const HttpParameters& httpParameters);
        std::string urlEncode(const std::string& value);
        void log(const std::string& msg, const HttpRequestArgs& args);
        bool gzipInflate(
            const std::string& in,
            std::string& out);
        std::shared_ptr<Socket> _socket;
        const static std::string kPost;
        const static std::string kGet;
        const static std::string kHead;
    };
 }
@@ -0,0 +1,25 @@
 /*
 *  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>
 #else
 # include <arpa/inet.h>
 # include <errno.h>
 # include <netdb.h>
 # include <netinet/tcp.h>
 # include <sys/select.h>
 # include <sys/socket.h>
 # include <sys/stat.h>
 # include <sys/time.h>
 # include <unistd.h>
 #endif
@@ -0,0 +1,14 @@
 /*
 *  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)>;
 }
@@ -0,0 +1,13 @@
 /*
 *  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);
 }
@@ -0,0 +1,262 @@
 /*
 *  IXSocket.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXSocket.h"
 #include "IXSocketConnect.h"
 #include "IXNetSystem.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
 #include <stdint.h>
 #include <fcntl.h>
 #include <sys/types.h>
 #include <algorithm>
 #include <iostream>
 namespace ix
 {
    const int Socket::kDefaultPollNoTimeout = -1; // No poll timeout by default
    const int Socket::kDefaultPollTimeout = kDefaultPollNoTimeout;
    Socket::Socket(int fd) :
        _sockfd(fd)
    {
    }
    Socket::~Socket()
    {
        close();
    }
    void Socket::poll(const OnPollCallback& onPollCallback, int timeoutSecs)
    {
        if (_sockfd == -1)
        {
            onPollCallback(PollResultType_Error);
            return;
        }
        fd_set rfds;
        FD_ZERO(&rfds);
        FD_SET(_sockfd, &rfds);
 #ifdef __linux__
        FD_SET(_eventfd.getFd(), &rfds);
 #endif
        struct timeval timeout;
        timeout.tv_sec = timeoutSecs;
        timeout.tv_usec = 0;
        int sockfd = _sockfd;
        int nfds = (std::max)(sockfd, _eventfd.getFd());
        int ret = select(nfds + 1, &rfds, nullptr, nullptr,
                         (timeoutSecs < 0) ? nullptr : &timeout);
        PollResultType pollResult = PollResultType_ReadyForRead;
        if (ret < 0)
        {
            pollResult = PollResultType_Error;
        }
        else if (ret == 0)
        {
            pollResult = PollResultType_Timeout;
        }
        onPollCallback(pollResult);
    }
    void Socket::wakeUpFromPoll()
    {
        // this will wake up the thread blocked on select, only needed on Linux
        _eventfd.notify();
    }
    bool Socket::connect(const std::string& host,
                         int port,
                         std::string& errMsg,
                         const CancellationRequest& isCancellationRequested)
    {
        std::lock_guard<std::mutex> lock(_socketMutex);
        if (!_eventfd.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()
    {
 #ifdef _WIN32
        return WSAGetLastError();
 #else
        return errno;
 #endif
    }
    void Socket::closeSocket(int fd)
    {
 #ifdef _WIN32
        closesocket(fd);
 #else
        ::close(fd);
 #endif
    }
    bool Socket::init()
    {
 #ifdef _WIN32
        INT rc;
        WSADATA wsaData;
        rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
        return rc != 0;
 #else
        return true;
 #endif
    }
    void Socket::cleanup()
    {
 #ifdef _WIN32
        WSACleanup();
 #endif
    }
    bool Socket::readByte(void* buffer,
                          const CancellationRequest& isCancellationRequested)
    {
        while (true)
        {
            if (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 && (getErrno() == EWOULDBLOCK ||
                                 getErrno() == EAGAIN))
            {
                // Wait with a timeout until something is written.
                // This way we are not busy looping
                fd_set rfds;
                struct timeval timeout;
                timeout.tv_sec = 0;
                timeout.tv_usec = 1 * 1000; // 1ms timeout
                FD_ZERO(&rfds);
                FD_SET(_sockfd, &rfds);
                if (select(_sockfd + 1, &rfds, nullptr, nullptr, &timeout) < 0 &&
                    (errno == EBADF || errno == EINVAL))
                {
                    return false;
                }
                continue;
            }
            // There was an error during the read, abort
            else
            {
                return false;
            }
        }
    }
    bool Socket::writeBytes(const std::string& str,
                            const CancellationRequest& isCancellationRequested)
    {
        while (true)
        {
            if (isCancellationRequested()) return false;
            char* buffer = const_cast<char*>(str.c_str());
            int len = (int) str.size();
            ssize_t ret = send(buffer, len);
            // We wrote some bytes, as needed, all good.
            if (ret > 0)
            {
                return ret == len;
            }
            // There is possibly something to be write, try again
            else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
                                 getErrno() == EAGAIN))
            {
                continue;
            }
            // There was an error during the write, 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 std::make_pair(false, std::string());
            }
            line += c;
        }
        return std::make_pair(true, line);
    }
 }
@@ -0,0 +1,78 @@
 /*
 *  IXSocket.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <string>
 #include <functional>
 #include <mutex>
 #include <atomic>
 #ifdef _WIN32
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
 #endif
 #include "IXEventFd.h"
 #include "IXCancellationRequest.h"
 namespace ix
 {
    enum PollResultType
    {
        PollResultType_ReadyForRead = 0,
        PollResultType_Timeout = 1,
        PollResultType_Error = 2
    };
    class Socket {
    public:
        using OnPollCallback = std::function<void(PollResultType)>;
        Socket(int fd = -1);
        virtual ~Socket();
        void configure();
        virtual void poll(const OnPollCallback& onPollCallback,
                          int timeoutSecs = kDefaultPollTimeout);
        virtual void wakeUpFromPoll();
        // Virtual methods
        virtual bool connect(const std::string& url,
                             int port,
                             std::string& errMsg,
                             const CancellationRequest& isCancellationRequested);
        virtual void close();
        virtual ssize_t send(char* buffer, size_t length);
        virtual 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);
        static int getErrno();
        static bool init(); // Required on Windows to initialize WinSocket
        static void cleanup(); // Required on Windows to cleanup WinSocket
    protected:
        void closeSocket(int fd);
        std::atomic<int> _sockfd;
        std::mutex _socketMutex;
        EventFd _eventfd;
    private:
        static const int kDefaultPollTimeout;
        static const int kDefaultPollNoTimeout;
    };
 }
@@ -0,0 +1,261 @@
 /*
 *  IXSocketAppleSSL.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 *
 *  Adapted from Satori SDK Apple SSL code.
 */
 #include "IXSocketAppleSSL.h"
 #include "IXSocketConnect.h"
 #include <fcntl.h>
 #include <netdb.h>
 #include <netinet/tcp.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>
 #include <stdint.h>
 #include <iostream>
 #include <errno.h>
 #define socketerrno errno
 #include <Security/SecureTransport.h>
 namespace {
 OSStatus read_from_socket(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 (0 == status)
    {
        *len = 0;
        return errSSLClosedGraceful;
    }
    else
    {
        *len = 0;
        switch (errno) {
            case ENOENT:
                return errSSLClosedGraceful;
            case EAGAIN:
                return errSSLWouldBlock;
            case ECONNRESET:
                return errSSLClosedAbort;
            default:
                return errSecIO;
        }
    }
 }
 OSStatus write_to_socket(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 (0 == status)
    {
        *len = 0;
        return errSSLClosedGraceful;
    }
    else
    {
        *len = 0;
        if (EAGAIN == errno)
        {
            return errSSLWouldBlock;
        }
        else
        {
            return errSecIO;
        }
    }
 }
 std::string 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,
                                         CFStringGetSystemEncoding());
            if (success)
            {
                errMsg = localBuffer;
            }
            CFRelease(message);
        }
        CFRelease(error);
    }
    return errMsg;
 }
 } // anonymous namespace
 namespace ix
 {
    SocketAppleSSL::SocketAppleSSL(int fd) : Socket(fd),
        _sslContext(nullptr)
    {
        ;
    }
    SocketAppleSSL::~SocketAppleSSL()
    {
        SocketAppleSSL::close();
    }
    // 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, read_from_socket, write_to_socket);
            SSLSetConnection(_sslContext, (SSLConnectionRef) (long) _sockfd);
            SSLSetProtocolVersionMin(_sslContext, kTLSProtocol12);
            SSLSetPeerDomainName(_sslContext, host.c_str(), host.size());
            do {
                status = SSLHandshake(_sslContext);
            } while (errSSLWouldBlock == status ||
                     errSSLServerAuthCompleted == status);
        }
        if (noErr != status)
        {
            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)
    {
        ssize_t ret = 0;
        OSStatus status;
        do {
            size_t processed = 0;
            std::lock_guard<std::mutex> lock(_mutex);
            status = SSLWrite(_sslContext, buf, nbyte, &processed);
            ret += processed;
            buf += processed;
            nbyte -= processed;
        } while (nbyte > 0 && errSSLWouldBlock == status);
        if (ret == 0 && errSSLClosedAbort != status)
            ret = -1;
        return ret;
    }
    ssize_t SocketAppleSSL::send(const std::string& buffer)
    {
        return send((char*)&buffer[0], buffer.size());
    }
    // No wait support
    ssize_t SocketAppleSSL::recv(void* buf, size_t nbyte)
    {
        OSStatus status = errSSLWouldBlock;
        while (errSSLWouldBlock == status)
        {
            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;
    }
 }
@@ -0,0 +1,40 @@
 /*
 *  IXSocketAppleSSL.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXSocket.h"
 #include "IXCancellationRequest.h"
 #include <Security/Security.h>
 #include <Security/SecureTransport.h>
 #include <mutex>
 namespace ix
 {
    class SocketAppleSSL : public Socket
    {
    public:
        SocketAppleSSL(int fd = -1);
        ~SocketAppleSSL();
        virtual bool connect(const std::string& host,
                             int port,
                             std::string& errMsg,
                             const CancellationRequest& isCancellationRequested) final;
        virtual void close() final;
        virtual ssize_t send(char* buffer, size_t length) final;
        virtual ssize_t send(const std::string& buffer) final;
        virtual ssize_t recv(void* buffer, size_t length) final;
    private:
        SSLContextRef _sslContext;
        mutable std::mutex _mutex;  // AppleSSL routines are not thread-safe
    };
 }
@@ -0,0 +1,186 @@
 /*
 *  IXSocketConnect.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXSocketConnect.h"
 #include "IXDNSLookup.h"
 #include "IXNetSystem.h"
 #include <string.h>
 #include <fcntl.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
 {
    void closeSocket(int fd)
    {
 #ifdef _WIN32
        closesocket(fd);
 #else
        ::close(fd);
 #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";
        int 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);
        if (::connect(fd, address->ai_addr, address->ai_addrlen) == -1
            && errno != EINPROGRESS)
        {
            closeSocket(fd);
            errMsg = strerror(errno);
            return -1;
        }
        for (;;)
        {
            if (isCancellationRequested()) // Must handle timeout as well
            {
                closeSocket(fd);
                errMsg = "Cancelled";
                return -1;
            }
            // Use select to check the status of the new connection
            struct timeval timeout;
            timeout.tv_sec = 0;
            timeout.tv_usec = 10 * 1000; // 10ms timeout
            fd_set wfds;
            fd_set efds;
            FD_ZERO(&wfds);
            FD_SET(fd, &wfds);
            FD_ZERO(&efds);
            FD_SET(fd, &efds);
            if (select(fd + 1, nullptr, &wfds, &efds, &timeout) < 0 &&
                (errno == EBADF || errno == EINVAL))
            {
                closeSocket(fd);
                errMsg = std::string("Connect error, select error: ") + strerror(errno);
                return -1;
            }
            // Nothing was written to the socket, wait again.
            if (!FD_ISSET(fd, &wfds)) continue;
            // Something was written to the socket. Check for errors.
            int optval = -1;
            socklen_t optlen = sizeof(optval);
 #ifdef _WIN32
            // On connect error, in async mode, windows will write to the exceptions fds
            if (FD_ISSET(fd, &efds))
 #else
            // getsockopt() puts the errno value for connect into optval so 0
            // means no-error.
            if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &optval, &optlen) == -1 ||
                optval != 0)
 #endif
            {
                closeSocket(fd);
                errMsg = strerror(optval);
                return -1;
            }
            else
            {
                // Success !
                return fd;
            }
        }
        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
        //
        DNSLookup 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
    }
 }
@@ -0,0 +1,32 @@
 /*
 *  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);
    };
 }
@@ -0,0 +1,42 @@
 /*
 *  IXSocketFactory.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXSocketFactory.h"
 #if defined(__APPLE__) or defined(__linux__)
 # ifdef __APPLE__
 #  include <ixwebsocket/IXSocketAppleSSL.h>
 # else
 #  include <ixwebsocket/IXSocketOpenSSL.h>
 # endif
 #endif
 namespace ix
 {
    std::shared_ptr<Socket> createSocket(bool tls,
                                         std::string& errorMsg)
    {
        errorMsg.clear();
        if (!tls)
        {
            return std::make_shared<Socket>();
        }
        else
        {
 #ifdef IXWEBSOCKET_USE_TLS
 # ifdef __APPLE__
            return std::make_shared<SocketAppleSSL>();
 # else
            return std::make_shared<SocketOpenSSL>();
 # endif
 #else
            errorMsg = "TLS support is not enabled on this platform.";
            return nullptr;
 #endif
        }
    }
 }
@@ -0,0 +1,17 @@
 /*
 *  IXSocketFactory.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <memory>
 namespace ix
 {
    class Socket;
    std::shared_ptr<Socket> createSocket(bool tls,
                                         std::string& errorMsg);
 }
@@ -0,0 +1,394 @@
 /*
 *  IXSocketOpenSSL.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 *
 *  Adapted from Satori SDK OpenSSL code.
 */
 #include "IXSocketOpenSSL.h"
 #include "IXSocketConnect.h"
 #include <cassert>
 #include <iostream>
 #include <openssl/x509v3.h>
 #include <fnmatch.h>
 #include <errno.h>
 #define socketerrno errno
 namespace ix
 {
    std::atomic<bool> SocketOpenSSL::_openSSLInitializationSuccessful(false);
    SocketOpenSSL::SocketOpenSSL(int fd) : Socket(fd),
        _ssl_connection(nullptr),
        _ssl_context(nullptr)
    {
        std::call_once(_openSSLInitFlag, &SocketOpenSSL::openSSLInitialize, this);
    }
    SocketOpenSSL::~SocketOpenSSL()
    {
        SocketOpenSSL::close();
    }
    void SocketOpenSSL::openSSLInitialize()
    {
 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
        if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_CONFIG, nullptr)) return;
 #else
        (void) OPENSSL_config(nullptr);
 #endif
        (void) OpenSSL_add_ssl_algorithms();
        (void) SSL_load_error_strings();
        _openSSLInitializationSuccessful = true;
    }
    std::string SocketOpenSSL::getSSLError(int ret)
    {
        unsigned long e;
        int err = SSL_get_error(_ssl_connection, ret);
        if (err == SSL_ERROR_WANT_CONNECT || err == SSL_ERROR_WANT_ACCEPT)
        {
            return "OpenSSL failed - connection failure";
        }
        else if (err == SSL_ERROR_WANT_X509_LOOKUP)
        {
            return "OpenSSL failed - x509 error";
        }
        else if (err == SSL_ERROR_SYSCALL)
        {
            e = ERR_get_error();
            if (e > 0)
            {
                std::string errMsg("OpenSSL failed - ");
                errMsg += ERR_error_string(e, nullptr);
                return errMsg;
            }
            else if (e == 0 && ret == 0)
            {
                return "OpenSSL failed - received early EOF";
            }
            else
            {
                return "OpenSSL failed - underlying BIO reported an I/O error";
            }
        }
        else if (err == SSL_ERROR_SSL)
        {
            e = ERR_get_error();
            std::string errMsg("OpenSSL failed - ");
            errMsg += ERR_error_string(e, nullptr);
            return errMsg;
        }
        else if (err == SSL_ERROR_NONE)
        {
            return "OpenSSL failed - err none";
        }
        else if (err == SSL_ERROR_ZERO_RETURN)
        {
            return "OpenSSL failed - err zero return";
        }
        else
        {
            return "OpenSSL failed - unknown error";
        }
    }
    SSL_CTX* SocketOpenSSL::openSSLCreateContext(std::string& errMsg)
    {
        const SSL_METHOD* method = SSLv23_client_method();
        if (method == nullptr)
        {
            errMsg = "SSLv23_client_method failure";
            return nullptr;
        }
        _ssl_method = method;
        SSL_CTX* ctx = SSL_CTX_new(_ssl_method);
        if (ctx)
        {
            // To skip verification, pass in SSL_VERIFY_NONE
            SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER,
                               [](int preverify, X509_STORE_CTX*) -> int
                               {
                                   return preverify;
                               });
            SSL_CTX_set_verify_depth(ctx, 4);
            SSL_CTX_set_options(ctx, SSL_OP_NO_SSLv2 | SSL_OP_NO_SSLv3);
        }
        return ctx;
    }
    /**
     * Check whether a hostname matches a pattern
     */
    bool SocketOpenSSL::checkHost(const std::string& host, const char *pattern)
    {
        return fnmatch(pattern, host.c_str(), 0) != FNM_NOMATCH;
    }
    bool SocketOpenSSL::openSSLCheckServerCert(SSL *ssl,
                                               const std::string& hostname,
                                               std::string& errMsg)
    {
        X509 *server_cert = SSL_get_peer_certificate(ssl);
        if (server_cert == nullptr)
        {
            errMsg = "OpenSSL failed - peer didn't present a X509 certificate.";
            return false;
        }
 #if OPENSSL_VERSION_NUMBER < 0x10100000L
        // Check server name
        bool hostname_verifies_ok = false;
        STACK_OF(GENERAL_NAME) *san_names =
            (STACK_OF(GENERAL_NAME)*) X509_get_ext_d2i((X509 *)server_cert,
                                                       NID_subject_alt_name, NULL, NULL);
        if (san_names)
        {
            for (int i=0; i<sk_GENERAL_NAME_num(san_names); i++)
            {
                const GENERAL_NAME *sk_name = sk_GENERAL_NAME_value(san_names, i);
                if (sk_name->type == GEN_DNS)
                {
                    char *name = (char *)ASN1_STRING_data(sk_name->d.dNSName);
                    if ((size_t)ASN1_STRING_length(sk_name->d.dNSName) == strlen(name) &&
                        checkHost(hostname, name))
                    {
                        hostname_verifies_ok = true;
                        break;
                    }
                }
            }
        }
        sk_GENERAL_NAME_pop_free(san_names, GENERAL_NAME_free);
        if (!hostname_verifies_ok)
        {
            int cn_pos = X509_NAME_get_index_by_NID(X509_get_subject_name((X509 *)server_cert),
                                                    NID_commonName, -1);
            if (cn_pos)
            {
                X509_NAME_ENTRY *cn_entry = X509_NAME_get_entry(
                    X509_get_subject_name((X509 *)server_cert), cn_pos);
                if (cn_entry)
                {
                    ASN1_STRING *cn_asn1 = X509_NAME_ENTRY_get_data(cn_entry);
                    char *cn = (char *)ASN1_STRING_data(cn_asn1);
                    if ((size_t)ASN1_STRING_length(cn_asn1) == strlen(cn) &&
                       checkHost(hostname, cn))
                    {
                        hostname_verifies_ok = true;
                    }
                }
            }
        }
        if (!hostname_verifies_ok)
        {
            errMsg = "OpenSSL failed - certificate was issued for a different domain.";
            return false;
        }
 #endif
        X509_free(server_cert);
        return true;
    }
    bool SocketOpenSSL::openSSLHandshake(const std::string& host, std::string& errMsg)
    {
        while (true)
        {
            if (_ssl_connection == nullptr || _ssl_context == nullptr)
            {
                return false;
            }
            ERR_clear_error();
            int connect_result = SSL_connect(_ssl_connection);
            if (connect_result == 1)
            {
                return openSSLCheckServerCert(_ssl_connection, host, errMsg);
            }
            int reason = SSL_get_error(_ssl_connection, connect_result);
            bool rc = false;
            if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
            {
                rc = true;
            }
            else
            {
                errMsg = getSSLError(connect_result);
                rc = false;
            }
            if (!rc)
            {
                return false;
            }
        }
    }
    // No wait support
    bool SocketOpenSSL::connect(const std::string& host,
                                int port,
                                std::string& errMsg,
                                const CancellationRequest& isCancellationRequested)
    {
        bool handshakeSuccessful = false;
        {
            std::lock_guard<std::mutex> lock(_mutex);
            if (!_openSSLInitializationSuccessful)
            {
                errMsg = "OPENSSL_init_ssl failure";
                return false;
            }
            _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
            if (_sockfd == -1) return false;
            _ssl_context = openSSLCreateContext(errMsg);
            if (_ssl_context == nullptr)
            {
                return false;
            }
            ERR_clear_error();
            int cert_load_result = SSL_CTX_set_default_verify_paths(_ssl_context);
            if (cert_load_result == 0)
            {
                unsigned long ssl_err = ERR_get_error();
                errMsg = "OpenSSL failed - SSL_CTX_default_verify_paths loading failed: ";
                errMsg += ERR_error_string(ssl_err, nullptr);
            }
            _ssl_connection = SSL_new(_ssl_context);
            if (_ssl_connection == nullptr)
            {
                errMsg = "OpenSSL failed to connect";
                SSL_CTX_free(_ssl_context);
                _ssl_context = nullptr;
                return false;
            }
            SSL_set_fd(_ssl_connection, _sockfd);
            // SNI support
            SSL_set_tlsext_host_name(_ssl_connection, host.c_str());
 #if OPENSSL_VERSION_NUMBER >= 0x10002000L
            // Support for server name verification
            // (The docs say that this should work from 1.0.2, and is the default from
            // 1.1.0, but it does not. To be on the safe side, the manual test below is
            // enabled for all versions prior to 1.1.0.)
            X509_VERIFY_PARAM *param = SSL_get0_param(_ssl_connection);
            X509_VERIFY_PARAM_set1_host(param, host.c_str(), 0);
 #endif
            handshakeSuccessful = openSSLHandshake(host, errMsg);
        }
        if (!handshakeSuccessful)
        {
            close();
            return false;
        }
        return true;
    }
    void SocketOpenSSL::close()
    {
        std::lock_guard<std::mutex> lock(_mutex);
        if (_ssl_connection != nullptr)
        {
            SSL_free(_ssl_connection);
            _ssl_connection = nullptr;
        }
        if (_ssl_context != nullptr)
        {
            SSL_CTX_free(_ssl_context);
            _ssl_context = nullptr;
        }
        Socket::close();
    }
    ssize_t SocketOpenSSL::send(char* buf, size_t nbyte)
    {
        ssize_t sent = 0;
        while (nbyte > 0)
        {
            std::lock_guard<std::mutex> lock(_mutex);
            if (_ssl_connection == nullptr || _ssl_context == nullptr)
            {
                return 0;
            }
            ERR_clear_error();
            ssize_t write_result = SSL_write(_ssl_connection, buf + sent, (int) nbyte);
            int reason = SSL_get_error(_ssl_connection, write_result);
            if (reason == SSL_ERROR_NONE) {
                nbyte -= write_result;
                sent += write_result;
            } else if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE) {
                errno = EWOULDBLOCK;
                return -1;
            } else {
                return -1;
            }
        }
        return sent;
    }
    ssize_t SocketOpenSSL::send(const std::string& buffer)
    {
        return send((char*)&buffer[0], buffer.size());
    }
    // No wait support
    ssize_t SocketOpenSSL::recv(void* buf, size_t nbyte)
    {
        while (true)
        {
            std::lock_guard<std::mutex> lock(_mutex);
            if (_ssl_connection == nullptr || _ssl_context == nullptr)
            {
                return 0;
            }
            ERR_clear_error();
            ssize_t read_result = SSL_read(_ssl_connection, buf, (int) nbyte);
            if (read_result > 0)
            {
                return read_result;
            }
            int reason = SSL_get_error(_ssl_connection, read_result);
            if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
            {
                errno = EWOULDBLOCK;
            }
            return -1;
        }
    }
 }
@@ -0,0 +1,57 @@
 /*
 *  IXSocketOpenSSL.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXSocket.h"
 #include "IXCancellationRequest.h"
 #include <openssl/bio.h>
 #include <openssl/hmac.h>
 #include <openssl/conf.h>
 #include <openssl/err.h>
 #include <openssl/ssl.h>
 #include <mutex>
 namespace ix
 {
    class SocketOpenSSL : public Socket
    {
    public:
        SocketOpenSSL(int fd = -1);
        ~SocketOpenSSL();
        virtual bool connect(const std::string& host,
                             int port,
                             std::string& errMsg,
                             const CancellationRequest& isCancellationRequested) final;
        virtual void close() final;
        virtual ssize_t send(char* buffer, size_t length) final;
        virtual ssize_t send(const std::string& buffer) final;
        virtual ssize_t recv(void* buffer, size_t length) final;
    private:
        void openSSLInitialize();
        std::string getSSLError(int ret);
        SSL_CTX* openSSLCreateContext(std::string& errMsg);
        bool openSSLHandshake(const std::string& hostname, std::string& errMsg);
        bool openSSLCheckServerCert(SSL *ssl,
                                    const std::string& hostname,
                                    std::string& errMsg);
        bool checkHost(const std::string& host, const char *pattern);
        SSL* _ssl_connection;
        SSL_CTX* _ssl_context;
        const SSL_METHOD* _ssl_method;
        mutable std::mutex _mutex;  // OpenSSL routines are not thread-safe
        std::once_flag _openSSLInitFlag;
        static std::atomic<bool> _openSSLInitializationSuccessful;
    };
 }
@@ -0,0 +1,107 @@
 /*
 *  IXSocketSChannel.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 *
 *  See https://docs.microsoft.com/en-us/windows/desktop/WinSock/using-secure-socket-extensions
 *
 *  https://github.com/pauldotknopf/WindowsSDK7-Samples/blob/master/netds/winsock/securesocket/stcpclient/tcpclient.c
 *
 *  This is the right example to look at:
 *  https://www.codeproject.com/Articles/1000189/A-Working-TCP-Client-and-Server-With-SSL
 */
 #include "IXSocketSChannel.h"
 #ifdef _WIN32
 # include <basetsd.h>
 # include <WinSock2.h>
 # include <ws2def.h>
 # include <WS2tcpip.h>
 # include <schannel.h>
 # include <sslsock.h>
 # include <io.h>
 #define WIN32_LEAN_AND_MEAN
 #ifndef UNICODE
 #define UNICODE
 #endif
 #include <windows.h>
 #include <winsock2.h>
 #include <mstcpip.h>
 #include <ws2tcpip.h>
 #include <rpc.h>
 #include <ntdsapi.h>
 #include <stdio.h>
 #include <tchar.h>
 #define RECV_DATA_BUF_SIZE 256
 // Link with ws2_32.lib
 #pragma comment(lib, "Ws2_32.lib")
 // link with fwpuclnt.lib for Winsock secure socket extensions
 #pragma comment(lib, "fwpuclnt.lib")
 // link with ntdsapi.lib for DsMakeSpn function
 #pragma comment(lib, "ntdsapi.lib")
 // The following function assumes that Winsock
 // has already been initialized
 #else
 # error("This file should only be built on Windows")
 #endif
 namespace ix
 {
    SocketSChannel::SocketSChannel()
    {
        ;
    }
    SocketSChannel::~SocketSChannel()
    {
    }
    bool SocketSChannel::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg)
    {
        return Socket::connect(host, port, errMsg);
    }
    void SocketSChannel::secureSocket()
    {
        // there will be a lot to do here ...
    }
    void SocketSChannel::close()
    {
        Socket::close();
    }
    int SocketSChannel::send(char* buf, size_t nbyte)
    {
        return Socket::send(buf, nbyte);
    }
    int SocketSChannel::send(const std::string& buffer)
    {
        return Socket::send(buffer);
    }
    int SocketSChannel::recv(void* buf, size_t nbyte)
    {
        return Socket::recv(buf, nbyte);
    }
 }
@@ -0,0 +1,34 @@
 /*
 *  IXSocketSChannel.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXSocket.h"
 namespace ix
 {
    class SocketSChannel : public Socket
    {
    public:
        SocketSChannel();
        ~SocketSChannel();
        virtual bool connect(const std::string& host,
                             int port,
                             std::string& errMsg) final;
        virtual void close() final;
        // The important override
        virtual void secureSocket() final;
        virtual int send(char* buffer, size_t length) final;
        virtual int send(const std::string& buffer) final;
        virtual int recv(void* buffer, size_t length) final;
    private:
    };
 }
@@ -0,0 +1,228 @@
 /*
 *  IXSocketServer.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXSocketServer.h"
 #include "IXSocket.h"
 #include "IXSocketConnect.h"
 #include "IXNetSystem.h"
 #include <iostream>
 #include <sstream>
 #include <future>
 #include <string.h>
 namespace ix
 {
    const int SocketServer::kDefaultPort(8080);
    const std::string SocketServer::kDefaultHost("127.0.0.1");
    const int SocketServer::kDefaultTcpBacklog(5);
    const size_t SocketServer::kDefaultMaxConnections(32);
    SocketServer::SocketServer(int port,
                               const std::string& host,
                               int backlog,
                               size_t maxConnections) :
        _port(port),
        _host(host),
        _backlog(backlog),
        _maxConnections(maxConnections),
        _stop(false)
    {
    }
    SocketServer::~SocketServer()
    {
        stop();
    }
    void SocketServer::logError(const std::string& str)
    {
        std::lock_guard<std::mutex> lock(_logMutex);
        std::cerr << str << std::endl;
    }
    void SocketServer::logInfo(const std::string& str)
    {
        std::lock_guard<std::mutex> lock(_logMutex);
        std::cout << str << std::endl;
    }
    std::pair<bool, std::string> SocketServer::listen()
    {
        struct sockaddr_in server; // server address information
        // Get a socket for accepting connections.
        if ((_serverFd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
        {
            std::stringstream ss;
            ss << "SocketServer::listen() error creating socket): "
               << strerror(Socket::getErrno());
            return std::make_pair(false, ss.str());
        }
        // Make that socket reusable. (allow restarting this server at will)
        int enable = 1;
        if (setsockopt(_serverFd, SOL_SOCKET, SO_REUSEADDR,
                       (char*) &enable, sizeof(enable)) < 0)
        {
            std::stringstream ss;
            ss << "SocketServer::listen() error calling setsockopt(SO_REUSEADDR) "
               << "at address " << _host << ":" << _port
               << " : " << strerror(Socket::getErrno());
            ::close(_serverFd);
            return std::make_pair(false, ss.str());
        }
        // Bind the socket to the server address.
        server.sin_family = AF_INET;
        server.sin_port   = htons(_port);
        // Using INADDR_ANY trigger a pop-up box as binding to any address is detected
        // by the osx firewall. We need to codesign the binary with a self-signed cert
        // to allow that, but this is a bit of a pain. (this is what node or python would do).
        //
        // Using INADDR_LOOPBACK also does not work ... while it should.
        // We default to 127.0.0.1 (localhost)
        //
        server.sin_addr.s_addr = inet_addr(_host.c_str());
        if (bind(_serverFd, (struct sockaddr *)&server, sizeof(server)) < 0)
        {
            std::stringstream ss;
            ss << "SocketServer::listen() error calling bind "
               << "at address " << _host << ":" << _port
               << " : " << strerror(Socket::getErrno());
            ::close(_serverFd);
            return std::make_pair(false, ss.str());
        }
        //
        // Listen for connections. Specify the tcp backlog.
        //
        if (::listen(_serverFd, _backlog) < 0)
        {
            std::stringstream ss;
            ss << "SocketServer::listen() error calling listen "
               << "at address " << _host << ":" << _port
               << " : " << strerror(Socket::getErrno());
            ::close(_serverFd);
            return std::make_pair(false, ss.str());
        }
        return std::make_pair(true, "");
    }
    void SocketServer::start()
    {
        if (_thread.joinable()) return; // we've already been started
        _thread = std::thread(&SocketServer::run, this);
    }
    void SocketServer::wait()
    {
        std::unique_lock<std::mutex> lock(_conditionVariableMutex);
        _conditionVariable.wait(lock);
    }
    void SocketServer::stop()
    {
        if (!_thread.joinable()) return; // nothing to do
        _stop = true;
        _thread.join();
        _stop = false;
        _conditionVariable.notify_one();
        ::close(_serverFd);
    }
    void SocketServer::run()
    {
        // Set the socket to non blocking mode, so that accept calls are not blocking
        SocketConnect::configure(_serverFd);
        // Return value of std::async, ignored
        std::future<void> f;
        for (;;)
        {
            if (_stop) return;
            // Use select to check whether a new connection is in progress
            fd_set rfds;
            struct timeval timeout;
            timeout.tv_sec = 0;
            timeout.tv_usec = 10 * 1000; // 10ms timeout
            FD_ZERO(&rfds);
            FD_SET(_serverFd, &rfds);
            if (select(_serverFd + 1, &rfds, nullptr, nullptr, &timeout) < 0 &&
                (errno == EBADF || errno == EINVAL))
            {
                std::stringstream ss;
                ss << "SocketServer::run() error in select: "
                   << strerror(Socket::getErrno());
                logError(ss.str());
                continue;
            }
            if (!FD_ISSET(_serverFd, &rfds))
            {
                // We reached the select timeout, and no new connections are pending
                continue;
            }
            // Accept a connection.
            struct sockaddr_in client; // client address information
            int clientFd;              // socket connected to client
            socklen_t addressLen = sizeof(socklen_t);
            memset(&client, 0, sizeof(client));
            if ((clientFd = accept(_serverFd, (struct sockaddr *)&client, &addressLen)) < 0)
            {
                if (Socket::getErrno() != EWOULDBLOCK)
                {
                    // FIXME: that error should be propagated
                    std::stringstream ss;
                    ss << "SocketServer::run() error accepting connection: "
                       << strerror(Socket::getErrno());
                    logError(ss.str());
                }
                continue;
            }
            if (getConnectedClientsCount() >= _maxConnections)
            {
                std::stringstream ss;
                ss << "SocketServer::run() reached max connections = "
                   << _maxConnections << ". "
                   << "Not accepting connection";
                logError(ss.str());
                ::close(clientFd);
                continue;
            }
            // Launch the handleConnection work asynchronously in its own thread.
            //
            // the destructor of a future returned by std::async blocks,
            // so we need to declare it outside of this loop
            f = std::async(std::launch::async,
                           &SocketServer::handleConnection,
                           this,
                           clientFd);
        }
    }
 }
@@ -0,0 +1,68 @@
 /*
 *  IXSocketServer.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <utility> // pair
 #include <string>
 #include <set>
 #include <thread>
 #include <mutex>
 #include <functional>
 #include <memory>
 #include <atomic>
 #include <condition_variable>
 namespace ix
 {
    class SocketServer {
    public:
        SocketServer(int port = SocketServer::kDefaultPort,
                     const std::string& host = SocketServer::kDefaultHost,
                     int backlog = SocketServer::kDefaultTcpBacklog,
                     size_t maxConnections = SocketServer::kDefaultMaxConnections);
        virtual ~SocketServer();
        virtual void stop();
        const static int kDefaultPort;
        const static std::string kDefaultHost;
        const static int kDefaultTcpBacklog;
        const static size_t kDefaultMaxConnections;
        void start();
        std::pair<bool, std::string> listen();
        void wait();
    protected:
        // Logging
        void logError(const std::string& str);
        void logInfo(const std::string& str);
    private:
        // Member variables
        int _port;
        std::string _host;
        int _backlog;
        size_t _maxConnections;
        // socket for accepting connections
        int _serverFd;
        std::mutex _logMutex;
        std::atomic<bool> _stop;
        std::thread _thread;
        std::condition_variable _conditionVariable;
        std::mutex _conditionVariableMutex;
        // Methods
        void run();
        virtual void handleConnection(int fd) = 0;
        virtual size_t getConnectedClientsCount() = 0;
    };
 }
@@ -0,0 +1,104 @@
 /*
 *  IXUrlParser.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXUrlParser.h"
 #include <iostream>
 #include <sstream>
 namespace ix
 {
    //
    // The only difference between those 2 regex is the protocol
    //
    std::regex UrlParser::_httpRegex("(http|https)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
    std::regex UrlParser::_webSocketRegex("(ws|wss)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
    bool UrlParser::parse(const std::string& url,
                          std::string& protocol,
                          std::string& host,
                          std::string& path,
                          std::string& query,
                          int& port,
                          bool websocket)
    {
        std::cmatch what;
        if (!regex_match(url.c_str(), what,
                         websocket ? _webSocketRegex : _httpRegex))
        {
            return false;
        }
        std::string portStr;
        protocol = std::string(what[1].first, what[1].second);
        host     = std::string(what[2].first, what[2].second);
        portStr  = std::string(what[3].first, what[3].second);
        path     = std::string(what[4].first, what[4].second);
        query    = std::string(what[5].first, what[5].second);
        if (portStr.empty())
        {
            if (protocol == "ws" || protocol == "http")
            {
                port = 80;
            }
            else if (protocol == "wss" || protocol == "https")
            {
                port = 443;
            }
            else
            {
                // Invalid protocol. Should be caught by regex check
                // but this missing branch trigger cpplint linter.
                return false;
            }
        }
        else
        {
            std::stringstream ss;
            ss << portStr;
            ss >> port;
        }
        if (path.empty())
        {
            path = "/";
        }
        else if (path[0] != '/')
        {
            path = '/' + path;
        }
        if (!query.empty())
        {
            path += "?";
            path += query;
        }
        return true;
    }
    void UrlParser::printUrl(const std::string& url, bool websocket)
    {
        std::string protocol, host, path, query;
        int port {0};
        if (!parse(url, protocol, host, path, query, port, websocket))
        {
            return;
        }
        std::cout << "[" << url << "]" << std::endl;
        std::cout << protocol << std::endl;
        std::cout << host << std::endl;
        std::cout << port << std::endl;
        std::cout << path << std::endl;
        std::cout << query << std::endl;
        std::cout << "-------------------------------" << std::endl;
    }
 }
@@ -0,0 +1,31 @@
 /*
 *  IXUrlParser.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <string>
 #include <regex>
 namespace ix
 {
    class UrlParser
    {
    public:
        static bool parse(const std::string& url,
                          std::string& protocol,
                          std::string& host,
                          std::string& path,
                          std::string& query,
                          int& port,
                          bool websocket);
        static void printUrl(const std::string& url, bool websocket);
    private:
        static std::regex _httpRegex;
        static std::regex _webSocketRegex;
    };
 }
@@ -0,0 +1,377 @@
 /*
 *  IXWebSocket.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocket.h"
 #include "IXSetThreadName.h"
 #include "IXWebSocketHandshake.h"
 #include <iostream>
 #include <cmath>
 #include <cassert>
 namespace
 {
    uint64_t calculateRetryWaitMilliseconds(uint64_t retry_count)
    {
        // This will overflow quite fast for large value of retry_count
        // and will become 0, in which case the wait time will be none
        // and we'll be constantly retrying to connect.
        uint64_t wait_time = ((uint64_t) std::pow(2, retry_count) * 100L);
        // cap the wait time to 10s, or to retry_count == 10 for which wait_time > 10s
        uint64_t tenSeconds = 10 * 1000;
        return (wait_time > tenSeconds || retry_count > 10) ? tenSeconds : wait_time;
    }
 }
 namespace ix
 {
    OnTrafficTrackerCallback WebSocket::_onTrafficTrackerCallback = nullptr;
    const int WebSocket::kDefaultHandShakeTimeoutSecs(60);
    const int WebSocket::kDefaultHeartBeatPeriod(-1);
    WebSocket::WebSocket() :
        _onMessageCallback(OnMessageCallback()),
        _stop(false),
        _automaticReconnection(true),
        _handshakeTimeoutSecs(kDefaultHandShakeTimeoutSecs),
        _heartBeatPeriod(kDefaultHeartBeatPeriod)
    {
        _ws.setOnCloseCallback(
            [this](uint16_t code, const std::string& reason, size_t wireSize)
            {
                _onMessageCallback(WebSocket_MessageType_Close, "", wireSize,
                                   WebSocketErrorInfo(), WebSocketOpenInfo(),
                                   WebSocketCloseInfo(code, reason));
            }
        );
    }
    WebSocket::~WebSocket()
    {
        stop();
    }
    void WebSocket::setUrl(const std::string& url)
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        _url = url;
    }
    const std::string& WebSocket::getUrl() const
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        return _url;
    }
    void WebSocket::setPerMessageDeflateOptions(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions)
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        _perMessageDeflateOptions = perMessageDeflateOptions;
    }
    const WebSocketPerMessageDeflateOptions& WebSocket::getPerMessageDeflateOptions() const
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        return _perMessageDeflateOptions;
    }
    void WebSocket::setHeartBeatPeriod(int hearBeatPeriod)
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        _heartBeatPeriod = hearBeatPeriod;
    }
    int WebSocket::getHeartBeatPeriod() const
    {
        std::lock_guard<std::mutex> lock(_configMutex);
        return _heartBeatPeriod;
    }
    void WebSocket::start()
    {
        if (_thread.joinable()) return; // we've already been started
        _thread = std::thread(&WebSocket::run, this);
    }
    void WebSocket::stop()
    {
        bool automaticReconnection = _automaticReconnection;
        // This value needs to be forced when shutting down, it is restored later
        _automaticReconnection = false;
        close();
        if (!_thread.joinable())
        {
            _automaticReconnection = automaticReconnection;
            return;
        }
        _stop = true;
        _thread.join();
        _stop = false;
        _automaticReconnection = automaticReconnection;
    }
    WebSocketInitResult WebSocket::connect(int timeoutSecs)
    {
        {
            std::lock_guard<std::mutex> lock(_configMutex);
            _ws.configure(_perMessageDeflateOptions,
                          _heartBeatPeriod);
        }
        WebSocketInitResult status = _ws.connectToUrl(_url, timeoutSecs);
        if (!status.success)
        {
            return status;
        }
        _onMessageCallback(WebSocket_MessageType_Open, "", 0,
                           WebSocketErrorInfo(),
                           WebSocketOpenInfo(status.uri, status.headers),
                           WebSocketCloseInfo());
        return status;
    }
    WebSocketInitResult WebSocket::connectToSocket(int fd, int timeoutSecs)
    {
        {
            std::lock_guard<std::mutex> lock(_configMutex);
            _ws.configure(_perMessageDeflateOptions, _heartBeatPeriod);
        }
        WebSocketInitResult status = _ws.connectToSocket(fd, timeoutSecs);
        if (!status.success)
        {
            return status;
        }
        _onMessageCallback(WebSocket_MessageType_Open, "", 0,
                           WebSocketErrorInfo(),
                           WebSocketOpenInfo(status.uri, status.headers),
                           WebSocketCloseInfo());
        return status;
    }
    bool WebSocket::isConnected() const
    {
        return getReadyState() == WebSocket_ReadyState_Open;
    }
    bool WebSocket::isClosing() const
    {
        return getReadyState() == WebSocket_ReadyState_Closing;
    }
    void WebSocket::close()
    {
        _ws.close();
    }
    void WebSocket::reconnectPerpetuallyIfDisconnected()
    {
        uint64_t retries = 0;
        WebSocketErrorInfo connectErr;
        ix::WebSocketInitResult status;
        using millis = std::chrono::duration<double, std::milli>;
        millis duration;
        while (true)
        {
            if (isConnected() || isClosing() || _stop || !_automaticReconnection)
            {
                break;
            }
            status = connect(_handshakeTimeoutSecs);
            if (!status.success && !_stop)
            {
                duration = millis(calculateRetryWaitMilliseconds(retries++));
                connectErr.retries = retries;
                connectErr.wait_time = duration.count();
                connectErr.reason = status.errorStr;
                connectErr.http_status = status.http_status;
                _onMessageCallback(WebSocket_MessageType_Error, "", 0,
                                   connectErr, WebSocketOpenInfo(),
                                   WebSocketCloseInfo());
                std::this_thread::sleep_for(duration);
            }
        }
    }
    void WebSocket::run()
    {
        setThreadName(_url);
        while (true)
        {
            if (_stop) return;
            // 1. Make sure we are always connected
            reconnectPerpetuallyIfDisconnected();
            if (_stop) return;
            // 2. Poll to see if there's any new data available
            _ws.poll();
            if (_stop) return;
            // 3. Dispatch the incoming messages
            _ws.dispatch(
                [this](const std::string& msg,
                       size_t wireSize,
                       bool decompressionError,
                       WebSocketTransport::MessageKind messageKind)
                {
                    WebSocketMessageType webSocketMessageType;
                    switch (messageKind)
                    {
                        case WebSocketTransport::MSG:
                        {
                            webSocketMessageType = WebSocket_MessageType_Message;
                        } break;
                        case WebSocketTransport::PING:
                        {
                            webSocketMessageType = WebSocket_MessageType_Ping;
                        } break;
                        case WebSocketTransport::PONG:
                        {
                            webSocketMessageType = WebSocket_MessageType_Pong;
                        } break;
                    }
                    WebSocketErrorInfo webSocketErrorInfo;
                    webSocketErrorInfo.decompressionError = decompressionError;
                    _onMessageCallback(webSocketMessageType, msg, wireSize,
                                       webSocketErrorInfo, WebSocketOpenInfo(),
                                       WebSocketCloseInfo());
                    WebSocket::invokeTrafficTrackerCallback(msg.size(), true);
                });
            // 4. In blocking mode, getting out of this function is triggered by
            //    an explicit disconnection from the callback, or by the remote end
            //    closing the connection, ie isConnected() == false.
            if (!_thread.joinable() && !isConnected() && !_automaticReconnection) return;
        }
    }
    void WebSocket::setOnMessageCallback(const OnMessageCallback& callback)
    {
        _onMessageCallback = callback;
    }
    void WebSocket::setTrafficTrackerCallback(const OnTrafficTrackerCallback& callback)
    {
        _onTrafficTrackerCallback = callback;
    }
    void WebSocket::resetTrafficTrackerCallback()
    {
        setTrafficTrackerCallback(nullptr);
    }
    void WebSocket::invokeTrafficTrackerCallback(size_t size, bool incoming)
    {
        if (_onTrafficTrackerCallback)
        {
            _onTrafficTrackerCallback(size, incoming);
        }
    }
    WebSocketSendInfo WebSocket::send(const std::string& text,
                                      const OnProgressCallback& onProgressCallback)
    {
        return sendMessage(text, false, onProgressCallback);
    }
    WebSocketSendInfo WebSocket::ping(const std::string& text)
    {
        // Standard limit ping message size
        constexpr size_t pingMaxPayloadSize = 125;
        if (text.size() > pingMaxPayloadSize) return WebSocketSendInfo(false);
        return sendMessage(text, true);
    }
    WebSocketSendInfo WebSocket::sendMessage(const std::string& text,
                                             bool ping,
                                             const OnProgressCallback& onProgressCallback)
    {
        if (!isConnected()) return WebSocketSendInfo(false);
        //
        // It is OK to read and write on the same socket in 2 different threads.
        // https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid
        //
        // This makes it so that messages are sent right away, and we dont need
        // a timeout while we poll to keep wake ups to a minimum (which helps
        // with battery life), and use the system select call to notify us when
        // incoming messages are arriving / there's data to be received.
        //
        std::lock_guard<std::mutex> lock(_writeMutex);
        WebSocketSendInfo webSocketSendInfo;
        if (ping)
        {
            webSocketSendInfo = _ws.sendPing(text);
        }
        else
        {
            webSocketSendInfo = _ws.sendBinary(text, onProgressCallback);
        }
        WebSocket::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize, false);
        return webSocketSendInfo;
    }
    ReadyState WebSocket::getReadyState() const
    {
        switch (_ws.getReadyState())
        {
            case ix::WebSocketTransport::OPEN: return WebSocket_ReadyState_Open;
            case ix::WebSocketTransport::CONNECTING: return WebSocket_ReadyState_Connecting;
            case ix::WebSocketTransport::CLOSING: return WebSocket_ReadyState_Closing;
            case ix::WebSocketTransport::CLOSED: return WebSocket_ReadyState_Closed;
            default: return WebSocket_ReadyState_Closed;
        }
    }
    std::string WebSocket::readyStateToString(ReadyState readyState)
    {
        switch (readyState)
        {
            case WebSocket_ReadyState_Open: return "OPEN";
            case WebSocket_ReadyState_Connecting: return "CONNECTING";
            case WebSocket_ReadyState_Closing: return "CLOSING";
            case WebSocket_ReadyState_Closed: return "CLOSED";
            default: return "CLOSED";
        }
    }
    void WebSocket::enableAutomaticReconnection()
    {
        _automaticReconnection = true;
    }
    void WebSocket::disableAutomaticReconnection()
    {
        _automaticReconnection = false;
    }
 }
@@ -0,0 +1,157 @@
 /*
 *  IXWebSocket.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 *
 *  WebSocket RFC
 *  https://tools.ietf.org/html/rfc6455
 */
 #pragma once
 #include <string>
 #include <thread>
 #include <mutex>
 #include <atomic>
 #include "IXWebSocketTransport.h"
 #include "IXWebSocketErrorInfo.h"
 #include "IXWebSocketSendInfo.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXProgressCallback.h"
 namespace ix
 {
    // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#Ready_state_constants
    enum ReadyState
    {
        WebSocket_ReadyState_Connecting = 0,
        WebSocket_ReadyState_Open = 1,
        WebSocket_ReadyState_Closing = 2,
        WebSocket_ReadyState_Closed = 3
    };
    enum WebSocketMessageType
    {
        WebSocket_MessageType_Message = 0,
        WebSocket_MessageType_Open = 1,
        WebSocket_MessageType_Close = 2,
        WebSocket_MessageType_Error = 3,
        WebSocket_MessageType_Ping = 4,
        WebSocket_MessageType_Pong = 5
    };
    struct WebSocketOpenInfo
    {
        std::string uri;
        WebSocketHttpHeaders headers;
        WebSocketOpenInfo(const std::string& u = std::string(),
                          const WebSocketHttpHeaders& h = WebSocketHttpHeaders())
            : uri(u)
            , headers(h)
        {
            ;
        }
    };
    struct WebSocketCloseInfo
    {
        uint16_t code;
        std::string reason;
        WebSocketCloseInfo(uint16_t c = 0,
                           const std::string& r = std::string())
            : code(c)
            , reason(r)
        {
            ;
        }
    };
    using OnMessageCallback = std::function<void(WebSocketMessageType,
                                                 const std::string&,
                                                 size_t wireSize,
                                                 const WebSocketErrorInfo&,
                                                 const WebSocketOpenInfo&,
                                                 const WebSocketCloseInfo&)>;
    using OnTrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
    class WebSocket
    {
    public:
        WebSocket();
        ~WebSocket();
        void setUrl(const std::string& url);
        void setPerMessageDeflateOptions(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
        void setHandshakeTimeout(int handshakeTimeoutSecs);
        void setHeartBeatPeriod(int hearBeatPeriod);
        // Run asynchronously, by calling start and stop.
        void start();
        void stop();
        // Run in blocking mode, by connecting first manually, and then calling run.
        WebSocketInitResult connect(int timeoutSecs);
        void run();
        WebSocketSendInfo send(const std::string& text,
                               const OnProgressCallback& onProgressCallback = nullptr);
        WebSocketSendInfo ping(const std::string& text);
        void close();
        void setOnMessageCallback(const OnMessageCallback& callback);
        static void setTrafficTrackerCallback(const OnTrafficTrackerCallback& callback);
        static void resetTrafficTrackerCallback();
        ReadyState getReadyState() const;
        const std::string& getUrl() const;
        const WebSocketPerMessageDeflateOptions& getPerMessageDeflateOptions() const;
        int getHeartBeatPeriod() const;
        void enableAutomaticReconnection();
        void disableAutomaticReconnection();
    private:
        WebSocketSendInfo sendMessage(const std::string& text,
                                      bool ping,
                                      const OnProgressCallback& callback = nullptr);
        bool isConnected() const;
        bool isClosing() const;
        void reconnectPerpetuallyIfDisconnected();
        std::string readyStateToString(ReadyState readyState);
        static void invokeTrafficTrackerCallback(size_t size, bool incoming);
        // Server
        void setSocketFileDescriptor(int fd);
        WebSocketInitResult connectToSocket(int fd, int timeoutSecs);
        WebSocketTransport _ws;
        std::string _url;
        WebSocketPerMessageDeflateOptions _perMessageDeflateOptions;
        mutable std::mutex _configMutex; // protect all config variables access
        OnMessageCallback _onMessageCallback;
        static OnTrafficTrackerCallback _onTrafficTrackerCallback;
        std::atomic<bool> _stop;
        std::atomic<bool> _automaticReconnection;
        std::thread _thread;
        std::mutex _writeMutex;
        std::atomic<int> _handshakeTimeoutSecs;
        static const int kDefaultHandShakeTimeoutSecs;
        // Optional Heartbeat
        int _heartBeatPeriod;
        static const int kDefaultHeartBeatPeriod;
        friend class WebSocketServer;
    };
 }
@@ -0,0 +1,21 @@
 /*
 *  IXWebSocketErrorInfo.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <string>
 namespace ix
 {
    struct WebSocketErrorInfo
    {
        uint64_t retries;
        double wait_time;
        int http_status;
        std::string reason;
        bool decompressionError;
    };
 }
@@ -0,0 +1,387 @@
 /*
 *  IXWebSocketHandshake.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocketHandshake.h"
 #include "IXSocketConnect.h"
 #include "IXUrlParser.h"
 #include "libwshandshake.hpp"
 #include <iostream>
 #include <sstream>
 #include <regex>
 #include <random>
 #include <algorithm>
 namespace ix
 {
    WebSocketHandshake::WebSocketHandshake(std::atomic<bool>& requestInitCancellation,
                                           std::shared_ptr<Socket> socket,
                                           WebSocketPerMessageDeflate& perMessageDeflate,
                                           WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
                                           std::atomic<bool>& enablePerMessageDeflate) :
        _requestInitCancellation(requestInitCancellation),
        _socket(socket),
        _perMessageDeflate(perMessageDeflate),
        _perMessageDeflateOptions(perMessageDeflateOptions),
        _enablePerMessageDeflate(enablePerMessageDeflate)
    {
    }
    std::string WebSocketHandshake::trim(const std::string& str)
    {
        std::string out(str);
        out.erase(std::remove(out.begin(), out.end(), ' '), out.end());
        out.erase(std::remove(out.begin(), out.end(), '\r'), out.end());
        out.erase(std::remove(out.begin(), out.end(), '\n'), out.end());
        return out;
    }
    bool WebSocketHandshake::insensitiveStringCompare(const std::string& a, const std::string& b)
    {
        return std::equal(a.begin(), a.end(),
                          b.begin(), b.end(),
                          [](char a, char b)
                          {
                              return tolower(a) == tolower(b);
                          });
    }
    std::tuple<std::string, std::string, std::string> WebSocketHandshake::parseRequestLine(const std::string& line)
    {
        // Request-Line   = Method SP Request-URI SP HTTP-Version CRLF
        std::string token;
        std::stringstream tokenStream(line);
        std::vector<std::string> tokens;
        // Split by ' '
        while (std::getline(tokenStream, token, ' '))
        {
            tokens.push_back(token);
        }
        std::string method;
        if (tokens.size() >= 1)
        {
            method = trim(tokens[0]);
        }
        std::string requestUri;
        if (tokens.size() >= 2)
        {
            requestUri = trim(tokens[1]);
        }
        std::string httpVersion;
        if (tokens.size() >= 3)
        {
            httpVersion = trim(tokens[2]);
        }
        return std::make_tuple(method, requestUri, httpVersion);
    }
    std::string WebSocketHandshake::genRandomString(const int len)
    {
        std::string alphanum =
            "0123456789"
            "ABCDEFGH"
            "abcdefgh";
        std::random_device r;
        std::default_random_engine e1(r());
        std::uniform_int_distribution<int> dist(0, (int) alphanum.size() - 1);
        std::string s;
        s.resize(len);
        for (int i = 0; i < len; ++i)
        {
            int x = dist(e1);
            s[i] = alphanum[x];
        }
        return s;
    }
    WebSocketInitResult WebSocketHandshake::sendErrorResponse(int code, const std::string& reason)
    {
        std::stringstream ss;
        ss << "HTTP/1.1 ";
        ss << code;
        ss << "\r\n";
        ss << reason;
        ss << "\r\n";
        // Socket write can only be cancelled through a timeout here, not manually.
        static std::atomic<bool> requestInitCancellation(false);
        auto isCancellationRequested =
            makeCancellationRequestWithTimeout(1, requestInitCancellation);
        if (!_socket->writeBytes(ss.str(), isCancellationRequested))
        {
            return WebSocketInitResult(false, 500, "Timed out while sending error response");
        }
        return WebSocketInitResult(false, code, reason);
    }
    WebSocketInitResult WebSocketHandshake::clientHandshake(const std::string& url,
                                                            const std::string& host,
                                                            const std::string& path,
                                                            int port,
                                                            int timeoutSecs)
    {
        _requestInitCancellation = false;
        auto isCancellationRequested =
            makeCancellationRequestWithTimeout(timeoutSecs, _requestInitCancellation);
        std::string errMsg;
        bool success = _socket->connect(host, port, errMsg, isCancellationRequested);
        if (!success)
        {
            std::stringstream ss;
            ss << "Unable to connect to " << host
               << " on port " << port
               << ", error: " << errMsg;
            return WebSocketInitResult(false, 0, ss.str());
        }
        //
        // Generate a random 24 bytes string which looks like it is base64 encoded
        // y3JJHMbDL1EzLkh9GBhXDw==
        // 0cb3Vd9HkbpVVumoS3Noka==
        //
        // See https://stackoverflow.com/questions/18265128/what-is-sec-websocket-key-for
        //
        std::string secWebSocketKey = genRandomString(22);
        secWebSocketKey += "==";
        std::stringstream ss;
        ss << "GET " << path << " HTTP/1.1\r\n";
        ss << "Host: "<< host << ":" << port << "\r\n";
        ss << "Upgrade: websocket\r\n";
        ss << "Connection: Upgrade\r\n";
        ss << "Sec-WebSocket-Version: 13\r\n";
        ss << "Sec-WebSocket-Key: " << secWebSocketKey << "\r\n";
        if (_enablePerMessageDeflate)
        {
            ss << _perMessageDeflateOptions.generateHeader();
        }
        ss << "\r\n";
        if (!_socket->writeBytes(ss.str(), isCancellationRequested))
        {
            return WebSocketInitResult(false, 0, std::string("Failed sending GET request to ") + url);
        }
        // Read HTTP status line
        auto lineResult = _socket->readLine(isCancellationRequested);
        auto lineValid = lineResult.first;
        auto line = lineResult.second;
        if (!lineValid)
        {
            return WebSocketInitResult(false, 0,
                                       std::string("Failed reading HTTP status line from ") + url);
        }
        // Validate status
        int status;
        // HTTP/1.0 is too old.
        if (sscanf(line.c_str(), "HTTP/1.0 %d", &status) == 1)
        {
            std::stringstream ss;
            ss << "Server version is HTTP/1.0. Rejecting connection to " << host
               << ", status: " << status
               << ", HTTP Status line: " << line;
            return WebSocketInitResult(false, status, ss.str());
        }
        // We want an 101 HTTP status
        if (sscanf(line.c_str(), "HTTP/1.1 %d", &status) != 1 || status != 101)
        {
            std::stringstream ss;
            ss << "Got bad status connecting to " << host
               << ", status: " << status
               << ", HTTP Status line: " << line;
            return WebSocketInitResult(false, status, ss.str());
        }
        auto result = parseHttpHeaders(_socket, isCancellationRequested);
        auto headersValid = result.first;
        auto headers = result.second;
        if (!headersValid)
        {
            return WebSocketInitResult(false, status, "Error parsing HTTP headers");
        }
        // Check the presence of the connection field
        if (headers.find("connection") == headers.end())
        {
            std::string errorMsg("Missing connection value");
            return WebSocketInitResult(false, status, errorMsg);
        }
        // Check the value of the connection field
        // Some websocket servers (Go/Gorilla?) send lowercase values for the
        // connection header, so do a case insensitive comparison
        if (!insensitiveStringCompare(headers["connection"], "Upgrade"))
        {
            std::stringstream ss;
            ss << "Invalid connection value: " << headers["connection"];
            return WebSocketInitResult(false, status, ss.str());
        }
        char output[29] = {};
        WebSocketHandshakeKeyGen::generate(secWebSocketKey.c_str(), output);
        if (std::string(output) != headers["sec-websocket-accept"])
        {
            std::string errorMsg("Invalid Sec-WebSocket-Accept value");
            return WebSocketInitResult(false, status, errorMsg);
        }
        if (_enablePerMessageDeflate)
        {
            // Parse the server response. Does it support deflate ?
            std::string header = headers["sec-websocket-extensions"];
            WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(header);
            // If the server does not support that extension, disable it.
            if (!webSocketPerMessageDeflateOptions.enabled())
            {
                _enablePerMessageDeflate = false;
            }
            // Otherwise try to initialize the deflate engine (zlib)
            else if (!_perMessageDeflate.init(webSocketPerMessageDeflateOptions))
            {
                return WebSocketInitResult(
                    false, 0,"Failed to initialize per message deflate engine");
            }
        }
        return WebSocketInitResult(true, status, "", headers, path);
    }
    WebSocketInitResult WebSocketHandshake::serverHandshake(int fd, int timeoutSecs)
    {
        _requestInitCancellation = false;
        // Set the socket to non blocking mode + other tweaks
        SocketConnect::configure(fd);
        auto isCancellationRequested =
            makeCancellationRequestWithTimeout(timeoutSecs, _requestInitCancellation);
        std::string remote = std::string("remote fd ") + std::to_string(fd);
        // Read first line
        auto lineResult = _socket->readLine(isCancellationRequested);
        auto lineValid = lineResult.first;
        auto line = lineResult.second;
        if (!lineValid)
        {
            return sendErrorResponse(400, "Error reading HTTP request line");
        }
        // Validate request line (GET /foo HTTP/1.1\r\n)
        auto requestLine = parseRequestLine(line);
        auto method      = std::get<0>(requestLine);
        auto uri         = std::get<1>(requestLine);
        auto httpVersion = std::get<2>(requestLine);
        if (method != "GET")
        {
            return sendErrorResponse(400, "Invalid HTTP method, need GET, got " + method);
        }
        if (httpVersion != "HTTP/1.1")
        {
            return sendErrorResponse(400, "Invalid HTTP version, need HTTP/1.1, got: " + httpVersion);
        }
        // Retrieve and validate HTTP headers
        auto result = parseHttpHeaders(_socket, isCancellationRequested);
        auto headersValid = result.first;
        auto headers = result.second;
        if (!headersValid)
        {
            return sendErrorResponse(400, "Error parsing HTTP headers");
        }
        if (headers.find("sec-websocket-key") == headers.end())
        {
            return sendErrorResponse(400, "Missing Sec-WebSocket-Key value");
        }
        if (headers["upgrade"] != "websocket")
        {
            return sendErrorResponse(400, "Invalid or missing Upgrade header");
        }
        if (headers.find("sec-websocket-version") == headers.end())
        {
            return sendErrorResponse(400, "Missing Sec-WebSocket-Version value");
        }
        {
            std::stringstream ss;
            ss << headers["sec-websocket-version"];
            int version;
            ss >> version;
            if (version != 13)
            {
                return sendErrorResponse(400, "Invalid Sec-WebSocket-Version, "
                                              "need 13, got" + ss.str());
            }
        }
        char output[29] = {};
        WebSocketHandshakeKeyGen::generate(headers["sec-websocket-key"].c_str(), output);
        std::stringstream ss;
        ss << "HTTP/1.1 101\r\n";
        ss << "Sec-WebSocket-Accept: " << std::string(output) << "\r\n";
        ss << "Upgrade: websocket\r\n";
        ss << "Connection: Upgrade\r\n";
        // Parse the client headers. Does it support deflate ?
        std::string header = headers["sec-websocket-extensions"];
        WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(header);
        // If the client has requested that extension, enable it.
        if (webSocketPerMessageDeflateOptions.enabled())
        {
            _enablePerMessageDeflate = true;
            if (!_perMessageDeflate.init(webSocketPerMessageDeflateOptions))
            {
                return WebSocketInitResult(
                    false, 0,"Failed to initialize per message deflate engine");
            }
            ss << webSocketPerMessageDeflateOptions.generateHeader();
        }
        ss << "\r\n";
        if (!_socket->writeBytes(ss.str(), isCancellationRequested))
        {
            return WebSocketInitResult(false, 0, std::string("Failed sending response to ") + remote);
        }
        return WebSocketInitResult(true, 200, "", headers, uri);
    }
 }
@@ -0,0 +1,78 @@
 /*
 *  IXWebSocketHandshake.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXCancellationRequest.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXWebSocketPerMessageDeflate.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include "IXSocket.h"
 #include <string>
 #include <atomic>
 #include <chrono>
 #include <memory>
 #include <tuple>
 namespace ix
 {
    struct WebSocketInitResult
    {
        bool success;
        int http_status;
        std::string errorStr;
        WebSocketHttpHeaders headers;
        std::string uri;
        WebSocketInitResult(bool s = false,
                            int status = 0,
                            const std::string& e = std::string(),
                            WebSocketHttpHeaders h = WebSocketHttpHeaders(),
                            const std::string& u = std::string())
        {
            success = s;
            http_status = status;
            errorStr = e;
            headers = h;
            uri = u;
        }
    };
    class WebSocketHandshake {
    public:
        WebSocketHandshake(std::atomic<bool>& requestInitCancellation,
                           std::shared_ptr<Socket> _socket,
                           WebSocketPerMessageDeflate& perMessageDeflate,
                           WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
                           std::atomic<bool>& enablePerMessageDeflate);
        WebSocketInitResult clientHandshake(const std::string& url,
                                            const std::string& host,
                                            const std::string& path,
                                            int port,
                                            int timeoutSecs);
        WebSocketInitResult serverHandshake(int fd,
                                            int timeoutSecs);
    private:
        std::string genRandomString(const int len);
        // Parse HTTP headers
        WebSocketInitResult sendErrorResponse(int code, const std::string& reason);
        std::tuple<std::string, std::string, std::string> parseRequestLine(const std::string& line);
        std::string trim(const std::string& str);
        bool insensitiveStringCompare(const std::string& a, const std::string& b);
        std::atomic<bool>& _requestInitCancellation;
        std::shared_ptr<Socket> _socket;
        WebSocketPerMessageDeflate& _perMessageDeflate;
        WebSocketPerMessageDeflateOptions& _perMessageDeflateOptions;
        std::atomic<bool>& _enablePerMessageDeflate;
    };
 }
@@ -0,0 +1,66 @@
 /*
 *  IXWebSocketHttpHeaders.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocketHttpHeaders.h"
 #include "IXSocket.h"
 #include <string>
 #include <unordered_map>
 namespace ix
 {
    std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
        std::shared_ptr<Socket> socket,
        const CancellationRequest& isCancellationRequested)
    {
        WebSocketHttpHeaders headers;
        char line[1024];
        int i;
        while (true)
        {
            int colon = 0;
            for (i = 0;
                 i < 2 || (i < 1023 && line[i-2] != '\r' && line[i-1] != '\n');
                 ++i)
            {
                if (!socket->readByte(line+i, isCancellationRequested))
                {
                    return std::make_pair(false, headers);
                }
                if (line[i] == ':' && colon == 0)
                {
                    colon = i;
                }
            }
            if (line[0] == '\r' && line[1] == '\n')
            {
                break;
            }
            // line is a single header entry. split by ':', and add it to our
            // header map. ignore lines with no colon.
            if (colon > 0)
            {
                line[i] = '\0';
                std::string lineStr(line);
                // colon is ':', colon+1 is ' ', colon+2 is the start of the value.
                // i is end of string (\0), i-colon is length of string minus key;
                // subtract 1 for '\0', 1 for '\n', 1 for '\r',
                // 1 for the ' ' after the ':', and total is -4
                std::string name(lineStr.substr(0, colon));
                std::string value(lineStr.substr(colon + 2, i - colon - 4));
                headers[name] = value;
            }
        }
        return std::make_pair(true, headers);
    }
 }
@@ -0,0 +1,45 @@
 /*
 *  IXWebSocketHttpHeaders.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXCancellationRequest.h"
 #include <string>
 #include <map>
 #include <memory>
 #include <algorithm>
 namespace ix
 {
    class Socket;
    struct CaseInsensitiveLess
    {
        // Case Insensitive compare_less binary function
        struct NocaseCompare
        {
            bool operator() (const unsigned char& c1, const unsigned char& c2) const
            {
                return std::tolower(c1) < std::tolower(c2);
            }
        };
        bool operator() (const std::string & s1, const std::string & s2) const
        {
            return std::lexicographical_compare
                (s1.begin(), s1.end(),   // source range
                 s2.begin(), s2.end(),   // dest range
                 NocaseCompare());  // comparison
        }
    };
    using WebSocketHttpHeaders = std::map<std::string, std::string, CaseInsensitiveLess>;
    std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
        std::shared_ptr<Socket> socket,
        const CancellationRequest& isCancellationRequested);
 }
@@ -0,0 +1,90 @@
 /*
 * Copyright (c) 2015, Peter Thorson. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the WebSocket++ Project 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 PETER THORSON 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.
 */
 /*
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 *
 *  Adapted from websocketpp/extensions/permessage_deflate/enabled.hpp
 *  (same license as MZ: https://opensource.org/licenses/BSD-3-Clause)
 *
 *  - Reused zlib compression + decompression bits.
 *  - Refactored to have 2 class for compression and decompression, to allow multi-threading
 *    and make sure that _compressBuffer is not shared between threads.
 *  - Original code wasn't working for some reason, I had to add checks
 *    for the presence of the kEmptyUncompressedBlock at the end of buffer so that servers
 *    would start accepting receiving/decoding compressed messages. Original code was probably
 *    modifying the passed in buffers before processing in enabled.hpp ?
 *  - Added more documentation.
 *
 *  Per message Deflate RFC: https://tools.ietf.org/html/rfc7692
 *  Chrome websocket -> https://github.com/chromium/chromium/tree/2ca8c5037021c9d2ecc00b787d58a31ed8fc8bcb/net/websockets
 *
 */
 #include "IXWebSocketPerMessageDeflate.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include "IXWebSocketPerMessageDeflateCodec.h"
 namespace ix
 {
    WebSocketPerMessageDeflate::WebSocketPerMessageDeflate() :
        _compressor(std::make_unique<WebSocketPerMessageDeflateCompressor>()),
        _decompressor(std::make_unique<WebSocketPerMessageDeflateDecompressor>())
    {
        ;
    }
    WebSocketPerMessageDeflate::~WebSocketPerMessageDeflate()
    {
        ;
    }
    bool WebSocketPerMessageDeflate::init(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions)
    {
        bool clientNoContextTakeover =
            perMessageDeflateOptions.getClientNoContextTakeover();
        uint8_t deflateBits = perMessageDeflateOptions.getClientMaxWindowBits();
        uint8_t inflateBits = perMessageDeflateOptions.getServerMaxWindowBits();
        return _compressor->init(deflateBits, clientNoContextTakeover) &&
               _decompressor->init(inflateBits, clientNoContextTakeover);
    }
    bool WebSocketPerMessageDeflate::compress(const std::string& in,
                                              std::string& out)
    {
        return _compressor->compress(in, out);
    }
    bool WebSocketPerMessageDeflate::decompress(const std::string& in,
                                                std::string &out)
    {
        return _decompressor->decompress(in, out);
    }
 }
@@ -0,0 +1,60 @@
 /*
 * Copyright (c) 2015, Peter Thorson. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the WebSocket++ Project 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 PETER THORSON 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.
 */
 /*
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 *
 *  Adapted from websocketpp/extensions/permessage_deflate/enabled.hpp
 *  (same license as MZ: https://opensource.org/licenses/BSD-3-Clause)
 */
 #pragma once
 #include <string>
 #include <memory>
 namespace ix
 {
    class WebSocketPerMessageDeflateOptions;
    class WebSocketPerMessageDeflateCompressor;
    class WebSocketPerMessageDeflateDecompressor;
    class WebSocketPerMessageDeflate
    {
    public:
        WebSocketPerMessageDeflate();
        ~WebSocketPerMessageDeflate();
        bool init(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
        bool compress(const std::string& in, std::string& out);
        bool decompress(const std::string& in, std::string& out);
    private:
        std::unique_ptr<WebSocketPerMessageDeflateCompressor> _compressor;
        std::unique_ptr<WebSocketPerMessageDeflateDecompressor> _decompressor;
    };
 }
@@ -0,0 +1,206 @@
 /*
 *  IXWebSocketPerMessageDeflateCodec.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocketPerMessageDeflateCodec.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include <iostream>
 #include <cassert>
 #include <string.h>
 namespace
 {
    // The passed in size (4) is important, without it the string litteral
    // is treated as a char* and the null termination (\x00) makes it
    // look like an empty string.
    const std::string kEmptyUncompressedBlock = std::string("\x00\x00\xff\xff", 4);
    const int kBufferSize = 1 << 14;
 }
 namespace ix
 {
    //
    // Compressor
    //
    WebSocketPerMessageDeflateCompressor::WebSocketPerMessageDeflateCompressor()
      : _compressBufferSize(kBufferSize)
    {
        memset(&_deflateState, 0, sizeof(_deflateState));
        _deflateState.zalloc = Z_NULL;
        _deflateState.zfree = Z_NULL;
        _deflateState.opaque = Z_NULL;
    }
    WebSocketPerMessageDeflateCompressor::~WebSocketPerMessageDeflateCompressor()
    {
        deflateEnd(&_deflateState);
    }
    bool WebSocketPerMessageDeflateCompressor::init(uint8_t deflateBits,
                                                    bool clientNoContextTakeOver)
    {
        int ret = deflateInit2(
            &_deflateState,
            Z_DEFAULT_COMPRESSION,
            Z_DEFLATED,
            -1*deflateBits,
            4, // memory level 1-9
            Z_DEFAULT_STRATEGY
        );
        if (ret != Z_OK) return false;
        _compressBuffer = std::make_unique<unsigned char[]>(_compressBufferSize);
        _flush = (clientNoContextTakeOver)
                 ? Z_FULL_FLUSH
                 : Z_SYNC_FLUSH;
        return true;
    }
    bool WebSocketPerMessageDeflateCompressor::endsWith(const std::string& value,
                                                        const std::string& ending)
    {
        if (ending.size() > value.size()) return false;
        return std::equal(ending.rbegin(), ending.rend(), value.rbegin());
    }
    bool WebSocketPerMessageDeflateCompressor::compress(const std::string& in,
                                                        std::string& out)
    {
        //
        // 7.2.1.  Compression
        //
        //    An endpoint uses the following algorithm to compress a message.
        //
        //    1.  Compress all the octets of the payload of the message using
        //        DEFLATE.
        //
        //    2.  If the resulting data does not end with an empty DEFLATE block
        //        with no compression (the "BTYPE" bits are set to 00), append an
        //        empty DEFLATE block with no compression to the tail end.
        //
        //    3.  Remove 4 octets (that are 0x00 0x00 0xff 0xff) from the tail end.
        //        After this step, the last octet of the compressed data contains
        //        (possibly part of) the DEFLATE header bits with the "BTYPE" bits
        //        set to 00.
        //
        size_t output;
        if (in.empty())
        {
            uint8_t buf[6] = {0x02, 0x00, 0x00, 0x00, 0xff, 0xff};
            out.append((char *)(buf), 6);
            return true;
        }
        _deflateState.avail_in = (uInt) in.size();
        _deflateState.next_in = (Bytef*) in.data();
        do
        {
            // Output to local buffer
            _deflateState.avail_out = (uInt) _compressBufferSize;
            _deflateState.next_out = _compressBuffer.get();
            deflate(&_deflateState, _flush);
            output = _compressBufferSize - _deflateState.avail_out;
            out.append((char *)(_compressBuffer.get()),output);
        } while (_deflateState.avail_out == 0);
        if (endsWith(out, kEmptyUncompressedBlock))
        {
            out.resize(out.size() - 4);
        }
        return true;
    }
    //
    // Decompressor
    //
    WebSocketPerMessageDeflateDecompressor::WebSocketPerMessageDeflateDecompressor()
      : _compressBufferSize(kBufferSize)
    {
        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;
    }
    WebSocketPerMessageDeflateDecompressor::~WebSocketPerMessageDeflateDecompressor()
    {
        inflateEnd(&_inflateState);
    }
    bool WebSocketPerMessageDeflateDecompressor::init(uint8_t inflateBits,
                                                      bool clientNoContextTakeOver)
    {
        int ret = inflateInit2(
            &_inflateState,
            -1*inflateBits
        );
        if (ret != Z_OK) return false;
        _compressBuffer = std::make_unique<unsigned char[]>(_compressBufferSize);
        _flush = (clientNoContextTakeOver)
                 ? Z_FULL_FLUSH
                 : Z_SYNC_FLUSH;
        return true;
    }
    bool WebSocketPerMessageDeflateDecompressor::decompress(const std::string& in,
                                                            std::string& out)
    {
        //
        // 7.2.2.  Decompression
        //
        //    An endpoint uses the following algorithm to decompress a message.
        //
        //    1.  Append 4 octets of 0x00 0x00 0xff 0xff to the tail end of the
        //        payload of the message.
        //
        //    2.  Decompress the resulting data using DEFLATE.
        //
        std::string inFixed(in);
        inFixed += kEmptyUncompressedBlock;
        _inflateState.avail_in = (uInt) inFixed.size();
        _inflateState.next_in = (unsigned char *)(const_cast<char *>(inFixed.data()));
        do
        {
            _inflateState.avail_out = (uInt) _compressBufferSize;
            _inflateState.next_out = _compressBuffer.get();
            int ret = inflate(&_inflateState, Z_SYNC_FLUSH);
            if (ret == Z_NEED_DICT || ret == Z_DATA_ERROR || ret == Z_MEM_ERROR)
            {
                return false; // zlib error
            }
            out.append(
                reinterpret_cast<char *>(_compressBuffer.get()),
                _compressBufferSize - _inflateState.avail_out
            );
        } while (_inflateState.avail_out == 0);
        return true;
    }
 }
@@ -0,0 +1,50 @@
 /*
 *  IXWebSocketPerMessageDeflateCodec.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "zlib.h"
 #include <string>
 #include <memory>
 namespace ix
 {
    class WebSocketPerMessageDeflateCompressor
    {
    public:
        WebSocketPerMessageDeflateCompressor();
        ~WebSocketPerMessageDeflateCompressor();
        bool init(uint8_t deflateBits, bool clientNoContextTakeOver);
        bool compress(const std::string& in, std::string& out);
    private:
        static bool endsWith(const std::string& value, const std::string& ending);
        int _flush;
        size_t _compressBufferSize;
        std::unique_ptr<unsigned char[]> _compressBuffer;
        z_stream _deflateState;
    };
    class WebSocketPerMessageDeflateDecompressor
    {
    public:
        WebSocketPerMessageDeflateDecompressor();
        ~WebSocketPerMessageDeflateDecompressor();
        bool init(uint8_t inflateBits, bool clientNoContextTakeOver);
        bool decompress(const std::string& in, std::string& out);
    private:
        int _flush;
        size_t _compressBufferSize;
        std::unique_ptr<unsigned char[]> _compressBuffer;
        z_stream _inflateState;
    };
 }
@@ -0,0 +1,172 @@
 /*
 *  IXWebSocketPerMessageDeflateOptions.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include <sstream>
 #include <iostream>
 #include <algorithm>
 #include <cctype>
 namespace ix
 {
    /// Default values as defined in the RFC
    const uint8_t WebSocketPerMessageDeflateOptions::kDefaultServerMaxWindowBits = 15;
    static const int minServerMaxWindowBits = 8;
    static const int maxServerMaxWindowBits = 15;
    const uint8_t WebSocketPerMessageDeflateOptions::kDefaultClientMaxWindowBits = 15;
    static const int minClientMaxWindowBits = 8;
    static const int maxClientMaxWindowBits = 15;
    WebSocketPerMessageDeflateOptions::WebSocketPerMessageDeflateOptions(
        bool enabled,
        bool clientNoContextTakeover,
        bool serverNoContextTakeover,
        uint8_t clientMaxWindowBits,
        uint8_t serverMaxWindowBits)
    {
        _enabled = enabled;
        _clientNoContextTakeover = clientNoContextTakeover;
        _serverNoContextTakeover = serverNoContextTakeover;
        _clientMaxWindowBits = clientMaxWindowBits;
        _serverMaxWindowBits = serverMaxWindowBits;
    }
    //
    // Four extension parameters are defined for "permessage-deflate" to
    // help endpoints manage per-connection resource usage.
    //
    // - "server_no_context_takeover"
    // - "client_no_context_takeover"
    // - "server_max_window_bits"
    // - "client_max_window_bits"
    //
    // Server response could look like that:
    //
    // Sec-WebSocket-Extensions: permessage-deflate; client_no_context_takeover; server_no_context_takeover
    //
    WebSocketPerMessageDeflateOptions::WebSocketPerMessageDeflateOptions(std::string extension)
    {
        extension = removeSpaces(extension);
        _enabled = false;
        _clientNoContextTakeover = false;
        _serverNoContextTakeover = false;
        _clientMaxWindowBits = kDefaultClientMaxWindowBits;
        _serverMaxWindowBits = kDefaultServerMaxWindowBits;
        // Split by ;
        std::string token;
        std::stringstream tokenStream(extension);
        while (std::getline(tokenStream, token, ';'))
        {
            if (token == "permessage-deflate")
            {
                _enabled = true;
            }
            if (token == "server_no_context_takeover")
            {
                _serverNoContextTakeover = true;
            }
            if (token == "client_no_context_takeover")
            {
                _clientNoContextTakeover = true;
            }
            if (startsWith(token, "server_max_window_bits="))
            {
                std::string val = token.substr(token.find_last_of("=") + 1);
                std::stringstream ss;
                ss << val;
                int x;
                ss >> x;
                // Sanitize values to be in the proper range [8, 15] in
                // case a server would give us bogus values
                _serverMaxWindowBits =
                    std::min(maxServerMaxWindowBits,
                        std::max(x, minServerMaxWindowBits));
            }
            if (startsWith(token, "client_max_window_bits="))
            {
                std::string val = token.substr(token.find_last_of("=") + 1);
                std::stringstream ss;
                ss << val;
                int x;
                ss >> x;
                // Sanitize values to be in the proper range [8, 15] in
                // case a server would give us bogus values
                _clientMaxWindowBits =
                    std::min(maxClientMaxWindowBits,
                        std::max(x, minClientMaxWindowBits));
            }
        }
    }
    std::string WebSocketPerMessageDeflateOptions::generateHeader()
    {
        std::stringstream ss;
        ss << "Sec-WebSocket-Extensions: permessage-deflate";
        if (_clientNoContextTakeover) ss << "; client_no_context_takeover";
        if (_serverNoContextTakeover) ss << "; server_no_context_takeover";
        ss << "; server_max_window_bits=" << _serverMaxWindowBits;
        ss << "; client_max_window_bits=" << _clientMaxWindowBits;
        ss << "\r\n";
        return ss.str();
    }
    bool WebSocketPerMessageDeflateOptions::enabled() const
    {
        return _enabled;
    }
    bool WebSocketPerMessageDeflateOptions::getClientNoContextTakeover() const
    {
        return _clientNoContextTakeover;
    }
    bool WebSocketPerMessageDeflateOptions::getServerNoContextTakeover() const
    {
        return _serverNoContextTakeover;
    }
    uint8_t WebSocketPerMessageDeflateOptions::getClientMaxWindowBits() const
    {
        return _clientMaxWindowBits;
    }
    uint8_t WebSocketPerMessageDeflateOptions::getServerMaxWindowBits() const
    {
        return _serverMaxWindowBits;
    }
    bool WebSocketPerMessageDeflateOptions::startsWith(const std::string& str,
                                                       const std::string& start)
    {
        return str.compare(0, start.length(), start) == 0;
    }
    std::string WebSocketPerMessageDeflateOptions::removeSpaces(const std::string& str)
    {
        std::string out(str);
        out.erase(std::remove_if(out.begin(),
                                 out.end(),
                                 [](unsigned char x){ return std::isspace(x); }),
                  out.end());
        return out;
    }
 }
@@ -0,0 +1,46 @@
 /*
 *  IXWebSocketPerMessageDeflateOptions.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <string>
 namespace ix
 {
    class WebSocketPerMessageDeflateOptions
    {
    public:
        WebSocketPerMessageDeflateOptions(
            bool enabled = false,
            bool clientNoContextTakeover = false,
            bool serverNoContextTakeover = false,
            uint8_t clientMaxWindowBits = kDefaultClientMaxWindowBits,
            uint8_t serverMaxWindowBits = kDefaultServerMaxWindowBits);
        WebSocketPerMessageDeflateOptions(std::string extension);
        std::string generateHeader();
        std::string parseHeader();
        bool enabled() const;
        bool getClientNoContextTakeover() const;
        bool getServerNoContextTakeover() const;
        uint8_t getServerMaxWindowBits() const;
        uint8_t getClientMaxWindowBits() const;
        static bool startsWith(const std::string& str, const std::string& start);
        static std::string removeSpaces(const std::string& str);
        static uint8_t const kDefaultClientMaxWindowBits;
        static uint8_t const kDefaultServerMaxWindowBits;
    private:
        bool _enabled;
        bool _clientNoContextTakeover;
        bool _serverNoContextTakeover;
        int _clientMaxWindowBits;
        int _serverMaxWindowBits;
    };
 }
@@ -0,0 +1,31 @@
 /*
 *  IXWebSocketSendInfo.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <string>
 #include <iostream>
 namespace ix
 {
    struct WebSocketSendInfo
    {
        bool success;
        bool compressionError;
        size_t payloadSize;
        size_t wireSize;
        WebSocketSendInfo(bool s = false, bool c = false,
                          size_t p = 0, size_t w = 0)
            : success(s)
            , compressionError(c)
            , payloadSize(p)
            , wireSize(w)
        {
            ;
        }
    };
 }
@@ -0,0 +1,105 @@
 /*
 *  IXWebSocketServer.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocketServer.h"
 #include "IXWebSocketTransport.h"
 #include "IXWebSocket.h"
 #include "IXSocketConnect.h"
 #include "IXNetSystem.h"
 #include <sstream>
 #include <future>
 #include <string.h>
 namespace ix
 {
    const int WebSocketServer::kDefaultHandShakeTimeoutSecs(3); // 3 seconds
    WebSocketServer::WebSocketServer(int port,
                                     const std::string& host,
                                     int backlog,
                                     size_t maxConnections,
                                     int handshakeTimeoutSecs) : SocketServer(port, host, backlog, maxConnections),
        _handshakeTimeoutSecs(handshakeTimeoutSecs)
    {
    }
    WebSocketServer::~WebSocketServer()
    {
        stop();
    }
    void WebSocketServer::stop()
    {
        auto clients = getClients();
        for (auto client : clients)
        {
            client->close();
        }
        SocketServer::stop();
    }
    void WebSocketServer::setOnConnectionCallback(const OnConnectionCallback& callback)
    {
        _onConnectionCallback = callback;
    }
    void WebSocketServer::handleConnection(int fd)
    {
        auto webSocket = std::make_shared<WebSocket>();
        _onConnectionCallback(webSocket);
        webSocket->disableAutomaticReconnection();
        // Add this client to our client set
        {
            std::lock_guard<std::mutex> lock(_clientsMutex);
            _clients.insert(webSocket);
        }
        auto status = webSocket->connectToSocket(fd, _handshakeTimeoutSecs);
        if (status.success)
        {
            // Process incoming messages and execute callbacks
            // until the connection is closed
            webSocket->run();
        }
        else
        {
            std::stringstream ss;
            ss << "WebSocketServer::handleConnection() error: "
               << status.http_status
               << " error: "
               << status.errorStr;
            logError(ss.str());
        }
        // Remove this client from our client set
        {
            std::lock_guard<std::mutex> lock(_clientsMutex);
            if (_clients.erase(webSocket) != 1)
            {
                logError("Cannot delete client");
            }
        }
        logInfo("WebSocketServer::handleConnection() done");
    }
    std::set<std::shared_ptr<WebSocket>> WebSocketServer::getClients()
    {
        std::lock_guard<std::mutex> lock(_clientsMutex);
        return _clients;
    }
    size_t WebSocketServer::getConnectedClientsCount()
    {
        std::lock_guard<std::mutex> lock(_clientsMutex);
        return _clients.size();
    }
 }
@@ -0,0 +1,55 @@
 /*
 *  IXWebSocketServer.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include <utility> // pair
 #include <string>
 #include <set>
 #include <thread>
 #include <mutex>
 #include <functional>
 #include <memory>
 #include <condition_variable>
 #include "IXWebSocket.h"
 #include "IXSocketServer.h"
 namespace ix
 {
    using OnConnectionCallback = std::function<void(std::shared_ptr<WebSocket>)>;
    class WebSocketServer : public SocketServer {
    public:
        WebSocketServer(int port = SocketServer::kDefaultPort,
                        const std::string& host = SocketServer::kDefaultHost,
                        int backlog = SocketServer::kDefaultTcpBacklog,
                        size_t maxConnections = SocketServer::kDefaultMaxConnections,
                        int handshakeTimeoutSecs = WebSocketServer::kDefaultHandShakeTimeoutSecs);
        virtual ~WebSocketServer();
        virtual void stop() final;
        void setOnConnectionCallback(const OnConnectionCallback& callback);
        // Get all the connected clients
        std::set<std::shared_ptr<WebSocket>> getClients();
    private:
        // Member variables
        int _handshakeTimeoutSecs;
        OnConnectionCallback _onConnectionCallback;
        std::mutex _clientsMutex;
        std::set<std::shared_ptr<WebSocket>> _clients;
        const static int kDefaultHandShakeTimeoutSecs;
        // Methods
        virtual void handleConnection(int fd) final;
        virtual size_t getConnectedClientsCount() final;
    };
 }
@@ -0,0 +1,734 @@
 /*
 *  IXWebSocketTransport.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 //
 // Adapted from https://github.com/dhbaird/easywsclient
 //
 #include "IXWebSocketTransport.h"
 #include "IXWebSocketHandshake.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXUrlParser.h"
 #include "IXSocketFactory.h"
 #ifdef IXWEBSOCKET_USE_TLS
 # ifdef __APPLE__
 #  include "IXSocketAppleSSL.h"
 # else
 #  include "IXSocketOpenSSL.h"
 # endif
 #endif
 #include <string.h>
 #include <stdlib.h>
 #include <cstdlib>
 #include <vector>
 #include <string>
 #include <cstdarg>
 #include <iostream>
 #include <sstream>
 #include <chrono>
 #include <thread>
 namespace ix
 {
    const std::string WebSocketTransport::kHeartBeatPingMessage("ixwebsocket::hearbeat");
    const int WebSocketTransport::kDefaultHeartBeatPeriod(-1);
    constexpr size_t WebSocketTransport::kChunkSize;
    WebSocketTransport::WebSocketTransport() :
        _readyState(CLOSED),
        _closeCode(0),
        _closeWireSize(0),
        _enablePerMessageDeflate(false),
        _requestInitCancellation(false),
        _heartBeatPeriod(kDefaultHeartBeatPeriod),
        _lastSendTimePoint(std::chrono::steady_clock::now())
    {
        _readbuf.resize(kChunkSize);
    }
    WebSocketTransport::~WebSocketTransport()
    {
        ;
    }
    void WebSocketTransport::configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
                                       int hearBeatPeriod)
    {
        _perMessageDeflateOptions = perMessageDeflateOptions;
        _enablePerMessageDeflate = _perMessageDeflateOptions.enabled();
        _heartBeatPeriod = hearBeatPeriod;
    }
    // Client
    WebSocketInitResult WebSocketTransport::connectToUrl(const std::string& url,
                                                         int timeoutSecs)
    {
        std::string protocol, host, path, query;
        int port;
        bool websocket = true;
        if (!UrlParser::parse(url, protocol, host, path, query, port, websocket))
        {
            return WebSocketInitResult(false, 0,
                                       std::string("Could not parse URL ") + url);
        }
        if (protocol != "ws" && protocol != "wss")
        {
            std::stringstream ss;
            ss << "Invalid protocol: " << protocol
               << " for url " << url
               << " . Supported protocols are ws and wss";
            return WebSocketInitResult(false, 0, ss.str());
        }
        bool tls = protocol == "wss";
        std::string errorMsg;
        _socket = createSocket(tls, errorMsg);
        if (!_socket)
        {
            return WebSocketInitResult(false, 0, errorMsg);
        }
        WebSocketHandshake webSocketHandshake(_requestInitCancellation,
                                              _socket,
                                              _perMessageDeflate,
                                              _perMessageDeflateOptions,
                                              _enablePerMessageDeflate);
        auto result = webSocketHandshake.clientHandshake(url, host, path, port,
                                                         timeoutSecs);
        if (result.success)
        {
            setReadyState(OPEN);
        }
        return result;
    }
    // Server
    WebSocketInitResult WebSocketTransport::connectToSocket(int fd, int timeoutSecs)
    {
        _socket.reset();
        _socket = std::make_shared<Socket>(fd);
        WebSocketHandshake webSocketHandshake(_requestInitCancellation,
                                              _socket,
                                              _perMessageDeflate,
                                              _perMessageDeflateOptions,
                                              _enablePerMessageDeflate);
        auto result = webSocketHandshake.serverHandshake(fd, timeoutSecs);
        if (result.success)
        {
            setReadyState(OPEN);
        }
        return result;
    }
    WebSocketTransport::ReadyStateValues WebSocketTransport::getReadyState() const
    {
        return _readyState;
    }
    void WebSocketTransport::setReadyState(ReadyStateValues readyStateValue)
    {
        // No state change, return
        if (_readyState == readyStateValue) return;
        if (readyStateValue == CLOSED)
        {
            std::lock_guard<std::mutex> lock(_closeDataMutex);
            _onCloseCallback(_closeCode, _closeReason, _closeWireSize);
            _closeCode = 0;
            _closeReason = std::string();
            _closeWireSize = 0;
        }
        _readyState = readyStateValue;
    }
    void WebSocketTransport::setOnCloseCallback(const OnCloseCallback& onCloseCallback)
    {
        _onCloseCallback = onCloseCallback;
    }
    // Only consider send time points for that computation.
    // The receive time points is taken into account in Socket::poll (second parameter).
    bool WebSocketTransport::heartBeatPeriodExceeded()
    {
        std::lock_guard<std::mutex> lock(_lastSendTimePointMutex);
        auto now = std::chrono::steady_clock::now();
        return now - _lastSendTimePoint > std::chrono::seconds(_heartBeatPeriod);
    }
    void WebSocketTransport::poll()
    {
        _socket->poll(
            [this](PollResultType pollResult)
            {
                // If (1) heartbeat is enabled, and (2) no data was received or
                // send for a duration exceeding our heart-beat period, send a
                // ping to the server.
                if (pollResult == PollResultType_Timeout &&
                    heartBeatPeriodExceeded())
                {
                    std::stringstream ss;
                    ss << kHeartBeatPingMessage << "::" << _heartBeatPeriod << "s";
                    sendPing(ss.str());
                    return;
                }
                while (true)
                {
                    ssize_t ret = _socket->recv((char*)&_readbuf[0], _readbuf.size());
                    if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK ||
                                    _socket->getErrno() == EAGAIN))
                    {
                        break;
                    }
                    else if (ret <= 0)
                    {
                        _rxbuf.clear();
                        _socket->close();
                        setReadyState(CLOSED);
                        break;
                    }
                    else
                    {
                        _rxbuf.insert(_rxbuf.end(),
                                      _readbuf.begin(),
                                      _readbuf.begin() + ret);
                    }
                }
                if (isSendBufferEmpty() && _readyState == CLOSING)
                {
                    _socket->close();
                    setReadyState(CLOSED);
                }
            },
            _heartBeatPeriod);
    }
    bool WebSocketTransport::isSendBufferEmpty() const
    {
        std::lock_guard<std::mutex> lock(_txbufMutex);
        return _txbuf.empty();
    }
    void WebSocketTransport::appendToSendBuffer(const std::vector<uint8_t>& header,
                                                std::string::const_iterator begin,
                                                std::string::const_iterator end,
                                                uint64_t message_size,
                                                uint8_t masking_key[4])
    {
        std::lock_guard<std::mutex> lock(_txbufMutex);
        _txbuf.insert(_txbuf.end(), header.begin(), header.end());
        _txbuf.insert(_txbuf.end(), begin, end);
        // Masking
        for (size_t i = 0; i != (size_t) message_size; ++i)
        {
            *(_txbuf.end() - (size_t) message_size + i) ^= masking_key[i&0x3];
        }
    }
    void WebSocketTransport::appendToSendBuffer(const std::vector<uint8_t>& buffer)
    {
        std::lock_guard<std::mutex> lock(_txbufMutex);
        _txbuf.insert(_txbuf.end(), buffer.begin(), buffer.end());
    }
    void WebSocketTransport::unmaskReceiveBuffer(const wsheader_type& ws)
    {
        if (ws.mask)
        {
            for (size_t j = 0; j != ws.N; ++j)
            {
                _rxbuf[j+ws.header_size] ^= ws.masking_key[j&0x3];
            }
        }
    }
    //
    // http://tools.ietf.org/html/rfc6455#section-5.2  Base Framing Protocol
    //
    //  0                   1                   2                   3
    //  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
    // +-+-+-+-+-------+-+-------------+-------------------------------+
    // |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
    // |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
    // |N|V|V|V|       |S|             |   (if payload len==126/127)   |
    // | |1|2|3|       |K|             |                               |
    // +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
    // |     Extended payload length continued, if payload len == 127  |
    // + - - - - - - - - - - - - - - - +-------------------------------+
    // |                               |Masking-key, if MASK set to 1  |
    // +-------------------------------+-------------------------------+
    // | Masking-key (continued)       |          Payload Data         |
    // +-------------------------------- - - - - - - - - - - - - - - - +
    // :                     Payload Data continued ...                :
    // + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
    // |                     Payload Data continued ...                |
    // +---------------------------------------------------------------+
    //
    void WebSocketTransport::dispatch(const OnMessageCallback& onMessageCallback)
    {
        while (true)
        {
            wsheader_type ws;
            if (_rxbuf.size() < 2) return; /* Need at least 2 */
            const uint8_t * data = (uint8_t *) &_rxbuf[0]; // peek, but don't consume
            ws.fin = (data[0] & 0x80) == 0x80;
            ws.rsv1 = (data[0] & 0x40) == 0x40;
            ws.opcode = (wsheader_type::opcode_type) (data[0] & 0x0f);
            ws.mask = (data[1] & 0x80) == 0x80;
            ws.N0 = (data[1] & 0x7f);
            ws.header_size = 2 + (ws.N0 == 126? 2 : 0) + (ws.N0 == 127? 8 : 0) + (ws.mask? 4 : 0);
            if (_rxbuf.size() < ws.header_size) return; /* Need: ws.header_size - _rxbuf.size() */
            //
            // Calculate payload length:
            // 0-125 mean the payload is that long.
            // 126 means that the following two bytes indicate the length,
            // 127 means the next 8 bytes indicate the length.
            //
            int i = 0;
            if (ws.N0 < 126)
            {
                ws.N = ws.N0;
                i = 2;
            }
            else if (ws.N0 == 126)
            {
                ws.N = 0;
                ws.N |= ((uint64_t) data[2]) << 8;
                ws.N |= ((uint64_t) data[3]) << 0;
                i = 4;
            }
            else if (ws.N0 == 127)
            {
                ws.N = 0;
                ws.N |= ((uint64_t) data[2]) << 56;
                ws.N |= ((uint64_t) data[3]) << 48;
                ws.N |= ((uint64_t) data[4]) << 40;
                ws.N |= ((uint64_t) data[5]) << 32;
                ws.N |= ((uint64_t) data[6]) << 24;
                ws.N |= ((uint64_t) data[7]) << 16;
                ws.N |= ((uint64_t) data[8]) << 8;
                ws.N |= ((uint64_t) data[9]) << 0;
                i = 10;
            }
            else
            {
                // invalid payload length according to the spec. bail out
                return;
            }
            if (ws.mask)
            {
                ws.masking_key[0] = ((uint8_t) data[i+0]) << 0;
                ws.masking_key[1] = ((uint8_t) data[i+1]) << 0;
                ws.masking_key[2] = ((uint8_t) data[i+2]) << 0;
                ws.masking_key[3] = ((uint8_t) data[i+3]) << 0;
            }
            else
            {
                ws.masking_key[0] = 0;
                ws.masking_key[1] = 0;
                ws.masking_key[2] = 0;
                ws.masking_key[3] = 0;
            }
            if (_rxbuf.size() < ws.header_size+ws.N)
            {
                return; /* Need: ws.header_size+ws.N - _rxbuf.size() */
            }
            // We got a whole message, now do something with it:
            if (
                   ws.opcode == wsheader_type::TEXT_FRAME
                || ws.opcode == wsheader_type::BINARY_FRAME
                || ws.opcode == wsheader_type::CONTINUATION
            ) {
                unmaskReceiveBuffer(ws);
                //
                // Usual case. Small unfragmented messages
                //
                if (ws.fin && _chunks.empty())
                {
                    emitMessage(MSG,
                                std::string(_rxbuf.begin()+ws.header_size,
                                            _rxbuf.begin()+ws.header_size+(size_t) ws.N),
                                ws,
                                onMessageCallback);
                }
                else
                {
                    //
                    // Add intermediary message to our chunk list.
                    // We use a chunk list instead of a big buffer because resizing
                    // large buffer can be very costly when we need to re-allocate
                    // the internal buffer which is slow and can let the internal OS
                    // receive buffer fill out.
                    //
                    _chunks.emplace_back(
                        std::vector<uint8_t>(_rxbuf.begin()+ws.header_size,
                                             _rxbuf.begin()+ws.header_size+(size_t)ws.N));
                    if (ws.fin)
                    {
                        emitMessage(MSG, getMergedChunks(), ws, onMessageCallback);
                        _chunks.clear();
                    }
                }
            }
            else if (ws.opcode == wsheader_type::PING)
            {
                unmaskReceiveBuffer(ws);
                std::string pingData(_rxbuf.begin()+ws.header_size,
                                     _rxbuf.begin()+ws.header_size + (size_t) ws.N);
                // Reply back right away
                bool compress = false;
                sendData(wsheader_type::PONG, pingData, compress);
                emitMessage(PING, pingData, ws, onMessageCallback);
            }
            else if (ws.opcode == wsheader_type::PONG)
            {
                unmaskReceiveBuffer(ws);
                std::string pongData(_rxbuf.begin()+ws.header_size,
                                     _rxbuf.begin()+ws.header_size + (size_t) ws.N);
                emitMessage(PONG, pongData, ws, onMessageCallback);
            }
            else if (ws.opcode == wsheader_type::CLOSE)
            {
                unmaskReceiveBuffer(ws);
                // Extract the close code first, available as the first 2 bytes
                uint16_t code = 0;
                code |= ((uint64_t) _rxbuf[ws.header_size])   << 8;
                code |= ((uint64_t) _rxbuf[ws.header_size+1]) << 0;
                // Get the reason.
                std::string reason(_rxbuf.begin()+ws.header_size + 2,
                                   _rxbuf.begin()+ws.header_size + 2 + (size_t) ws.N);
                {
                    std::lock_guard<std::mutex> lock(_closeDataMutex);
                    _closeCode = code;
                    _closeReason = reason;
                    _closeWireSize = _rxbuf.size();
                }
                close();
            }
            else
            {
                close();
            }
            // Erase the message that has been processed from the input/read buffer
            _rxbuf.erase(_rxbuf.begin(),
                         _rxbuf.begin() + ws.header_size + (size_t) ws.N);
        }
    }
    std::string WebSocketTransport::getMergedChunks() const
    {
        size_t length = 0;
        for (auto&& chunk : _chunks)
        {
            length += chunk.size();
        }
        std::string msg;
        msg.reserve(length);
        for (auto&& chunk : _chunks)
        {
            std::string str(chunk.begin(), chunk.end());
            msg += str;
        }
        return msg;
    }
    void WebSocketTransport::emitMessage(MessageKind messageKind,
                                         const std::string& message,
                                         const wsheader_type& ws,
                                         const OnMessageCallback& onMessageCallback)
    {
        size_t wireSize = message.size();
        // When the RSV1 bit is 1 it means the message is compressed
        if (_enablePerMessageDeflate && ws.rsv1)
        {
            std::string decompressedMessage;
            bool success = _perMessageDeflate.decompress(message, decompressedMessage);
            onMessageCallback(decompressedMessage, wireSize, !success, messageKind);
        }
        else
        {
            onMessageCallback(message, wireSize, false, messageKind);
        }
    }
    unsigned WebSocketTransport::getRandomUnsigned()
    {
        auto now = std::chrono::system_clock::now();
        auto seconds =
            std::chrono::duration_cast<std::chrono::seconds>(
                now.time_since_epoch()).count();
        return static_cast<unsigned>(seconds);
    }
    WebSocketSendInfo WebSocketTransport::sendData(
        wsheader_type::opcode_type type,
        const std::string& message,
        bool compress,
        const OnProgressCallback& onProgressCallback)
    {
        if (_readyState == CLOSING || _readyState == CLOSED)
        {
            return WebSocketSendInfo();
        }
        size_t payloadSize = message.size();
        size_t wireSize = message.size();
        std::string compressedMessage;
        bool compressionError = false;
        std::string::const_iterator message_begin = message.begin();
        std::string::const_iterator message_end = message.end();
        if (compress)
        {
            if (!_perMessageDeflate.compress(message, compressedMessage))
            {
                bool success = false;
                compressionError = true;
                payloadSize = 0;
                wireSize = 0;
                return WebSocketSendInfo(success, compressionError, payloadSize, wireSize);
            }
            compressionError = false;
            wireSize = compressedMessage.size();
            message_begin = compressedMessage.begin();
            message_end = compressedMessage.end();
        }
        // Common case for most message. No fragmentation required.
        if (wireSize < kChunkSize)
        {
            sendFragment(type, true, message_begin, message_end, compress);
        }
        else
        {
            //
            // Large messages need to be fragmented
            //
            // Rules:
            // First message needs to specify a proper type (BINARY or TEXT)
            // Intermediary and last messages need to be of type CONTINUATION
            // Last message must set the fin byte.
            //
            auto steps = wireSize / kChunkSize;
            std::string::const_iterator begin = message_begin;
            std::string::const_iterator end = message_end;
            for (uint64_t i = 0 ; i < steps; ++i)
            {
                bool firstStep = i == 0;
                bool lastStep = (i+1) == steps;
                bool fin = lastStep;
                end = begin + kChunkSize;
                if (lastStep)
                {
                    end = message_end;
                }
                auto opcodeType = type;
                if (!firstStep)
                {
                    opcodeType = wsheader_type::CONTINUATION;
                }
                // Send message
                sendFragment(opcodeType, fin, begin, end, compress);
                if (onProgressCallback && !onProgressCallback(i, steps))
                {
                    break;
                }
                begin += kChunkSize;
            }
        }
        return WebSocketSendInfo(true, compressionError, payloadSize, wireSize);
    }
    void WebSocketTransport::sendFragment(wsheader_type::opcode_type type,
                                          bool fin,
                                          std::string::const_iterator message_begin,
                                          std::string::const_iterator message_end,
                                          bool compress)
    {
        auto message_size = message_end - message_begin;
        unsigned x = getRandomUnsigned();
        uint8_t masking_key[4] = {};
        masking_key[0] = (x >> 24);
        masking_key[1] = (x >> 16) & 0xff;
        masking_key[2] = (x >> 8)  & 0xff;
        masking_key[3] = (x)       & 0xff;
        std::vector<uint8_t> header;
        header.assign(2 +
                      (message_size >= 126 ? 2 : 0) +
                      (message_size >= 65536 ? 6 : 0) + 4, 0);
        header[0] = type;
        // The fin bit indicate that this is the last fragment. Fin is French for end.
        if (fin)
        {
            header[0] |= 0x80;
        }
        // This bit indicate that the frame is compressed
        if (compress)
        {
            header[0] |= 0x40;
        }
        if (message_size < 126)
        {
            header[1] = (message_size & 0xff) | 0x80;
            header[2] = masking_key[0];
            header[3] = masking_key[1];
            header[4] = masking_key[2];
            header[5] = masking_key[3];
        }
        else if (message_size < 65536)
        {
            header[1] = 126 | 0x80;
            header[2] = (message_size >> 8) & 0xff;
            header[3] = (message_size >> 0) & 0xff;
            header[4] = masking_key[0];
            header[5] = masking_key[1];
            header[6] = masking_key[2];
            header[7] = masking_key[3];
        }
        else
        { // TODO: run coverage testing here
            header[1] = 127 | 0x80;
            header[2] = (message_size >> 56) & 0xff;
            header[3] = (message_size >> 48) & 0xff;
            header[4] = (message_size >> 40) & 0xff;
            header[5] = (message_size >> 32) & 0xff;
            header[6] = (message_size >> 24) & 0xff;
            header[7] = (message_size >> 16) & 0xff;
            header[8] = (message_size >>  8) & 0xff;
            header[9] = (message_size >>  0) & 0xff;
            header[10] = masking_key[0];
            header[11] = masking_key[1];
            header[12] = masking_key[2];
            header[13] = masking_key[3];
        }
        // _txbuf will keep growing until it can be transmitted over the socket:
        appendToSendBuffer(header, message_begin, message_end,
                           message_size, masking_key);
        // Now actually send this data
        sendOnSocket();
    }
    WebSocketSendInfo WebSocketTransport::sendPing(const std::string& message)
    {
        bool compress = false;
        return sendData(wsheader_type::PING, message, compress);
    }
    WebSocketSendInfo WebSocketTransport::sendBinary(
        const std::string& message,
        const OnProgressCallback& onProgressCallback)
    {
        return sendData(wsheader_type::BINARY_FRAME, message,
                        _enablePerMessageDeflate, onProgressCallback);
    }
    void WebSocketTransport::sendOnSocket()
    {
        std::lock_guard<std::mutex> lock(_txbufMutex);
        while (_txbuf.size())
        {
            ssize_t ret = _socket->send((char*)&_txbuf[0], _txbuf.size());
            if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK ||
                            _socket->getErrno() == EAGAIN))
            {
                break;
            }
            else if (ret <= 0)
            {
                _socket->close();
                setReadyState(CLOSED);
                break;
            }
            else
            {
                _txbuf.erase(_txbuf.begin(), _txbuf.begin() + ret);
            }
        }
        std::lock_guard<std::mutex> lck(_lastSendTimePointMutex);
        _lastSendTimePoint = std::chrono::steady_clock::now();
    }
    void WebSocketTransport::close()
    {
        _requestInitCancellation = true;
        if (_readyState == CLOSING || _readyState == CLOSED) return;
        // See list of close events here:
        // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
        // We use 1000: normal closure.
        //
        // >>> struct.pack('!H', 1000)
        // b'\x03\xe8'
        //
        const std::string normalClosure = std::string("\x03\xe8");
        bool compress = false;
        sendData(wsheader_type::CLOSE, normalClosure, compress);
        setReadyState(CLOSING);
        _socket->wakeUpFromPoll();
        _socket->close();
    }
 } // namespace ix
@@ -0,0 +1,182 @@
 /*
 *  IXWebSocketTransport.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 //
 // Adapted from https://github.com/dhbaird/easywsclient
 //
 #include <string>
 #include <vector>
 #include <functional>
 #include <memory>
 #include <mutex>
 #include <atomic>
 #include <list>
 #include "IXWebSocketSendInfo.h"
 #include "IXWebSocketPerMessageDeflate.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include "IXWebSocketHttpHeaders.h"
 #include "IXCancellationRequest.h"
 #include "IXWebSocketHandshake.h"
 #include "IXProgressCallback.h"
 namespace ix
 {
    class Socket;
    class WebSocketTransport
    {
    public:
        enum ReadyStateValues
        {
            CLOSING,
            CLOSED,
            CONNECTING,
            OPEN
        };
        enum MessageKind
        {
            MSG,
            PING,
            PONG
        };
        using OnMessageCallback = std::function<void(const std::string&,
                                                     size_t,
                                                     bool,
                                                     MessageKind)>;
        using OnCloseCallback = std::function<void(uint16_t,
                                                   const std::string&,
                                                   size_t)>;
        WebSocketTransport();
        ~WebSocketTransport();
        void configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
                       int hearBeatPeriod);
        WebSocketInitResult connectToUrl(const std::string& url, // Client
                                         int timeoutSecs);
        WebSocketInitResult connectToSocket(int fd,              // Server
                                            int timeoutSecs);
        void poll();
        WebSocketSendInfo sendBinary(const std::string& message,
                                     const OnProgressCallback& onProgressCallback);
        WebSocketSendInfo sendPing(const std::string& message);
        void close();
        ReadyStateValues getReadyState() const;
        void setReadyState(ReadyStateValues readyStateValue);
        void setOnCloseCallback(const OnCloseCallback& onCloseCallback);
        void dispatch(const OnMessageCallback& onMessageCallback);
    private:
        std::string _url;
        struct wsheader_type {
            unsigned header_size;
            bool fin;
            bool rsv1;
            bool mask;
            enum opcode_type {
                CONTINUATION = 0x0,
                TEXT_FRAME = 0x1,
                BINARY_FRAME = 0x2,
                CLOSE = 8,
                PING = 9,
                PONG = 0xa,
            } opcode;
            int N0;
            uint64_t N;
            uint8_t masking_key[4];
        };
        // Buffer for reading from our socket. That buffer is never resized.
        std::vector<uint8_t> _readbuf;
        // Contains all messages that were fetched in the last socket read.
        // This could be a mix of control messages (Close, Ping, etc...) and
        // data messages. That buffer
        std::vector<uint8_t> _rxbuf;
        // Contains all messages that are waiting to be sent
        std::vector<uint8_t> _txbuf;
        mutable std::mutex _txbufMutex;
        // Hold fragments for multi-fragments messages in a list. We support receiving very large
        // messages (tested messages up to 700M) and we cannot put them in a single
        // buffer that is resized, as this operation can be slow when a buffer has its
        // size increased 2 fold, while appending to a list has a fixed cost.
        std::list<std::vector<uint8_t>> _chunks;
        // Fragments are 32K long
        static constexpr size_t kChunkSize = 1 << 15;
        // Underlying TCP socket
        std::shared_ptr<Socket> _socket;
        // Hold the state of the connection (OPEN, CLOSED, etc...)
        std::atomic<ReadyStateValues> _readyState;
        OnCloseCallback _onCloseCallback;
        uint16_t _closeCode;
        std::string _closeReason;
        size_t _closeWireSize;
        mutable std::mutex _closeDataMutex;
        // Data used for Per Message Deflate compression (with zlib)
        WebSocketPerMessageDeflate _perMessageDeflate;
        WebSocketPerMessageDeflateOptions _perMessageDeflateOptions;
        std::atomic<bool> _enablePerMessageDeflate;
        // Used to cancel dns lookup + socket connect + http upgrade
        std::atomic<bool> _requestInitCancellation;
        // Optional Heartbeat
        int _heartBeatPeriod;
        static const int kDefaultHeartBeatPeriod;
        const static std::string kHeartBeatPingMessage;
        mutable std::mutex _lastSendTimePointMutex;
        std::chrono::time_point<std::chrono::steady_clock> _lastSendTimePoint;
        // No data was send through the socket for longer that the hearbeat period
        bool heartBeatPeriodExceeded();
        void sendOnSocket();
        WebSocketSendInfo sendData(wsheader_type::opcode_type type,
                                   const std::string& message,
                                   bool compress,
                                   const OnProgressCallback& onProgressCallback = nullptr);
        void sendFragment(wsheader_type::opcode_type type,
                          bool fin,
                          std::string::const_iterator begin,
                          std::string::const_iterator end,
                          bool compress);
        void emitMessage(MessageKind messageKind,
                         const std::string& message,
                         const wsheader_type& ws,
                         const OnMessageCallback& onMessageCallback);
        bool isSendBufferEmpty() const;
        void appendToSendBuffer(const std::vector<uint8_t>& header,
                                std::string::const_iterator begin,
                                std::string::const_iterator end,
                                uint64_t message_size,
                                uint8_t masking_key[4]);
        void appendToSendBuffer(const std::vector<uint8_t>& buffer);
        unsigned getRandomUnsigned();
        void unmaskReceiveBuffer(const wsheader_type& ws);
        std::string getMergedChunks() const;
    };
 }
@@ -0,0 +1,20 @@
 /*
 *  IXSetThreadName_apple.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "../IXSetThreadName.h"
 #include <pthread.h>
 namespace ix
 {
    void setThreadName(const std::string& name)
    {
        //
        // 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());
    }
 }
@@ -0,0 +1,128 @@
 // Copyright (c) 2016 Alex Hultman and contributors
 // This software is provided 'as-is', without any express or implied
 // warranty. In no event will the authors be held liable for any damages
 // arising from the use of this software.
 // Permission is granted to anyone to use this software for any purpose,
 // including commercial applications, and to alter it and redistribute it
 // freely, subject to the following restrictions:
 // 1. The origin of this software must not be misrepresented; you must not
 //    claim that you wrote the original software. If you use this software
 //    in a product, an acknowledgement in the product documentation would be
 //    appreciated but is not required.
 // 2. Altered source versions must be plainly marked as such, and must not be
 //    misrepresented as being the original software.
 // 3. This notice may not be removed or altered from any source distribution.
 #pragma once
 #include <cstdint>
 #include <cstddef>
 class WebSocketHandshakeKeyGen {
    template <int N, typename T>
    struct static_for {
        void operator()(uint32_t *a, uint32_t *b) {
            static_for<N - 1, T>()(a, b);
            T::template f<N - 1>(a, b);
        }
    };
    template <typename T>
    struct static_for<0, T> {
        void operator()(uint32_t * /*a*/, uint32_t * /*hash*/) {}
    };
    template <int state>
    struct Sha1Loop {
        static inline uint32_t rol(uint32_t value, size_t bits) {return (value << bits) | (value >> (32 - bits));}
        static inline uint32_t blk(uint32_t b[16], size_t i) {
            return rol(b[(i + 13) & 15] ^ b[(i + 8) & 15] ^ b[(i + 2) & 15] ^ b[i], 1);
        }
        template <int i>
        static inline void f(uint32_t *a, uint32_t *b) {
            switch (state) {
            case 1:
                a[i % 5] += ((a[(3 + i) % 5] & (a[(2 + i) % 5] ^ a[(1 + i) % 5])) ^ a[(1 + i) % 5]) + b[i] + 0x5a827999 + rol(a[(4 + i) % 5], 5);
                a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
                break;
            case 2:
                b[i] = blk(b, i);
                a[(1 + i) % 5] += ((a[(4 + i) % 5] & (a[(3 + i) % 5] ^ a[(2 + i) % 5])) ^ a[(2 + i) % 5]) + b[i] + 0x5a827999 + rol(a[(5 + i) % 5], 5);
                a[(4 + i) % 5] = rol(a[(4 + i) % 5], 30);
                break;
            case 3:
                b[(i + 4) % 16] = blk(b, (i + 4) % 16);
                a[i % 5] += (a[(3 + i) % 5] ^ a[(2 + i) % 5] ^ a[(1 + i) % 5]) + b[(i + 4) % 16] + 0x6ed9eba1 + rol(a[(4 + i) % 5], 5);
                a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
                break;
            case 4:
                b[(i + 8) % 16] = blk(b, (i + 8) % 16);
                a[i % 5] += (((a[(3 + i) % 5] | a[(2 + i) % 5]) & a[(1 + i) % 5]) | (a[(3 + i) % 5] & a[(2 + i) % 5])) + b[(i + 8) % 16] + 0x8f1bbcdc + rol(a[(4 + i) % 5], 5);
                a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
                break;
            case 5:
                b[(i + 12) % 16] = blk(b, (i + 12) % 16);
                a[i % 5] += (a[(3 + i) % 5] ^ a[(2 + i) % 5] ^ a[(1 + i) % 5]) + b[(i + 12) % 16] + 0xca62c1d6 + rol(a[(4 + i) % 5], 5);
                a[(3 + i) % 5] = rol(a[(3 + i) % 5], 30);
                break;
            case 6:
                b[i] += a[4 - i];
            }
        }
    };
    static inline void sha1(uint32_t hash[5], uint32_t b[16]) {
        uint32_t a[5] = {hash[4], hash[3], hash[2], hash[1], hash[0]};
        static_for<16, Sha1Loop<1>>()(a, b);
        static_for<4, Sha1Loop<2>>()(a, b);
        static_for<20, Sha1Loop<3>>()(a, b);
        static_for<20, Sha1Loop<4>>()(a, b);
        static_for<20, Sha1Loop<5>>()(a, b);
        static_for<5, Sha1Loop<6>>()(a, hash);
    }
    static inline void base64(unsigned char *src, char *dst) {
        const char *b64 = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
        for (int i = 0; i < 18; i += 3) {
            *dst++ = b64[(src[i] >> 2) & 63];
            *dst++ = b64[((src[i] & 3) << 4) | ((src[i + 1] & 240) >> 4)];
            *dst++ = b64[((src[i + 1] & 15) << 2) | ((src[i + 2] & 192) >> 6)];
            *dst++ = b64[src[i + 2] & 63];
        }
        *dst++ = b64[(src[18] >> 2) & 63];
        *dst++ = b64[((src[18] & 3) << 4) | ((src[19] & 240) >> 4)];
        *dst++ = b64[((src[19] & 15) << 2)];
        *dst++ = '=';
    }
 public:
    static inline void generate(const char input[24], char output[28]) {
        uint32_t b_output[5] = {
            0x67452301, 0xefcdab89, 0x98badcfe, 0x10325476, 0xc3d2e1f0
        };
        uint32_t b_input[16] = {
            0, 0, 0, 0, 0, 0, 0x32353845, 0x41464135, 0x2d453931, 0x342d3437, 0x44412d39,
            0x3543412d, 0x43354142, 0x30444338, 0x35423131, 0x80000000
        };
        for (int i = 0; i < 6; i++) {
            b_input[i] = (input[4 * i + 3] & 0xff) | (input[4 * i + 2] & 0xff) << 8 | (input[4 * i + 1] & 0xff) << 16 | (input[4 * i + 0] & 0xff) << 24;
        }
        sha1(b_output, b_input);
        uint32_t last_b[16] = {0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 480};
        sha1(b_output, last_b);
        for (int i = 0; i < 5; i++) {
            uint32_t tmp = b_output[i];
            char *bytes = (char *) &b_output[i];
            bytes[3] = tmp & 0xff;
            bytes[2] = (tmp >> 8) & 0xff;
            bytes[1] = (tmp >> 16) & 0xff;
            bytes[0] = (tmp >> 24) & 0xff;
        }
        base64((unsigned char *) b_output, output);
    }
 };
@@ -0,0 +1,21 @@
 /*
 *  IXSetThreadName_linux.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 */
 #include "../IXSetThreadName.h"
 #include <pthread.h>
 namespace ix
 {
    void setThreadName(const std::string& name)
    {
        //
        // 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());
    }
 }
@@ -0,0 +1,16 @@
 /*
 *  IXSetThreadName_windows.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
 */
 #include "../IXSetThreadName.h"
 #include <iostream>
 namespace ix
 {
    void setThreadName(const std::string& name)
    {
        // FIXME
        std::cerr << "setThreadName not implemented on Windows yet" << std::endl;
    }
 }
@@ -1,283 +0,0 @@
 function getSearchTerm() {
    var sPageURL = window.location.search.substring(1);
    var sURLVariables = sPageURL.split('&');
    for (var i = 0; i < sURLVariables.length; i++) {
        var sParameterName = sURLVariables[i].split('=');
        if (sParameterName[0] == 'q') {
            return sParameterName[1];
        }
    }
 }
 function applyTopPadding() {
    // Update various absolute positions to match where the main container
    // starts. This is necessary for handling multi-line nav headers, since
    // that pushes the main container down.
    var offset = $('body > .container').offset();
    $('html').css('scroll-padding-top', offset.top + 'px');
    $('.bs-sidebar.affix').css('top', offset.top + 'px');
 }
 $(document).ready(function() {
    applyTopPadding();
    var search_term = getSearchTerm(),
        $search_modal = $('#mkdocs_search_modal'),
        $keyboard_modal = $('#mkdocs_keyboard_modal');
    if (search_term) {
        $search_modal.modal();
    }
    // make sure search input gets autofocus every time modal opens.
    $search_modal.on('shown.bs.modal', function() {
        $search_modal.find('#mkdocs-search-query').focus();
    });
    // Close search modal when result is selected
    // The links get added later so listen to parent
    $('#mkdocs-search-results').click(function(e) {
        if ($(e.target).is('a')) {
            $search_modal.modal('hide');
        }
    });
    // Populate keyboard modal with proper Keys
    $keyboard_modal.find('.help.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.help];
    $keyboard_modal.find('.prev.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.previous];
    $keyboard_modal.find('.next.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.next];
    $keyboard_modal.find('.search.shortcut kbd')[0].innerHTML = keyCodes[shortcuts.search];
    // Keyboard navigation
    document.addEventListener("keydown", function(e) {
        if ($(e.target).is(':input')) return true;
        var key = e.which || e.keyCode || window.event && window.event.keyCode;
        var page;
        switch (key) {
            case shortcuts.next:
                page = $('.navbar a[rel="next"]:first').prop('href');
                break;
            case shortcuts.previous:
                page = $('.navbar a[rel="prev"]:first').prop('href');
                break;
            case shortcuts.search:
                e.preventDefault();
                $keyboard_modal.modal('hide');
                $search_modal.modal('show');
                $search_modal.find('#mkdocs-search-query').focus();
                break;
            case shortcuts.help:
                $search_modal.modal('hide');
                $keyboard_modal.modal('show');
                break;
            default: break;
        }
        if (page) {
            $keyboard_modal.modal('hide');
            window.location.href = page;
        }
    });
    $('table').addClass('table table-striped table-hover');
    // Improve the scrollspy behaviour when users click on a TOC item.
    $(".bs-sidenav a").on("click", function() {
        var clicked = this;
        setTimeout(function() {
            var active = $('.nav li.active a');
            active = active[active.length - 1];
            if (clicked !== active) {
                $(active).parent().removeClass("active");
                $(clicked).parent().addClass("active");
            }
        }, 50);
    });
    function showInnerDropdown(item) {
        var popup = $(item).next('.dropdown-menu');
        popup.addClass('show');
        $(item).addClass('open');
        // First, close any sibling dropdowns.
        var container = $(item).parent().parent();
        container.find('> .dropdown-submenu > a').each(function(i, el) {
            if (el !== item) {
                hideInnerDropdown(el);
            }
        });
        var popupMargin = 10;
        var maxBottom = $(window).height() - popupMargin;
        var bounds = item.getBoundingClientRect();
        popup.css('left', bounds.right + 'px');
        if (bounds.top + popup.height() > maxBottom &&
            bounds.top > $(window).height() / 2) {
            popup.css({
                'top': (bounds.bottom - popup.height()) + 'px',
                'max-height': (bounds.bottom - popupMargin) + 'px',
            });
        } else {
            popup.css({
                'top': bounds.top + 'px',
                'max-height': (maxBottom - bounds.top) + 'px',
            });
        }
    }
    function hideInnerDropdown(item) {
        var popup = $(item).next('.dropdown-menu');
        popup.removeClass('show');
        $(item).removeClass('open');
        popup.scrollTop(0);
        popup.find('.dropdown-menu').scrollTop(0).removeClass('show');
        popup.find('.dropdown-submenu > a').removeClass('open');
    }
    $('.dropdown-submenu > a').on('click', function(e) {
        if ($(this).next('.dropdown-menu').hasClass('show')) {
            hideInnerDropdown(this);
        } else {
            showInnerDropdown(this);
        }
        e.stopPropagation();
        e.preventDefault();
    });
    $('.dropdown-menu').parent().on('hide.bs.dropdown', function(e) {
        $(this).find('.dropdown-menu').scrollTop(0);
        $(this).find('.dropdown-submenu > a').removeClass('open');
        $(this).find('.dropdown-menu .dropdown-menu').removeClass('show');
    });
 });
 $(window).on('resize', applyTopPadding);
 $('body').scrollspy({
    target: '.bs-sidebar',
    offset: 100
 });
 /* Prevent disabled links from causing a page reload */
 $("li.disabled a").click(function() {
    event.preventDefault();
 });
 // See https://www.cambiaresearch.com/articles/15/javascript-char-codes-key-codes
 // We only list common keys below. Obscure keys are omitted and their use is discouraged.
 var keyCodes = {
    8: 'backspace',
    9: 'tab',
    13: 'enter',
    16: 'shift',
    17: 'ctrl',
    18: 'alt',
    19: 'pause/break',
    20: 'caps lock',
    27: 'escape',
    32: 'spacebar',
    33: 'page up',
    34: 'page down',
    35: 'end',
    36: 'home',
    37: '&larr;',
    38: '&uarr;',
    39: '&rarr;',
    40: '&darr;',
    45: 'insert',
    46: 'delete',
    48: '0',
    49: '1',
    50: '2',
    51: '3',
    52: '4',
    53: '5',
    54: '6',
    55: '7',
    56: '8',
    57: '9',
    65: 'a',
    66: 'b',
    67: 'c',
    68: 'd',
    69: 'e',
    70: 'f',
    71: 'g',
    72: 'h',
    73: 'i',
    74: 'j',
    75: 'k',
    76: 'l',
    77: 'm',
    78: 'n',
    79: 'o',
    80: 'p',
    81: 'q',
    82: 'r',
    83: 's',
    84: 't',
    85: 'u',
    86: 'v',
    87: 'w',
    88: 'x',
    89: 'y',
    90: 'z',
    91: 'Left Windows Key / Left ⌘',
    92: 'Right Windows Key',
    93: 'Windows Menu / Right ⌘',
    96: 'numpad 0',
    97: 'numpad 1',
    98: 'numpad 2',
    99: 'numpad 3',
    100: 'numpad 4',
    101: 'numpad 5',
    102: 'numpad 6',
    103: 'numpad 7',
    104: 'numpad 8',
    105: 'numpad 9',
    106: 'multiply',
    107: 'add',
    109: 'subtract',
    110: 'decimal point',
    111: 'divide',
    112: 'f1',
    113: 'f2',
    114: 'f3',
    115: 'f4',
    116: 'f5',
    117: 'f6',
    118: 'f7',
    119: 'f8',
    120: 'f9',
    121: 'f10',
    122: 'f11',
    123: 'f12',
    124: 'f13',
    125: 'f14',
    126: 'f15',
    127: 'f16',
    128: 'f17',
    129: 'f18',
    130: 'f19',
    131: 'f20',
    132: 'f21',
    133: 'f22',
    134: 'f23',
    135: 'f24',
    144: 'num lock',
    145: 'scroll lock',
    186: '&semi;',
    187: '&equals;',
    188: '&comma;',
    189: '&hyphen;',
    190: '&period;',
    191: '&quest;',
    192: '&grave;',
    219: '&lsqb;',
    220: '&bsol;',
    221: '&rsqb;',
    222: '&apos;',
 };
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Benjamin Sergeant	73f4ba7ee7	Merge branch 'master' into feature/http	2019-02-28 21:53:52 -08:00
Benjamin Sergeant	6f39592c7b	Feature/send large message (#14 ) * introduce send fragment * can pass a fin frame * can send messages which are a perfect multiple of the chunk size * set fin only for last fragment * cleanup * last fragment should be of type CONTINUATION * Add simple send and receive programs * speedups receiving + better way to wait for thing * receive speedup by using linked list of chunks instead of large array * document bug * use chunks to receive data * trailing spaces	2019-02-28 21:46:58 -08:00
Benjamin Sergeant	38200fc5d7	doc	2019-02-28 21:43:09 -08:00
Benjamin Sergeant	285c12775a	cleanup	2019-02-28 21:18:27 -08:00
Benjamin Sergeant	6d56f7223a	http gzip compression	2019-02-27 18:02:45 -08:00
Benjamin Sergeant	1db3568375	add missing file	2019-02-27 16:41:48 -08:00
Benjamin Sergeant	0a752e7d18	cleanup argument parsing + add socket creation factory	2019-02-27 16:35:00 -08:00
Benjamin Sergeant	7c2bc2cf7e	make README vim markdown plugin friendly	2019-02-26 18:50:42 -08:00
Benjamin Sergeant	79f601ac65	follow redirects is optional	2019-02-25 22:01:04 -08:00
Benjamin Sergeant	069eccf415	chunk encoding / simple redirect support / -I option	2019-02-25 21:50:42 -08:00
Benjamin Sergeant	b563541b14	can specify extra headers	2019-02-25 17:17:05 -08:00
Benjamin Sergeant	3bcd6f97a6	simple HTTP post support (urlencode parameters)	2019-02-25 15:55:38 -08:00
Benjamin Sergeant	c04bc3cdfc	move http_client to a ws sub-command	2019-02-23 09:52:19 -08:00
Benjamin Sergeant	846f0c680a	linux build fix	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	c552a03ef0	linux build fix	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	0f175143c9	Update README.md	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	85569cb401	mv cobra_publisher under ws folder	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	bd854553d4	ping pong added to ws	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	38c57e1ed2	comments	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	26cc5025fb	add gitignore	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	806cf39efc	add echo and broadcast server as ws sub-commands	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	daaa7ec704	cleanup	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	3cffc6f9a5	add ws_chat and ws_connect sub commands to ws	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	f8b1a03ee6	all CMakeLists are referenced by the top level one	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	a7ff3c41a1	add target for building with homebrew	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	78dbba5521	Feature/ws cli (#15 ) * New command line tool for transfering files / still very beta. * add readme * use cli11 for argument parsing * json -> msgpack * stop using base64 and use binary which can be stored in message pack	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	b211bdbe38	Update README.md Add note about message fragmentation.	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	a0a53ab986	Feature/send large message (#14 ) * introduce send fragment * can pass a fin frame * can send messages which are a perfect multiple of the chunk size * set fin only for last fragment * cleanup * last fragment should be of type CONTINUATION * Add simple send and receive programs * speedups receiving + better way to wait for thing * receive speedup by using linked list of chunks instead of large array * document bug * use chunks to receive data * trailing spaces	2019-02-23 09:48:00 -08:00
Benjamin Sergeant	8d819053ff	document bug	2019-02-23 09:47:15 -08:00
Benjamin Sergeant	e20ddc2a08	unittest for sending large messages	2019-02-23 09:47:15 -08:00
Benjamin Sergeant	c415ba9427	Update formatting in README.md	2019-02-23 09:47:15 -08:00
Benjamin Sergeant	e881b82511	Update README.md	2019-02-22 21:53:29 -08:00
Benjamin Sergeant	d5551e5d68	mv cobra_publisher under ws folder	2019-02-22 21:51:03 -08:00
Benjamin Sergeant	e8583000b8	ping pong added to ws	2019-02-22 21:47:57 -08:00
Benjamin Sergeant	d642ef1a89	comments	2019-02-22 21:27:49 -08:00
Benjamin Sergeant	2df118022d	add gitignore	2019-02-22 21:26:25 -08:00
Benjamin Sergeant	95457c8f4c	add echo and broadcast server as ws sub-commands	2019-02-22 21:25:56 -08:00
Benjamin Sergeant	0a45b7787f	cleanup	2019-02-22 20:51:22 -08:00
Benjamin Sergeant	b8c397e180	add ws_chat and ws_connect sub commands to ws	2019-02-22 20:49:26 -08:00
Benjamin Sergeant	90105fa2b3	all CMakeLists are referenced by the top level one	2019-02-21 22:21:29 -08:00
Benjamin Sergeant	24859fef8a	add target for building with homebrew	2019-02-21 22:05:30 -08:00
Benjamin Sergeant	73d7280723	Feature/ws cli (#15 ) * New command line tool for transfering files / still very beta. * add readme * use cli11 for argument parsing * json -> msgpack * stop using base64 and use binary which can be stored in message pack	2019-02-21 21:24:53 -08:00
Benjamin Sergeant	262de49c3c	Update README.md Add note about message fragmentation.	2019-02-21 14:08:27 -08:00
Benjamin Sergeant	3a77e96a05	Feature/send large message (#14 ) * introduce send fragment * can pass a fin frame * can send messages which are a perfect multiple of the chunk size * set fin only for last fragment * cleanup * last fragment should be of type CONTINUATION * Add simple send and receive programs * speedups receiving + better way to wait for thing * receive speedup by using linked list of chunks instead of large array * document bug * use chunks to receive data * trailing spaces	2019-02-20 18:59:07 -08:00
Benjamin Sergeant	505dd6d50f	document bug	2019-02-16 10:33:37 -08:00
Benjamin Sergeant	3f8027b65c	unittest for sending large messages	2019-02-16 10:32:02 -08:00
Benjamin Sergeant	0b7c3ec235	can GET some pages	2019-02-14 20:11:42 -08:00
Benjamin Sergeant	29c96f287f	linux compile fix	2019-02-14 10:20:10 -08:00
Benjamin Sergeant	2a17cad1bf	add skeleton and broken http client code. GET returns "Resource temporarily unavailable" errors...	2019-02-14 10:14:57 -08:00
Benjamin Sergeant	0f2c765f45	Update formatting in README.md	2019-02-05 23:04:45 -08:00
Benjamin Sergeant	49077f8f44	more conf in CI	2019-01-29 17:50:19 -08:00
Benjamin Sergeant	6a23b8530f	get free port that can be used by non root users (> 1024)	2019-01-28 15:24:19 -08:00
Benjamin Sergeant	ae841af91a	use dynamically generated port number to configure servers in unittest	2019-01-28 15:24:19 -08:00
Benjamin Sergeant	44f38849b2	Merge pull request #13 from machinezone/user/bsergeant/poll User/bsergeant/poll	2019-01-27 10:47:38 -08:00
Benjamin Sergeant	ee12fbdb5f	windows build fix	2019-01-27 10:46:02 -08:00
Benjamin Sergeant	316c630830	constexpr to declare number of fds	2019-01-26 21:01:36 -08:00
Benjamin Sergeant	1ea5db6110	linux fix	2019-01-26 20:57:48 -08:00
Benjamin Sergeant	986d9a00c0	remove shutdown call	2019-01-26 20:54:23 -08:00
Benjamin Sergeant	7a05a11014	rebase poll branch	2019-01-26 20:50:25 -08:00
Benjamin Sergeant	f09434263c	insensitive string compare when validating server connection header	2019-01-25 16:17:51 -08:00
Benjamin Sergeant	335f594165	Merge pull request #12 from machinezone/user/bsergeant/heart-beat Add an optional heartbeat	2019-01-25 16:14:28 -08:00
Benjamin Sergeant	fa7ef06f4d	heartbeat correct	2019-01-25 16:11:39 -08:00
Benjamin Sergeant	3c9ec0aed0	close server socket on exit	2019-01-24 21:16:32 -08:00
Benjamin Sergeant	c665d65cba	unittest fix	2019-01-24 19:54:10 -08:00
Benjamin Sergeant	5d4e897cc4	add an heartbeat test	2019-01-24 18:50:07 -08:00
Benjamin Sergeant	05033714bf	hearbeat	2019-01-24 12:42:49 -08:00
Benjamin Sergeant	a02bd3f25c	Update README.md	2019-01-15 09:36:43 -08:00
Benjamin Sergeant	fdbd213fa2	check and validate the Connection: Upgrade header in client/server	2019-01-15 09:31:37 -08:00
Benjamin Sergeant	da64d349c8	Merge pull request #10 from tonylin0826/master Fix missing "Upgrade" header error	2019-01-15 09:22:11 -08:00
Tony Lin	17b01a8c66	Fix missing upgrade header error	2019-01-15 15:35:37 +08:00
Benjamin Sergeant	79dd766fab	C++14 + use make_unique and make_shared to make shared pointers	2019-01-11 21:25:06 -08:00
Benjamin Sergeant	8375b28747	add travis badge	2019-01-08 10:13:23 -08:00
Benjamin Sergeant	e12551f309	travis -> osx	2019-01-08 10:04:47 -08:00
Benjamin Sergeant	6102f81710	Revert "Revert "try asan on Linux"" [Back to asan on Linux] This reverts commit `02a704a8c7`.	2019-01-07 21:13:48 -08:00
Benjamin Sergeant	9f678e5962	travis-ci: try to use clang on Linux	2019-01-07 20:49:03 -08:00
Benjamin Sergeant	02a704a8c7	Revert "try asan on Linux" This reverts commit `dd2360ed70`.	2019-01-07 20:47:25 -08:00
Benjamin Sergeant	dd2360ed70	try asan on Linux	2019-01-07 18:29:44 -08:00
Benjamin Sergeant	c4ab996470	build with osx on travis	2019-01-07 18:16:29 -08:00
Benjamin Sergeant	6c54b07d92	fix simple compile error in test/IXTest.h	2019-01-07 18:08:11 -08:00
Benjamin Sergeant	7f9bef3b8d	add a travis file for real	2019-01-07 18:05:55 -08:00
Benjamin Sergeant	12d1c5d956	add a travis file	2019-01-07 18:04:28 -08:00
Benjamin Sergeant	e9a4bd5617	update test remote ws url	2019-01-07 11:28:53 -08:00
Benjamin Sergeant	f34ccbfdb5	remove cmake sanitizer submodule	2019-01-07 11:26:23 -08:00
Benjamin Sergeant	1fa75d7fb2	check select errors better	2019-01-07 11:18:00 -08:00
Benjamin Sergeant	39140ef98c	sanitizer cmake stuff	2019-01-06 18:54:16 -08:00
Benjamin Sergeant	e30ef4a87c	DNSLookup _id member does not need to be an atomic	2019-01-06 18:32:19 -08:00
Benjamin Sergeant	9fc94f0487	DNSLookup: fix #8	2019-01-06 18:27:26 -08:00
Benjamin Sergeant	121acdab6f	DNSLookup: copy hostname and port instead of accessing member	2019-01-06 18:17:12 -08:00
Benjamin Sergeant	6deaa03114	return false -> return -1	2019-01-06 18:10:39 -08:00
Benjamin Sergeant	f4f30686c5	add new unittest	2019-01-06 15:14:13 -08:00
Benjamin Sergeant	a21aae521f	remove dead file	2019-01-06 14:26:11 -08:00
Benjamin Sergeant	aed2356fc1	remove openssl testing bits for apple build	2019-01-06 14:21:49 -08:00
Benjamin Sergeant	a478f734f6	gcc linux compile fix	2019-01-06 12:12:39 -08:00
Benjamin Sergeant	98c579da03	make a class hierarchy for server code (IXWebSocketServer <- IXSocketServer)	2019-01-06 12:09:31 -08:00
Benjamin Sergeant	e80def0cd0	add log	2019-01-05 21:16:13 -08:00
Benjamin Sergeant	cc8a9e883e	unittest + compiler warnings	2019-01-05 21:10:08 -08:00
Benjamin Sergeant	4d587e35d8	windows compile fix	2019-01-05 21:02:55 -08:00
Benjamin Sergeant	50f4fd1115	int -> ssize_t for socker recv and send	2019-01-05 20:53:50 -08:00
Benjamin Sergeant	06d2b68696	header refactoring	2019-01-05 20:38:43 -08:00
Benjamin Sergeant	bf6f057777	windows connect (compile fix)	2019-01-05 17:35:50 -08:00
Benjamin Sergeant	b57c1d69f2	windows connect potential fix	2019-01-05 17:32:21 -08:00
Benjamin Sergeant	ff265d83f9	more accurate description of errors	2019-01-05 17:18:43 -08:00
Benjamin Sergeant	5b1c97b774	SocketTest / more debug info	2019-01-05 17:10:01 -08:00
Benjamin Sergeant	c8c81366f7	windows (compile) fix	2019-01-05 17:04:09 -08:00
Benjamin Sergeant	9a37fd56d1	windows fix	2019-01-05 17:02:39 -08:00
Benjamin Sergeant	7ecaff8c5d	test failure is not noticed	2019-01-05 16:30:22 -08:00
Benjamin Sergeant	e4b0286a25	fix gcc warning	2019-01-05 16:26:11 -08:00
Benjamin Sergeant	7ae6972306	makefile tweak	2019-01-05 14:43:21 -08:00
Benjamin Sergeant	59cea0372b	add dns lookup test	2019-01-05 14:40:17 -08:00
Benjamin Sergeant	78d88a8520	openssl cleanup	2019-01-05 11:42:25 -08:00
Benjamin Sergeant	273af25d57	Merge pull request #7 from bsergean/user/bsergeant/appveyor_first unittest on appveyor	2019-01-04 17:29:23 -08:00
Benjamin Sergeant	46d00360a8	unittest on appveyor	2019-01-04 17:28:13 -08:00
Benjamin Sergeant	3f5935a284	windows fixes	2019-01-04 15:23:57 -08:00
Benjamin Sergeant	c236ff66e9	Merge pull request #6 from machinezone/user/bsergeant/server Add support for writing websocket servers (IXWebSocketServer)	2019-01-03 18:47:30 -08:00
Benjamin Sergeant	af3df5e519	Socket::readLine works with arbitrary long lines	2019-01-03 18:47:01 -08:00
Benjamin Sergeant	d75753ec98	timeout is configurable	2019-01-03 18:33:08 -08:00
Benjamin Sergeant	332bb87231	remove useless FIXME comment	2019-01-03 18:02:03 -08:00
Benjamin Sergeant	8adbcab441	new doc	2019-01-03 18:00:48 -08:00
Benjamin Sergeant	9bc2e95196	capture path/uri when connecting, and pass it back through callbacks in the openInfo member	2019-01-03 17:44:10 -08:00
Benjamin Sergeant	30a0aa0a0f	implement a max connections (default = 32) settings	2019-01-03 17:05:44 -08:00
Benjamin Sergeant	8622ea5cb2	correct validation of the request (request line + headers)	2019-01-03 13:41:06 -08:00
Benjamin Sergeant	ed3a50d9b5	cancellation refactoring	2019-01-03 12:53:44 -08:00
Benjamin Sergeant	df6a17dcc2	rename test file	2019-01-02 21:59:06 -08:00
Benjamin Sergeant	474985e784	split handshake code into its own files, so that Transport file is less massive	2019-01-02 20:07:54 -08:00
Benjamin Sergeant	cb904416c3	server unittest for validating client request / new timeout cancellation handling (need refactoring)	2019-01-02 16:08:32 -08:00
Benjamin Sergeant	3e064ec63e	add new broadcast server example	2019-01-02 08:17:03 -08:00
Benjamin Sergeant	b004769552	server per message deflate support	2019-01-02 08:12:29 -08:00
Benjamin Sergeant	17270de621	echo server example is a real echo server, not a broadcast server	2019-01-02 08:10:39 -08:00
Benjamin Sergeant	239b5bc02c	refactoring + cancellation was buggy during http upgrade	2019-01-02 07:45:07 -08:00
Benjamin Sergeant	6bfabd5493	use select to detect new incoming connections	2019-01-01 22:21:07 -08:00
Benjamin Sergeant	0b90f7df1b	add a way to run in blocking more, which is useful for server mode to have Nthread instead of 2Nthread for N connections	2019-01-01 21:25:15 -08:00
Benjamin Sergeant	00ca7c8fb0	more named constants	2019-01-01 19:23:27 -08:00
Benjamin Sergeant	a11952fe22	gitignore stuff	2019-01-01 17:14:31 -08:00
Benjamin Sergeant	06b9b2e649	linux fix + unittest works with Linux	2019-01-01 17:13:26 -08:00
Benjamin Sergeant	dcfdcc3e1b	unittest starts a server	2019-01-01 16:34:05 -08:00
Benjamin Sergeant	b13fee16c1	crash when server failed to start	2019-01-01 16:14:46 -08:00
Benjamin Sergeant	9a7767ecb1	thread accepting connections can be cancelled/stopped externally	2019-01-01 16:11:27 -08:00
Benjamin Sergeant	9b82a33aff	listen job run in its own thread, non blocking	2019-01-01 14:52:14 -08:00
Benjamin Sergeant	70ef77a5d5	(nitpick) reformat	2019-01-01 14:29:57 -08:00
Benjamin Sergeant	77903e9d90	cleanup / remove printf, add mutex, remove hardcoded values, can pass in a binding host	2019-01-01 14:28:41 -08:00
Benjamin Sergeant	de66a87a7c	use shared_ptr	2019-01-01 13:53:13 -08:00
Benjamin Sergeant	5ea2028c22	unittest pass	2019-01-01 13:47:25 -08:00
Benjamin Sergeant	58a68ec0be	record workers in a map instead of a vector	2018-12-31 14:52:59 -08:00
Benjamin Sergeant	a39278f7be	add a print statement when the connection is closed / still need to terminate server thread	2018-12-31 12:47:42 -08:00
Benjamin Sergeant	f8373dc666	more cleanup to propagate server connection error and let onOpen callback execute	2018-12-31 12:43:47 -08:00
Benjamin Sergeant	3febc2431d	only bind to localhost	2018-12-31 11:48:49 -08:00
Benjamin Sergeant	0bf736831a	server code has a callback that takes a websocket	2018-12-30 22:12:13 -08:00
Benjamin Sergeant	7710bf793f	cleanup / use a websocket instead of raw websockettransport	2018-12-30 22:00:49 -08:00
Benjamin Sergeant	a6a43bd361	can accept multiple connection / server can send data back to client	2018-12-30 21:16:05 -08:00
Benjamin Sergeant	a39209a895	proof of concept server implementation	2018-12-29 23:15:27 -08:00
Benjamin Sergeant	24c9e0abc3	can create a socket from a fd	2018-12-29 21:53:33 -08:00
Benjamin Sergeant	9cc324d78d	add simple unittest	2018-12-29 18:34:08 -08:00
Benjamin Sergeant	8574beceb1	add missing src files (IXSetThreadName.{cpp,h}) ...	2018-12-23 14:19:30 -08:00
Benjamin Sergeant	0349b7f1c7	fix warning: field '_eventCallback' will be initialized after field '_publishMode'	2018-12-23 14:18:53 -08:00
Benjamin Sergeant	ce1ba20db5	Fix warning: field '_done' will be initialized after field '_wait' [-Wreorder] _done(false),	2018-12-23 14:17:30 -08:00
Benjamin Sergeant	395d823f41	set thread name / rename example	2018-12-23 14:14:38 -08:00
Benjamin Sergeant	6884f9f74f	async dns lookup fix	2018-12-14 17:49:42 -08:00
Benjamin Sergeant	b34eccd749	non blocking dns lookup	2018-12-14 16:28:17 -08:00
Benjamin Sergeant	50b638f7fd	add cancellation support while connecting, to speed up WebSocket::stop	2018-12-09 17:56:20 -08:00
Benjamin Sergeant	5bf1b91528	http upgrade and connections use non blocking sockets	2018-12-09 14:07:40 -08:00
Benjamin Sergeant	f77ececc92	threading race condition fixes, detected by TSAN	2018-12-06 08:27:28 -08:00
Benjamin Sergeant	58cccbdcf9	cleanup	2018-11-14 15:52:28 -08:00
Benjamin Sergeant	5710ffba6a	per-message deflate compression fixes	2018-11-13 17:46:05 -08:00
Benjamin Sergeant	ccd4522b8f	move files around	2018-11-12 17:56:59 -08:00
Benjamin Sergeant	28f29b7385	update readme / remove reference to missing compression support now that it is supported ...	2018-11-12 09:01:42 -08:00
Benjamin Sergeant	a7a422d6ed	tweaks doc / license + send proper error code when closing the connecion	2018-11-12 09:00:55 -08:00
Benjamin Sergeant	43fcf93584	per message deflate support (with zlib)	2018-11-09 18:42:09 -08:00
Benjamin Sergeant	32f4c8305e	(satori_publisher) better error handling	2018-11-07 14:54:44 -08:00
Benjamin Sergeant	3cf44c8078	Add some example shell scripts to build on Linux	2018-11-07 12:33:33 -08:00
Benjamin Sergeant	9e899fde2f	Add new example folder for publishing events to satori, with a minimal satori sdk	2018-11-07 12:26:32 -08:00
Benjamin Sergeant	ffd4f1d322	Add missing files ...	2018-11-07 12:25:38 -08:00
Benjamin Sergeant	10dd13deb3	Add DockerFile + parse rsv1 field	2018-11-07 11:45:17 -08:00
Benjamin Sergeant	c1ed83a005	stopping connection on Linux does not close the socket, which can create problem when re-starting the connection	2018-11-01 17:02:49 -07:00
Benjamin Sergeant	7117c74142	add stop and start directives to ws_connect + display close info	2018-10-31 10:27:17 -07:00
Benjamin Sergeant	dd06a3fb25	update readme.md	2018-10-27 11:46:11 -07:00
Benjamin Sergeant	45b579447e	Handle Sec-WebSocket-Accept correctly	2018-10-27 10:24:48 -07:00
Benjamin Sergeant	bb0b1836cd	capture an error code and a reason when the server closes the connection	2018-10-25 18:51:19 -07:00
Benjamin Sergeant	d5c8815438	add doc about ping/pong	2018-10-25 15:14:31 -07:00
Benjamin Sergeant	ac500ed079	ping pong example: more error handling	2018-10-25 14:46:23 -07:00
Benjamin Sergeant	2bc38acbb1	ping / pong support / fix bug in dispatching received message type	2018-10-25 14:43:35 -07:00
Benjamin Sergeant	977feae1d6	Better ping/pong support	2018-10-25 14:43:35 -07:00
Benjamin Sergeant	9c872fcc3e	New ws_connect example. Close to wscat node.js tool.	2018-10-25 14:43:35 -07:00
Benjamin Sergeant	ec1ca3c55e	Update README.md	2018-10-08 21:50:55 -07:00
Benjamin Sergeant	16805759d3	Windows support (no TLS yet)	2018-10-08 21:44:54 -07:00
Benjamin Sergeant	88c2e1f6de	make TLS support optional	2018-10-08 15:24:36 -07:00
Benjamin Sergeant	1dc9b559e9	move examples around	2018-10-08 15:24:36 -07:00
Benjamin Sergeant	d31ecfc64e	Update IXWebSocket.h Remove dead code	2018-10-07 15:49:07 -07:00
Benjamin Sergeant	4813a40f2a	Update README.md Advanced usage -> API	2018-10-07 15:47:38 -07:00
Benjamin Sergeant	ea81470f4a	more ssl peer validation stuff	2018-10-05 18:45:44 -07:00
Benjamin Sergeant	2a6b1d5f15	Update README.md	2018-10-05 14:35:09 -07:00
Benjamin Sergeant	10ce046b0f	(openssl) verify that the certificate we are getting match the domain we are requesting	2018-10-05 12:08:45 -07:00
Benjamin Sergeant	96903b4d25	Improve doc and examples related to error handling	2018-10-02 12:29:14 -07:00
Benjamin Sergeant	8f5d83c5c2	(openssl) add sni support	2018-10-01 17:36:21 -07:00
Benjamin Sergeant	09af729c07	g++ build fixes	2018-10-01 14:46:11 -07:00
Benjamin Sergeant	9b007b1a6a	doc tweak	2018-09-27 15:43:31 -07:00
Benjamin Sergeant	863f0517a2	readme tweaks	2018-09-27 15:34:18 -07:00
Benjamin Sergeant	9b8d6cedfe	First import	2018-09-27 14:57:19 -07:00
Benjamin Sergeant	65bd7d5b4c	first commit	2018-09-27 14:54:41 -07:00
		`@@ -0,0 +1 @@`
							`ws_receive is a simple server upload program. It needs to be used in conjonction with ws_send.`
		`@@ -0,0 +1 @@`
							`ws_send is a simple upload program. It needs to be used in conjonction with ws_receive.`