win code runs

non blocking
bring includes from rtm
2018-10-08 21:31:02 -07:00 · 2018-10-08 20:20:09 -07:00 · 2018-10-08 20:17:31 -07:00 · 2018-10-08 18:42:56 -07:00 · 2018-10-08 18:27:32 -07:00 · 2018-10-08 18:24:40 -07:00
49 changed files with 21659 additions and 11807 deletions
@@ -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,46 @@
 #
 # cmd_websocket_chat.cpp
 # 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 11)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 set( IXWEBSOCKET_SOURCES
    ixwebsocket/IXSocket.cpp
    ixwebsocket/IXWebSocket.cpp
    ixwebsocket/IXWebSocketTransport.cpp
 )
 set( IXWEBSOCKET_HEADERS
    ixwebsocket/IXSocket.h
    ixwebsocket/IXWebSocket.h
    ixwebsocket/IXWebSocketTransport.h
 )
 if (USE_TLS)
    add_definitions(-DIXWEBSOCKET_USE_TLS)
    if (APPLE)
        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.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}
 )
 set( IXWEBSOCKET_INCLUDE_DIRS
    .
    ../../shared/OpenSSL/include)
 target_include_directories( ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS} )
@@ -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,168 @@
 # General
 ## Introduction
 [*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex
 communication channels over a single TCP connection. This library provides a C++ library for Websocket communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient).
 ## Examples
 The examples folder countains a simple chat program, using a node.js broadcast server.
 Here is what the API looks like.
 ```
 ix::WebSocket webSocket;
 std::string url("ws://localhost:8080/");
 webSocket.configure(url);
 // 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, ix::WebSocketErrorInfo error)
    {
        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()
 ```
 ## 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.
 ## Implementation details
 ### 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.
 ## Limitations
 * There is no per message compression support. That could be useful for retrieving large messages, but could also be implemented at the application level.
 * 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.
 ## Examples
 1. Bring up a terminal and jump to the examples folder.
 2. Compile the example C++ code. `sh build.sh`
 3. Install node.js from [here](https://nodejs.org/en/download/).
 4. Type `npm install` to install the node.js dependencies. Then `node broadcast-server.js` to run the server.
 5. Bring up a second terminal. `env USER=bob ./cmd_websocket_chat`
 6. Bring up a third terminal. `env USER=bill ./cmd_websocket_chat`
 7. Start typing things in any of those terminals. Hopefully you should see your message being received on the other end.
 ## C++ code organization
 Here's a simplistic diagram which explains how the code is structured in term of class/modules.
 ```
 +-----------------------+
 |                       | Start the receiving Background thread. Auto reconnection. Simple websocket Ping.
 |  IXWebSocket          | Interface used by C++ test clients. No IX dependencies.
 |                       | 
 +-----------------------+
 |                       |
 |  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
 |                       |
 +-----------------------+
 |                       |
 |  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.
 +-----------------------+
 ```
 ## 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 couldn't 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(
    [this](ix::WebSocketMessageType messageType, const std::string& str, ix::WebSocketErrorInfo error)
    {
        if (messageType == ix::WebSocket_MessageType_Open)
        {
            puts("send greetings");
        }
        else if (messageType == ix::WebSocket_MessageType_Close)
        {
            puts("disconnected");
        }
    }
 );
 ```
 ### 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(
    [this](ix::WebSocketMessageType messageType, const std::string& str, ix::WebSocketErrorInfo error)
    {
        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);
 ```
@@ -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,23 @@
 #
 # cmd_websocket_chat.cpp
 # Author: Benjamin Sergeant
 # Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
 #
 cmake_minimum_required (VERSION 3.4.1)
 project (cmd_websocket_chat)
 set (CMAKE_CXX_STANDARD 11)
 option(USE_TLS "Add TLS support" ON)
 add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
 add_executable(cmd_websocket_chat cmd_websocket_chat.cpp)
 if (APPLE AND USE_TLS)
    target_link_libraries(cmd_websocket_chat "-framework foundation" "-framework security")
 endif()
 target_link_libraries(cmd_websocket_chat ixwebsocket)
 install(TARGETS cmd_websocket_chat DESTINATION bin)
@@ -0,0 +1,39 @@
 # Building
 1. cmake -G .
 2. make
 ## Disable TLS
 chat$ cmake -DUSE_TLS=OFF .
 -- Configuring done
 -- Generating done
 -- Build files have been written to: /Users/bsergeant/src/foss/ixwebsocket/examples/chat
 chat$ make
 Scanning dependencies of target ixwebsocket
 [ 16%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXSocket.cpp.o
 [ 33%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXWebSocket.cpp.o
 [ 50%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXWebSocketTransport.cpp.o
 [ 66%] Linking CXX static library libixwebsocket.a
 [ 66%] Built target ixwebsocket
 [ 83%] Linking CXX executable cmd_websocket_chat
 [100%] Built target cmd_websocket_chat
 ## Enable TLS (default)
 ```
 chat$ cmake -DUSE_TLS=ON .
 -- Configuring done
 -- Generating done
 -- Build files have been written to: /Users/bsergeant/src/foss/ixwebsocket/examples/chat
 (venv) chat$ make
 Scanning dependencies of target ixwebsocket
 [ 14%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXSocket.cpp.o
 [ 28%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXWebSocket.cpp.o
 [ 42%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXWebSocketTransport.cpp.o
 [ 57%] Building CXX object ixwebsocket/CMakeFiles/ixwebsocket.dir/ixwebsocket/IXSocketAppleSSL.cpp.o
 [ 71%] Linking CXX static library libixwebsocket.a
 [ 71%] Built target ixwebsocket
 [ 85%] Linking CXX executable cmd_websocket_chat
 [100%] Built target cmd_websocket_chat
 ```
@@ -0,0 +1,28 @@
 /*
 *  cmd_websocket_chat.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 const WebSocket = require('ws');
 const wss = new WebSocket.Server({ port: 8080 });
 // Broadcast to all.
 wss.broadcast = function broadcast(data) {
  wss.clients.forEach(function each(client) {
    if (client.readyState === WebSocket.OPEN) {
      client.send(data);
    }
  });
 };
 wss.on('connection', function connection(ws) {
  ws.on('message', function incoming(data) {
    // Broadcast to everyone else.
    wss.clients.forEach(function each(client) {
      if (client !== ws && client.readyState === WebSocket.OPEN) {
        client.send(data);
      }
    });
  });
 });
@@ -0,0 +1,17 @@
 #!/bin/sh
 #
 # Author: Benjamin Sergeant
 # Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 #
 # 'manual' way of building. You can also use cmake.
 clang++ --std=c++11 --stdlib=libc++ \
    ../../ixwebsocket/IXSocket.cpp	\
    ../../ixwebsocket/IXWebSocketTransport.cpp \
    ../../ixwebsocket/IXSocketAppleSSL.cpp	\
    ../../ixwebsocket/IXWebSocket.cpp \
    cmd_websocket_chat.cpp \
    -o cmd_websocket_chat \
    -framework Security \
    -framework Foundation
@@ -0,0 +1,195 @@
 /*
 *  cmd_websocket_chat.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 //
 // Simple chat program that talks to the node.js server at
 // websocket_chat_server/broacast-server.js
 //
 #include <iostream>
 #include <sstream>
 #include <queue>
 #include <ixwebsocket/IXWebSocket.h>
 #include <ixwebsocket/IXSocket.h>
 #include "nlohmann/json.hpp"
 // for convenience
 using json = nlohmann::json;
 using namespace ix;
 namespace
 {
    void log(const std::string& msg)
    {
        std::cout << msg << std::endl;
    }
    class WebSocketChat
    {
        public:
            WebSocketChat(const std::string& user);
            void subscribe(const std::string& channel);
            void start();
            void stop();
            bool isReady() const;
            void sendMessage(const std::string& text);
            size_t getReceivedMessagesCount() const;
            std::string encodeMessage(const std::string& text);
            std::pair<std::string, std::string> decodeMessage(const std::string& str);
        private:
            std::string _user;
            ix::WebSocket _webSocket;
            std::queue<std::string> _receivedQueue;
    };
    WebSocketChat::WebSocketChat(const std::string& user) :
        _user(user)
    {
        ;
    }
    size_t WebSocketChat::getReceivedMessagesCount() const
    {
        return _receivedQueue.size();
    }
    bool WebSocketChat::isReady() const
    {
        return _webSocket.getReadyState() == ix::WebSocket_ReadyState_Open;
    }
    void WebSocketChat::stop()
    {
        _webSocket.stop();
    }
    void WebSocketChat::start()
    {
        std::string url("ws://localhost:8080/");
        _webSocket.configure(url);
        std::stringstream ss;
        log(std::string("Connecting to url: ") + url);
        _webSocket.setOnMessageCallback(
            [this](ix::WebSocketMessageType messageType, const std::string& str, ix::WebSocketErrorInfo error)
            {
                std::stringstream ss;
                if (messageType == ix::WebSocket_MessageType_Open)
                {
                    ss << "cmd_websocket_chat: user "
                       << _user
                       << " Connected !";
                       log(ss.str());
                }
                else if (messageType == ix::WebSocket_MessageType_Close)
                {
                    ss << "cmd_websocket_chat: user "
                       << _user
                       << " disconnected !";
                       log(ss.str());
                }
                else if (messageType == ix::WebSocket_MessageType_Message)
                {
                    auto result = decodeMessage(str);
                    // Our "chat" / "broacast" node.js server does not send us
                    // the messages we send, so we don't have to filter it out.
                    // store text
                    _receivedQueue.push(result.second);
                    ss << std::endl 
                       << result.first << " > " << result.second
                       << std::endl
                       << _user << " > ";
                    log(ss.str());
                }
                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();
    }
    std::pair<std::string, std::string> WebSocketChat::decodeMessage(const std::string& str)
    {
        auto j = json::parse(str);
        std::string msg_user = j["user"];
        std::string msg_text = j["text"];
        return std::pair<std::string, std::string>(msg_user, msg_text);
    }
    std::string WebSocketChat::encodeMessage(const std::string& text)
    {
        json j;
        j["user"] = _user;
        j["text"] = text;
        std::string output = j.dump();
        return output;
    }
    void WebSocketChat::sendMessage(const std::string& text)
    {
        _webSocket.send(encodeMessage(text));
    }
    void interactiveMain()
    {
        std::string user("foo");
        std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
        WebSocketChat webSocketChat(user);
        webSocketChat.start();
        while (true)
        {
            std::string text;
            std::cout << user << " > " << std::flush;
            std::getline(std::cin, text);
            if (!std::cin)
            {
                break;
            }
            webSocketChat.sendMessage(text);
        }
        std::cout << std::endl;
        webSocketChat.stop();
    }
 }
 int main()
 {
    std::cout << "main starting" << std::endl;
    Socket::init();
    std::cout << "socket initialized" << std::endl;
    interactiveMain();
    return 0;
 }
@@ -0,0 +1,6 @@
 {
  "dependencies": {
    "msgpack-js": "^0.3.0",
    "ws": "^3.1.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,298 @@
 /*
 *  IXSocket.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXSocket.h"
 #ifdef _WIN32
 # include <basetsd.h>
 # include <WinSock2.h>
 # include <ws2def.h>
 # include <WS2tcpip.h>
 # include <io.h>
 #pragma comment(lib, "ws2_32")
 # include <io.h>
 #else
 # include <unistd.h>
 # include <errno.h>
 # include <netdb.h>
 # include <netinet/tcp.h>
 # include <sys/socket.h>
 # include <sys/time.h>
 # include <sys/select.h>
 # include <sys/stat.h>
 #endif
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
 #include <stdint.h>
 #include <fcntl.h>
 #include <sys/types.h>
 #include <algorithm>
 //
 // 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
 //
 // 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
 //
 #ifdef __linux__
 # include <sys/eventfd.h>
 #endif
 // Android needs extra headers for TCP_NODELAY and IPPROTO_TCP
 #ifdef ANDROID
 # include <linux/in.h>
 # include <linux/tcp.h>
 #endif
 namespace ix 
 {
    Socket::Socket() : 
        _sockfd(-1),
        _eventfd(-1)
    {
 #ifdef __linux__
        _eventfd = eventfd(0, 0);
        assert(_eventfd != -1 && "Panic - eventfd not functioning on this platform");
 #endif
    }
    Socket::~Socket()
    {
        close();
 #ifdef __linux__
        ::close(_eventfd);
 #endif
    }
    bool Socket::connectToAddress(const struct addrinfo *address, 
                                  int& sockfd,
                                  std::string& errMsg)
    {
        sockfd = -1;
        int fd = socket(address->ai_family,
                        address->ai_socktype,
                        address->ai_protocol);
        if (fd < 0)
        {
            errMsg = "Cannot create a socket";
            return false;
        }
        int maxRetries = 3;
        for (int i = 0; i < maxRetries; ++i)
        {
            if (::connect(fd, address->ai_addr, address->ai_addrlen) != -1)
            {
                sockfd = fd;
                return true;
            }
            // EINTR means we've been interrupted, in which case we try again.
            if (errno != EINTR) break;
        }
        closeSocket(fd);
        sockfd = -1;
        errMsg = strerror(errno);
        return false;
    }
    int Socket::hostname_connect(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 = nullptr;
        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(), 
                                             &hints, &res);
        if (getaddrinfo_result)
        {
            errMsg = gai_strerror(getaddrinfo_result);
            return -1;
        }
        int sockfd = -1;
        // iterate through the records to find a working peer
        struct addrinfo *address;
        bool success = false;
        for (address = res; address != nullptr; address = address->ai_next)
        {
            success = connectToAddress(address, sockfd, errMsg);
            if (success)
            {
                break;
            }
        }
        freeaddrinfo(res);
        return sockfd;
    }
    void Socket::configure()
    {
        int flag = 1;
        setsockopt(_sockfd, IPPROTO_TCP, TCP_NODELAY, (char*) &flag, sizeof(flag)); // Disable Nagle's algorithm
 #ifdef _WIN32
        unsigned long nonblocking = 1;
        ioctlsocket(_sockfd, FIONBIO, &nonblocking);
 #else
        fcntl(_sockfd, F_SETFL, O_NONBLOCK); // make socket non blocking
 #endif
 #ifdef SO_NOSIGPIPE
        int value = 1;
        setsockopt(_sockfd, SOL_SOCKET, SO_NOSIGPIPE, 
                   (void *)&value, sizeof(value));
 #endif
    }
    void Socket::poll(const OnPollCallback& onPollCallback)
    {
        if (_sockfd == -1)
        {
            onPollCallback();
            return;
        }
        fd_set rfds;
        FD_ZERO(&rfds);
        FD_SET(_sockfd, &rfds);
 #ifdef __linux__
        FD_SET(_eventfd, &rfds);
 #endif
        int sockfd = _sockfd;
        int nfds = (std::max)(sockfd, _eventfd);
        select(nfds + 1, &rfds, nullptr, nullptr, nullptr);
        onPollCallback();
    }
    void Socket::wakeUpFromPollApple()
    {
        close(); // All OS but Linux will wake up select
                 // when closing the file descriptor watched by select
    }
    void Socket::wakeUpFromPollLinux()
    {
        std::string str("\n"); // this will wake up the thread blocked on select
        const void* buf = reinterpret_cast<const void*>(str.c_str());
        write(_eventfd, buf, str.size());
    }
    void Socket::wakeUpFromPoll()
    {
 #ifdef __APPLE__
        wakeUpFromPollApple();
 #elif defined(__linux__)
        wakeUpFromPollLinux();
 #endif
    }
    bool Socket::connect(const std::string& host,
                         int port,
                         std::string& errMsg)
    {
        std::lock_guard<std::mutex> lock(_socketMutex);
 #ifdef __linux__
        if (_eventfd == -1)
        {
            return false; // impossible to use this socket if eventfd is broken
        }
 #endif
        _sockfd = Socket::hostname_connect(host, port, errMsg);
        return _sockfd != -1;
    }
    void Socket::close()
    {
        std::lock_guard<std::mutex> lock(_socketMutex);
        if (_sockfd == -1) return;
        closeSocket(_sockfd);
        _sockfd = -1;
    }
    int Socket::send(char* buffer, size_t length)
    {
        int flags = 0;
 #ifdef MSG_NOSIGNAL
        flags = MSG_NOSIGNAL;
 #endif
        return (int) ::send(_sockfd, buffer, length, flags);
    }
    int Socket::send(const std::string& buffer)
    {
        return send((char*)&buffer[0], buffer.size());
    }
    int Socket::recv(void* buffer, size_t length)
    {
        int flags = 0;
 #ifdef MSG_NOSIGNAL
        flags = MSG_NOSIGNAL;
 #endif
        return (int) ::recv(_sockfd, (char*) buffer, length, flags);
    }
    int Socket::getErrno() const
    {
 #ifdef _WIN32
        return WSAGetLastError();
 #else
        return errno;
 #endif
    }
    void Socket::closeSocket(int fd)
    {
 #ifdef _WIN32
 	closesocket(fd);
 #else
        ::close(fd);
 #endif
    }
    // FIXME: need finalize
    bool Socket::init()
    {
 #ifdef _WIN32
        INT rc;
        WSADATA wsaData;
        rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
        return rc != 0;
 #endif
    }
 }
@@ -0,0 +1,63 @@
 /*
 *  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>
 struct addrinfo;
 namespace ix 
 {
    class Socket {
    public:
        using OnPollCallback = std::function<void()>;
        Socket();
        virtual ~Socket();
 	static bool init();
        int hostname_connect(const std::string& hostname,
                             int port,
                             std::string& errMsg);
        void configure();
        virtual void poll(const OnPollCallback& onPollCallback);
        virtual void wakeUpFromPoll();
        // Virtual methods
        virtual bool connect(const std::string& url, 
                             int port,
                             std::string& errMsg);
        virtual void close();
        virtual int send(char* buffer, size_t length);
        virtual int send(const std::string& buffer);
        virtual int recv(void* buffer, size_t length);
        int getErrno() const;
    protected:
        void wakeUpFromPollApple();
        void wakeUpFromPollLinux();
        void closeSocket(int fd);
        std::atomic<int> _sockfd;
        int _eventfd;
        std::mutex _socketMutex;
    private:
        bool connectToAddress(const struct addrinfo *address, 
                              int& sockfd,
                              std::string& errMsg);
    };
 }
@@ -0,0 +1,259 @@
 /*
 *  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 <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() : 
        _sslContext(nullptr)
    {
        ;
    }
    SocketAppleSSL::~SocketAppleSSL()
    {
        SocketAppleSSL::close();
    }
    // No wait support
    bool SocketAppleSSL::connect(const std::string& host,
                                 int port,
                                 std::string& errMsg)
    {
        OSStatus status;
        {
            std::lock_guard<std::mutex> lock(_mutex);
            _sockfd = Socket::hostname_connect(host, port, errMsg);
            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();
    }
    int 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 (int) ret;
    }
    int SocketAppleSSL::send(const std::string& buffer)
    {
        return send((char*)&buffer[0], buffer.size());
    }
    // No wait support
    int 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 (int) 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,38 @@
 /*
 *  IXSocketAppleSSL.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXSocket.h"
 #include <Security/Security.h>
 #include <Security/SecureTransport.h>
 #include <mutex>
 namespace ix 
 {
    class SocketAppleSSL : public Socket 
    {
    public:
        SocketAppleSSL();
        ~SocketAppleSSL();
        virtual bool connect(const std::string& host, 
                             int port,
                             std::string& errMsg) final;
        virtual void close() 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:
        SSLContextRef _sslContext;
        mutable std::mutex _mutex;  // AppleSSL routines are not thread-safe
    };
 }
@@ -0,0 +1,423 @@
 /*
 *  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 <cassert>
 #include <iostream>
 #include <openssl/x509v3.h>
 #include <fnmatch.h>
 #include <errno.h>
 #define socketerrno errno
 namespace {
 std::mutex initMutex;
 bool openSSLInitialized = false;
 bool openSSLInitializationSuccessful = false;
 bool openSSLInitialize(std::string& errMsg)
 {
    std::lock_guard<std::mutex> lock(initMutex);
    if (openSSLInitialized)
    {
        return openSSLInitializationSuccessful;
    }
 #if OPENSSL_VERSION_NUMBER >= 0x10100000L
    if (!OPENSSL_init_ssl(OPENSSL_INIT_LOAD_CONFIG, nullptr))
    {
        errMsg = "OPENSSL_init_ssl failure";
        openSSLInitializationSuccessful = false;
        openSSLInitialized = true;
        return false;
    }
 #else
    (void) OPENSSL_config(nullptr);
 #endif
    (void) OpenSSL_add_ssl_algorithms();
    (void) SSL_load_error_strings();
    openSSLInitializationSuccessful = true;
    return true;
 }
 int openssl_verify_callback(int preverify, X509_STORE_CTX *x509_ctx)
 {
    return preverify;
 }
 /* create new SSL connection state object */
 SSL *openssl_create_connection(SSL_CTX *ctx, int socket)
 {
    assert(ctx != nullptr);
    assert(socket > 0);
    SSL *ssl = SSL_new(ctx);
    if (ssl)
        SSL_set_fd(ssl, socket);
    return ssl;
 }
 } // anonymous namespace
 namespace ix 
 {
    SocketOpenSSL::SocketOpenSSL() :
        _ssl_connection(nullptr), 
        _ssl_context(nullptr)
    {
        ;
    }
    SocketOpenSSL::~SocketOpenSSL()
    {
        SocketOpenSSL::close();
    }
    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)
        {
            SSL_CTX_set_verify(ctx, SSL_VERIFY_PEER, openssl_verify_callback);
            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)
    {
        bool handshakeSuccessful = false;
        {
            std::lock_guard<std::mutex> lock(_mutex);
            if (!openSSLInitialize(errMsg))
            {
                return false;
            }
            _sockfd = Socket::hostname_connect(host, port, errMsg);
            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 = openssl_create_connection(_ssl_context, _sockfd);
            if (nullptr == _ssl_connection)
            {
                errMsg = "OpenSSL failed to connect";
                SSL_CTX_free(_ssl_context);
                _ssl_context = nullptr;
                return false;
            }
            // 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();
    }
    int 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();
            int 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 (int) sent;
    }
    int SocketOpenSSL::send(const std::string& buffer)
    {
        return send((char*)&buffer[0], buffer.size());
    }
    // No wait support
    int 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();
            int 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;
            } else {
                return -1;
            }
        }
    }
 }
@@ -0,0 +1,51 @@
 /*
 *  IXSocketOpenSSL.h
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #pragma once
 #include "IXSocket.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();
        ~SocketOpenSSL();
        virtual bool connect(const std::string& host, 
                             int port,
                             std::string& errMsg) final;
        virtual void close() 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:
        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_CTX* _ssl_context;
        SSL* _ssl_connection;
        const SSL_METHOD* _ssl_method;
        mutable std::mutex _mutex;  // OpenSSL routines are not thread-safe
    };
 }
@@ -0,0 +1,260 @@
 /*
 *  IXWebSocket.cpp
 *  Author: Benjamin Sergeant
 *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
 */
 #include "IXWebSocket.h"
 #include <iostream>
 #include <cmath>
 #include <cassert>
 namespace {
    // FIXME: put this in a shared location, and use it in 
    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;
    WebSocket::WebSocket() :
        _verbose(false),
        _onMessageCallback(OnMessageCallback()),
        _stop(false),
        _automaticReconnection(true)
    {
    }
    WebSocket::~WebSocket() 
    {
        stop();
    }
    void WebSocket::configure(const std::string& url)
    {
        std::lock_guard<std::mutex> lock(_urlMutex);
        _url = url;
    }
    void WebSocket::start()
    {
        if (_thread.joinable()) return; // we've already been started
        _thread = std::thread(&WebSocket::run, this);
    }
    void WebSocket::stop()
    {
        _automaticReconnection = false;
        close();
        if (!_thread.joinable())
        {
            _automaticReconnection = true;
            return;
        }
        _stop = true;
        _thread.join();
        _stop = false;
        _automaticReconnection = true;
    }
    WebSocketInitResult WebSocket::connect()
    {
        {
            std::lock_guard<std::mutex> lock(_urlMutex);
            _ws.configure(_url);
        }
        _ws.setOnStateChangeCallback(
            [this](WebSocketTransport::ReadyStateValues readyStateValue)
            {
                if (readyStateValue == WebSocketTransport::CLOSED)
                {
                    _onMessageCallback(WebSocket_MessageType_Close, "", WebSocketErrorInfo());
                }
                if (_verbose)
                {
                    std::cout << "connection state changed -> " 
                              << readyStateToString(getReadyState()) 
                              << std::endl;
                }
            }
        );
        WebSocketInitResult status = _ws.init();
        if (!status.success)
        {
            return status;
        }
        _onMessageCallback(WebSocket_MessageType_Open, "", WebSocketErrorInfo());
        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();
            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, "", connectErr);
                if (_verbose) std::cout << "Sleeping for " << duration.count() << "ms" << std::endl;
                std::this_thread::sleep_for(duration);
            }
        }
    }
    void WebSocket::run()
    {
        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)
                {
                    _onMessageCallback(WebSocket_MessageType_Message, msg, WebSocketErrorInfo());
                    WebSocket::invokeTrafficTrackerCallback(msg.size(), true);
                });
        }
    }
    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);
        }
    }
    bool WebSocket::send(const std::string& text)
    {
        if (!isConnected()) return 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);
        _ws.sendBinary(text);
        WebSocket::invokeTrafficTrackerCallback(text.size(), false);
        return true;
    }
    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;
        }
    }
    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";
        }
    }
    const std::string& WebSocket::getUrl() const
    {
        std::lock_guard<std::mutex> lock(_urlMutex);
        return _url;
    }
 }
@@ -0,0 +1,94 @@
 /*
 *  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"
 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
    };
    struct WebSocketErrorInfo
    {
        uint64_t retries;
        double wait_time;
        int http_status;
        std::string reason;
    };
    using OnMessageCallback = std::function<void(WebSocketMessageType, const std::string&, const WebSocketErrorInfo)>;
    using OnTrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
    class WebSocket 
    {
    public:
        WebSocket();
        ~WebSocket();
        void configure(const std::string& url);
        void start();
        void stop();
        bool send(const std::string& text);
        void close();
        void setOnMessageCallback(const OnMessageCallback& callback);
        static void setTrafficTrackerCallback(const OnTrafficTrackerCallback& callback);
        static void resetTrafficTrackerCallback();
        void setVerbose(bool verbose) { _verbose = verbose; }
        const std::string& getUrl() const;
        ReadyState getReadyState() const;
    private:
        void run();
        WebSocketInitResult connect();
        bool isConnected() const;
        bool isClosing() const;
        void reconnectPerpetuallyIfDisconnected();
        std::string readyStateToString(ReadyState readyState);
        static void invokeTrafficTrackerCallback(size_t size, bool incoming);
        WebSocketTransport _ws;
        std::string _url;
        mutable std::mutex _urlMutex;
        bool _verbose;
        OnMessageCallback _onMessageCallback;
        static OnTrafficTrackerCallback _onTrafficTrackerCallback;
        std::atomic<bool> _stop;
        std::atomic<bool> _automaticReconnection;
        std::thread _thread;
        std::mutex _writeMutex;
    };
 }
@@ -0,0 +1,611 @@
 /*
 *  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 "IXSocket.h"
 #ifdef IXWEBSOCKET_USE_TLS
 # ifdef __APPLE__
 #  include "IXSocketAppleSSL.h"
 # else
 #  include "IXSocketOpenSSL.h"
 # endif
 #endif
 // #include <unistd.h>
 #include <string.h>
 #include <stdlib.h>
 #include <cstdlib>
 #include <vector>
 #include <string>
 #include <cstdarg>
 #include <iostream>
 #include <sstream>
 #include <regex>
 namespace ix {
    WebSocketTransport::WebSocketTransport() :
        _readyState(CLOSED)
    {
        ;
    }
    WebSocketTransport::~WebSocketTransport()
    {
        ;
    }
    void WebSocketTransport::configure(const std::string& url)
    {
        _url = url;
    }
    bool WebSocketTransport::parseUrl(const std::string& url,
                                      std::string& protocol,
                                      std::string& host,
                                      std::string& path,
                                      std::string& query,
                                      int& port)
    {
        std::regex ex("(ws|wss)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
        std::cmatch what;
        if (!regex_match(url.c_str(), what, ex))
        {
            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")
            {
                port = 80;
            }
            else if (protocol == "wss")
            {
                port = 443;
            }
        }
        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 WebSocketTransport::printUrl(const std::string& url)
    {
        std::string protocol, host, path, query;
        int port {0};
        if (!WebSocketTransport::parseUrl(url, protocol, host,
                                          path, query, port))
        {
            return;
        }
        std::cout << "[" << url << "]" << std::endl;
        std::cout << protocol << std::endl;
        std::cout << host << std::endl;
        std::cout << port << std::endl;
        std::cout << path << std::endl;
        std::cout << query << std::endl;
        std::cout << "-------------------------------" << std::endl;
    }
    WebSocketInitResult WebSocketTransport::init()
    {
        std::string protocol, host, path, query;
        int port;
        if (!WebSocketTransport::parseUrl(_url, protocol, host,
                                          path, query, port))
        {
            return WebSocketInitResult(false, 0, "Could not parse URL");
        }
        if (protocol == "wss")
        {
            _socket.reset();
 #ifdef IXWEBSOCKET_USE_TLS
 # ifdef __APPLE__
             _socket = std::make_shared<SocketAppleSSL>();
 # else
             _socket = std::make_shared<SocketOpenSSL>();
 # endif
 #else
            return WebSocketInitResult(false, 0, "TLS is not supported.");
 #endif
        }
        else
        {
            _socket.reset();
            _socket = std::make_shared<Socket>();
        }
        std::string errMsg;
        bool success = _socket->connect(host, port, errMsg);
        if (!success)
        {
            std::stringstream ss;
            ss << "Unable to connect to " << host
               << " on port " << port
               << ", error: " << errMsg;
            return WebSocketInitResult(false, 0, ss.str());
        }
        char line[256];
        int status;
        int i;
        snprintf(line, 256,
            "GET %s HTTP/1.1\r\n"
            "Host: %s:%d\r\n"
            "Upgrade: websocket\r\n"
            "Connection: Upgrade\r\n"
            "Sec-WebSocket-Key: x3JJHMbDL1EzLkh9GBhXDw==\r\n"
            "Sec-WebSocket-Version: 13\r\n"
            "\r\n",
            path.c_str(), host.c_str(), port);
        // XXX: this should be done non-blocking,
        size_t lineSize = strlen(line);
        if (_socket->send(line, lineSize) != lineSize)
        {
            return WebSocketInitResult(false, 0, std::string("Failed sending GET request to ") + _url);
        }
        for (i = 0; i < 2 || (i < 255 && line[i-2] != '\r' && line[i-1] != '\n'); ++i)
        {
            if (_socket->recv(line+i, 1) == 0)
            {
                return WebSocketInitResult(false, 0, std::string("Failed reading HTTP status line from ") + _url);
            } 
        }
        line[i] = 0;
        if (i == 255)
        {
            return WebSocketInitResult(false, 0, std::string("Got bad status line connecting to ") + _url);
        }
        // HTTP/1.0 is too old.
        if (sscanf(line, "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, "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());
        }
        // TODO: verify response headers,
        while (true) 
        {
            for (i = 0;
                 i < 2 || (i < 255 && line[i-2] != '\r' && line[i-1] != '\n');
                 ++i)
            {
                if (_socket->recv(line+i, 1) == 0)
                {
                    return WebSocketInitResult(false, status, std::string("Failed reading response header from ") + _url);
                }
            }
            if (line[0] == '\r' && line[1] == '\n')
            {
                break;
            }
        }
        _socket->configure();
        setReadyState(OPEN);
        return WebSocketInitResult(true, status, "");
    }
    WebSocketTransport::ReadyStateValues WebSocketTransport::getReadyState() const 
    {
        return _readyState;
    }
    void WebSocketTransport::setReadyState(ReadyStateValues readyStateValue)
    {
        _readyState = readyStateValue;
        _onStateChangeCallback(readyStateValue);
    }
    void WebSocketTransport::setOnStateChangeCallback(const OnStateChangeCallback& onStateChangeCallback)
    {
        _onStateChangeCallback = onStateChangeCallback; 
    }
    void WebSocketTransport::poll()
    {
        _socket->poll(
            [this]()
            {
                while (true) 
                {
                    int N = (int) _rxbuf.size();
                    int ret;
                    _rxbuf.resize(N + 1500);
                    ret = _socket->recv((char*)&_rxbuf[0] + N, 1500);
                    if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK || 
                                    _socket->getErrno() == EAGAIN)) {
                        _rxbuf.resize(N);
                        break;
                    }
                    else if (ret <= 0) 
                    {
                        _rxbuf.resize(N);
                        _socket->close();
                        setReadyState(CLOSED);
                        break;
                    }
                    else 
                    {
                        _rxbuf.resize(N + ret);
                    }
                }
                if (isSendBufferEmpty() && _readyState == CLOSING) 
                {
                    _socket->close();
                    setReadyState(CLOSED);
                }
            });
    }
    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());
    }
    //
    // 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)
    {
        // TODO: consider acquiring a lock on _rxbuf...
        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.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
            ) {
                if (ws.mask)
                {
                    for (size_t j = 0; j != ws.N; ++j)
                    {
                        _rxbuf[j+ws.header_size] ^= ws.masking_key[j&0x3];
                    }
                }
                _receivedData.insert(_receivedData.end(),
                                     _rxbuf.begin()+ws.header_size,
                                     _rxbuf.begin()+ws.header_size+(size_t)ws.N);// just feed
                if (ws.fin)
                {
                    // fire callback with a string message
                    std::string stringMessage(_receivedData.begin(),
                                              _receivedData.end());
                    onMessageCallback(stringMessage);
                    _receivedData.clear();
                }
            }
            else if (ws.opcode == wsheader_type::PING)
            {
                if (ws.mask)
                {
                    for (size_t j = 0; j != ws.N; ++j)
                    {
                        _rxbuf[j+ws.header_size] ^= ws.masking_key[j&0x3];
                    }
                }
                std::string pingData(_rxbuf.begin()+ws.header_size,
                                     _rxbuf.begin()+ws.header_size + (size_t) ws.N);
                sendData(wsheader_type::PONG, pingData.size(),
                         pingData.begin(), pingData.end());
            }
            else if (ws.opcode == wsheader_type::PONG) { }
            else if (ws.opcode == wsheader_type::CLOSE) { close(); }
            else { close(); }
            _rxbuf.erase(_rxbuf.begin(),
                         _rxbuf.begin() + ws.header_size + (size_t) ws.N);
        }
    }
    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);
    }
    void WebSocketTransport::sendData(wsheader_type::opcode_type type, 
                                      uint64_t message_size, 
                                      std::string::const_iterator message_begin, 
                                      std::string::const_iterator message_end) 
    {
        if (_readyState == CLOSING || _readyState == CLOSED)
        {
            return;
        }
        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] = 0x80 | type;
        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();
    }
    void WebSocketTransport::sendPing()
    {
        std::string empty;
        sendData(wsheader_type::PING, empty.size(), empty.begin(), empty.end());
    }
    void WebSocketTransport::sendBinary(const std::string& message) 
    {
        sendData(wsheader_type::BINARY_FRAME, message.size(), message.begin(), message.end());
    }
    void WebSocketTransport::sendOnSocket()
    {
        std::lock_guard<std::mutex> lock(_txbufMutex);
        while (_txbuf.size())
        {
            int 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);
            }
        }
    }
    void WebSocketTransport::close()
    {
        if (_readyState == CLOSING || _readyState == CLOSED) return;
        setReadyState(CLOSING);
        uint8_t closeFrame[6] = {0x88, 0x80, 0x00, 0x00, 0x00, 0x00}; // last 4 bytes are a masking key
        std::vector<uint8_t> header(closeFrame, closeFrame+6);
        appendToSendBuffer(header);
        sendOnSocket();
        _socket->wakeUpFromPoll();
    }
 } // namespace ix
@@ -0,0 +1,133 @@
 /*
 *  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>
 namespace ix 
 {
    class Socket;
    struct WebSocketInitResult
    {
        bool success;
        int http_status;
        std::string errorStr;
        WebSocketInitResult(bool s, int h, std::string e)
        {
            success = s;
            http_status = h;
            errorStr = e;
        }
        // need to define a default
        WebSocketInitResult()
        {
            success = false;
            http_status = 0;
            errorStr = "";
        }
    };
    class WebSocketTransport
    {
    public:
        enum ReadyStateValues
        {
            CLOSING,
            CLOSED,
            CONNECTING,
            OPEN
        };
        using OnMessageCallback = std::function<void(const std::string&)>;
        using OnStateChangeCallback = std::function<void(ReadyStateValues)>;
        WebSocketTransport();
        ~WebSocketTransport();
        void configure(const std::string& url);
        WebSocketInitResult init();
        void poll();
        void send(const std::string& message);
        void sendBinary(const std::string& message);
        void sendBinary(const std::vector<uint8_t>& message);
        void sendPing();
        void close();
        ReadyStateValues getReadyState() const;
        void setReadyState(ReadyStateValues readyStateValue);
        void setOnStateChangeCallback(const OnStateChangeCallback& onStateChangeCallback);
        void dispatch(const OnMessageCallback& onMessageCallback);
        static void printUrl(const std::string& url);
        static bool parseUrl(const std::string& url,
                             std::string& protocol,
                             std::string& host,
                             std::string& path,
                             std::string& query,
                             int& port);
    private:
        std::string _url;
        std::string _origin;
        struct wsheader_type {
            unsigned header_size;
            bool fin;
            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];
        };
        std::vector<uint8_t> _rxbuf;
        std::vector<uint8_t> _txbuf;
        mutable std::mutex _txbufMutex;
        std::vector<uint8_t> _receivedData;
        std::shared_ptr<Socket> _socket;
        std::atomic<ReadyStateValues> _readyState;
        OnStateChangeCallback _onStateChangeCallback;
        void sendOnSocket();
        void sendData(wsheader_type::opcode_type type, 
                      uint64_t message_size, 
                      std::string::const_iterator message_begin, 
                      std::string::const_iterator message_end);
        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();
    };
 }
@@ -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;',
 };
@@ -1,259 +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>Packages - 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 active">
                                <a href="./" 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="../design/" class="nav-link">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" href="../performance/" 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="#vcpkg" class="nav-link">VCPKG</a>
              <ul class="nav flex-column">
              </ul>
            </li>
        </ul>
    </div>
 </div></div>
                    <div class="col-md-9" role="main">
 <p>Notes on how we can update the different packages for ixwebsocket.</p>
 <h2 id="vcpkg">VCPKG</h2>
 <p>Visit the <a href="https://github.com/machinezone/IXWebSocket/releases">releases</a> page on Github. A tag must have been made first.</p>
 <p>Download the latest entry.</p>
 <pre><code>$ cd /tmp
 /tmp$ curl -s -O -L https://github.com/machinezone/IXWebSocket/archive/v9.1.9.tar.gz
 /tmp$
 /tmp$ openssl sha512 v9.1.9.tar.gz
 SHA512(v9.1.9.tar.gz)= f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
 </code></pre>
 <p>Now go punch those values in the vcpkg ixwebsocket port config files. Here is what the diff look like.</p>
 <pre><code>vcpkg$ git diff
 diff --git a/ports/ixwebsocket/CONTROL b/ports/ixwebsocket/CONTROL
 index db9c2adc9..4acae5c3f 100644
 --- a/ports/ixwebsocket/CONTROL
 +++ b/ports/ixwebsocket/CONTROL
@@ -1,5 +1,5 @@
 Source: ixwebsocket
 -Version: 8.0.5
 +Version: 9.1.9
 Build-Depends: zlib
 Homepage: https://github.com/machinezone/IXWebSocket
 Description: Lightweight WebSocket Client and Server + HTTP Client and Server
 diff --git a/ports/ixwebsocket/portfile.cmake b/ports/ixwebsocket/portfile.cmake
 index de082aece..68e523a05 100644
 --- a/ports/ixwebsocket/portfile.cmake
 +++ b/ports/ixwebsocket/portfile.cmake
@@ -1,8 +1,8 @@
 vcpkg_from_github(
     OUT_SOURCE_PATH SOURCE_PATH
     REPO machinezone/IXWebSocket
 -    REF v8.0.5
 -    SHA512 9dcc20d9a0629b92c62a68a8bd7c8206f18dbd9e93289b0b687ec13c478ce9ad1f3563b38c399c8277b0d3812cc78ca725786ba1dedbc3445b9bdb9b689e8add
 +    REF v9.1.9
 +    SHA512 f1fd731b5f6a9ce6d6d10bee22a5d9d9baaa8ea0564d6c4cd7eb91dcb88a45c49b2c7fdb75f8640a3589c1b30cee33ef5df8dcbb55920d013394d1e33ddd3c8e
 )
 </code></pre>
 <p>You will need a fork of the vcpkg repo to make a pull request.</p>
 <pre><code>git fetch upstream
 git co master
 git reset --hard upstream/master
 git push origin master --force
 </code></pre>
 <p>Make the pull request (I use a new branch to do that).</p>
 <pre><code>vcpkg$ git co -b feature/ixwebsocket_9.1.9
 M   ports/ixwebsocket/CONTROL
 M   ports/ixwebsocket/portfile.cmake
 Switched to a new branch 'feature/ixwebsocket_9.1.9'
 vcpkg$
 vcpkg$
 vcpkg$ git commit -am 'ixwebsocket: update to 9.1.9'
 [feature/ixwebsocket_9.1.9 8587a4881] ixwebsocket: update to 9.1.9
 2 files changed, 3 insertions(+), 3 deletions(-)
 vcpkg$
 vcpkg$ git push
 fatal: The current branch feature/ixwebsocket_9.1.9 has no upstream branch.
 To push the current branch and set the remote as upstream, use
    git push --set-upstream origin feature/ixwebsocket_9.1.9
 vcpkg$ git push --set-upstream origin feature/ixwebsocket_9.1.9
 Enumerating objects: 11, done.
 Counting objects: 100% (11/11), done.
 Delta compression using up to 8 threads
 Compressing objects: 100% (6/6), done.
 Writing objects: 100% (6/6), 621 bytes | 621.00 KiB/s, done.
 Total 6 (delta 4), reused 0 (delta 0)
 remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
 remote:
 remote: Create a pull request for 'feature/ixwebsocket_9.1.9' on GitHub by visiting:
 remote:      https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9
 remote:
 To https://github.com/bsergean/vcpkg.git
 * [new branch]          feature/ixwebsocket_9.1.9 -&gt; feature/ixwebsocket_9.1.9
 Branch 'feature/ixwebsocket_9.1.9' set up to track remote branch 'feature/ixwebsocket_9.1.9' from 'origin' by rebasing.
 vcpkg$
 </code></pre>
 <p>Just visit this url, https://github.com/bsergean/vcpkg/pull/new/feature/ixwebsocket_9.1.9, printed on the console, to make the pull request.</p></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,208 +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>Performance - 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 active">
                                <a href="./" 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="../packages/" class="nav-link">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" href="../usage/" 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="#websocket-client-performance" class="nav-link">WebSocket Client performance</a>
              <ul class="nav flex-column">
              </ul>
            </li>
        </ul>
    </div>
 </div></div>
                    <div class="col-md-9" role="main">
 <h2 id="websocket-client-performance">WebSocket Client performance</h2>
 <p>We will run a client and a server on the same machine, connecting to localhost. This bench is run on a MacBook Pro from 2015. We can receive over 200,000 (small) messages per second, another way to put it is that it takes 5 micro-second to receive and process one message. This is an indication about the minimal latency to receive messages.</p>
 <h3 id="receiving-messages">Receiving messages</h3>
 <p>By using the push_server ws sub-command, the server will send the same message in a loop to any connected client.</p>
 <pre><code>ws push_server -q --send_msg 'yo'
 </code></pre>
 <p>By using the echo_client ws sub-command, with the -m (mute or no_send), we will display statistics on how many messages we can receive per second.</p>
 <pre><code>$ ws echo_client -m ws://localhost:8008
 [2020-08-02 12:31:17.284] [info] ws_echo_client: connected
 [2020-08-02 12:31:17.284] [info] Uri: /
 [2020-08-02 12:31:17.284] [info] Headers:
 [2020-08-02 12:31:17.284] [info] Connection: Upgrade
 [2020-08-02 12:31:17.284] [info] Sec-WebSocket-Accept: byy/pMK2d0PtRwExaaiOnXJTQHo=
 [2020-08-02 12:31:17.284] [info] Server: ixwebsocket/10.1.4 macos ssl/SecureTransport zlib 1.2.11
 [2020-08-02 12:31:17.284] [info] Upgrade: websocket
 [2020-08-02 12:31:17.663] [info] messages received: 0 per second 2595307 total
 [2020-08-02 12:31:18.668] [info] messages received: 79679 per second 2674986 total
 [2020-08-02 12:31:19.668] [info] messages received: 207438 per second 2882424 total
 [2020-08-02 12:31:20.673] [info] messages received: 209207 per second 3091631 total
 [2020-08-02 12:31:21.676] [info] messages received: 216056 per second 3307687 total
 [2020-08-02 12:31:22.680] [info] messages received: 214927 per second 3522614 total
 [2020-08-02 12:31:23.684] [info] messages received: 216960 per second 3739574 total
 [2020-08-02 12:31:24.688] [info] messages received: 215232 per second 3954806 total
 [2020-08-02 12:31:25.691] [info] messages received: 212300 per second 4167106 total
 [2020-08-02 12:31:26.694] [info] messages received: 212501 per second 4379607 total
 [2020-08-02 12:31:27.699] [info] messages received: 212330 per second 4591937 total
 [2020-08-02 12:31:28.702] [info] messages received: 216511 per second 4808448 total
 </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,109 +0,0 @@
 function getSearchTermFromLocation() {
  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 decodeURIComponent(sParameterName[1].replace(/\+/g, '%20'));
    }
  }
 }
 function joinUrl (base, path) {
  if (path.substring(0, 1) === "/") {
    // path starts with `/`. Thus it is absolute.
    return path;
  }
  if (base.substring(base.length-1) === "/") {
    // base ends with `/`
    return base + path;
  }
  return base + "/" + path;
 }
 function escapeHtml (value) {
  return value.replace(/&/g, '&amp;')
    .replace(/"/g, '&quot;')
    .replace(/</g, '&lt;')
    .replace(/>/g, '&gt;');
 }
 function formatResult (location, title, summary) {
  return '<article><h3><a href="' + joinUrl(base_url, location) + '">'+ escapeHtml(title) + '</a></h3><p>' + escapeHtml(summary) +'</p></article>';
 }
 function displayResults (results) {
  var search_results = document.getElementById("mkdocs-search-results");
  while (search_results.firstChild) {
    search_results.removeChild(search_results.firstChild);
  }
  if (results.length > 0){
    for (var i=0; i < results.length; i++){
      var result = results[i];
      var html = formatResult(result.location, result.title, result.summary);
      search_results.insertAdjacentHTML('beforeend', html);
    }
  } else {
    var noResultsText = search_results.getAttribute('data-no-results-text');
    if (!noResultsText) {
      noResultsText = "No results found";
    }
    search_results.insertAdjacentHTML('beforeend', '<p>' + noResultsText + '</p>');
  }
 }
 function doSearch () {
  var query = document.getElementById('mkdocs-search-query').value;
  if (query.length > min_search_length) {
    if (!window.Worker) {
      displayResults(search(query));
    } else {
      searchWorker.postMessage({query: query});
    }
  } else {
    // Clear results for short queries
    displayResults([]);
  }
 }
 function initSearch () {
  var search_input = document.getElementById('mkdocs-search-query');
  if (search_input) {
    search_input.addEventListener("keyup", doSearch);
  }
  var term = getSearchTermFromLocation();
  if (term) {
    search_input.value = term;
    doSearch();
  }
 }
 function onWorkerMessage (e) {
  if (e.data.allowSearch) {
    initSearch();
  } else if (e.data.results) {
    var results = e.data.results;
    displayResults(results);
  } else if (e.data.config) {
    min_search_length = e.data.config.min_search_length-1;
  }
 }
 if (!window.Worker) {
  console.log('Web Worker API not supported');
  // load index in main thread
  $.getScript(joinUrl(base_url, "search/worker.js")).done(function () {
    console.log('Loaded worker');
    init();
    window.postMessage = function (msg) {
      onWorkerMessage({data: msg});
    };
  }).fail(function (jqxhr, settings, exception) {
    console.error('Could not load worker.js');
  });
 } else {
  // Wrap search in a web worker
  var searchWorker = new Worker(joinUrl(base_url, "search/worker.js"));
  searchWorker.postMessage({init: true});
  searchWorker.onmessage = onWorkerMessage;
 }
@@ -1,133 +0,0 @@
 var base_path = 'function' === typeof importScripts ? '.' : '/search/';
 var allowSearch = false;
 var index;
 var documents = {};
 var lang = ['en'];
 var data;
 function getScript(script, callback) {
  console.log('Loading script: ' + script);
  $.getScript(base_path + script).done(function () {
    callback();
  }).fail(function (jqxhr, settings, exception) {
    console.log('Error: ' + exception);
  });
 }
 function getScriptsInOrder(scripts, callback) {
  if (scripts.length === 0) {
    callback();
    return;
  }
  getScript(scripts[0], function() {
    getScriptsInOrder(scripts.slice(1), callback);
  });
 }
 function loadScripts(urls, callback) {
  if( 'function' === typeof importScripts ) {
    importScripts.apply(null, urls);
    callback();
  } else {
    getScriptsInOrder(urls, callback);
  }
 }
 function onJSONLoaded () {
  data = JSON.parse(this.responseText);
  var scriptsToLoad = ['lunr.js'];
  if (data.config && data.config.lang && data.config.lang.length) {
    lang = data.config.lang;
  }
  if (lang.length > 1 || lang[0] !== "en") {
    scriptsToLoad.push('lunr.stemmer.support.js');
    if (lang.length > 1) {
      scriptsToLoad.push('lunr.multi.js');
    }
    if (lang.includes("ja") || lang.includes("jp")) {
      scriptsToLoad.push('tinyseg.js');
    }
    for (var i=0; i < lang.length; i++) {
      if (lang[i] != 'en') {
        scriptsToLoad.push(['lunr', lang[i], 'js'].join('.'));
      }
    }
  }
  loadScripts(scriptsToLoad, onScriptsLoaded);
 }
 function onScriptsLoaded () {
  console.log('All search scripts loaded, building Lunr index...');
  if (data.config && data.config.separator && data.config.separator.length) {
    lunr.tokenizer.separator = new RegExp(data.config.separator);
  }
  if (data.index) {
    index = lunr.Index.load(data.index);
    data.docs.forEach(function (doc) {
      documents[doc.location] = doc;
    });
    console.log('Lunr pre-built index loaded, search ready');
  } else {
    index = lunr(function () {
      if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) {
        this.use(lunr[lang[0]]);
      } else if (lang.length > 1) {
        this.use(lunr.multiLanguage.apply(null, lang));  // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility
      }
      this.field('title');
      this.field('text');
      this.ref('location');
      for (var i=0; i < data.docs.length; i++) {
        var doc = data.docs[i];
        this.add(doc);
        documents[doc.location] = doc;
      }
    });
    console.log('Lunr index built, search ready');
  }
  allowSearch = true;
  postMessage({config: data.config});
  postMessage({allowSearch: allowSearch});
 }
 function init () {
  var oReq = new XMLHttpRequest();
  oReq.addEventListener("load", onJSONLoaded);
  var index_path = base_path + '/search_index.json';
  if( 'function' === typeof importScripts ){
      index_path = 'search_index.json';
  }
  oReq.open("GET", index_path);
  oReq.send();
 }
 function search (query) {
  if (!allowSearch) {
    console.error('Assets for search still loading');
    return;
  }
  var resultDocuments = [];
  var results = index.search(query);
  for (var i=0; i < results.length; i++){
    var result = results[i];
    doc = documents[result.ref];
    doc.summary = doc.text.substring(0, 200);
    resultDocuments.push(doc);
  }
  return resultDocuments;
 }
 if( 'function' === typeof importScripts ) {
  onmessage = function (e) {
    if (e.data.init) {
      init();
    } else if (e.data.query) {
      postMessage({ results: search(e.data.query) });
    } else {
      console.error("Worker - Unrecognized message: " + e);
    }
  };
 }
@@ -1,3 +0,0 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
 </urlset>
@@ -1,744 +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>Examples - 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 active">
                                <a href="./" 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="../performance/" class="nav-link">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" href="../ws/" 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="1"><a href="#examples" class="nav-link">Examples</a>
              <ul class="nav flex-column">
            <li class="nav-item" data-level="2"><a href="#windows-note" class="nav-link">Windows note</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#websocket-client-api" class="nav-link">WebSocket client API</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#handshake-timeout" class="nav-link">Handshake timeout</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#websocket-server-api" class="nav-link">WebSocket server API</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#http-client-api" class="nav-link">HTTP client API</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#http-server-api" class="nav-link">HTTP server API</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#tls-support-and-configuration" class="nav-link">TLS support and configuration</a>
              <ul class="nav flex-column">
              </ul>
            </li>
              </ul>
            </li>
        </ul>
    </div>
 </div></div>
                    <div class="col-md-9" role="main">
 <h1 id="examples">Examples</h1>
 <p>The <a href="https://github.com/machinezone/IXWebSocket/tree/master/ws"><em>ws</em></a> folder countains many interactive programs for chat, <a href="https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp">file transfers</a>, <a href="https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp">curl like</a> http clients, demonstrating client and server usage.</p>
 <h2 id="windows-note">Windows note</h2>
 <p>To use the network system on Windows, you need to initialize it once with <em>WSAStartup()</em> and clean it up with <em>WSACleanup()</em>. We have helpers for that which you can use, see below. This init would typically take place in your main function.</p>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXNetSystem.h&gt;
 int main()
 {
    ix::initNetSystem();
    ...
    ix::uninitNetSystem();
    return 0;
 }
 </code></pre>
 <h2 id="websocket-client-api">WebSocket client API</h2>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXWebSocket.h&gt;
 ...
 // Our websocket object
 ix::WebSocket webSocket;
 std::string url(&quot;ws://localhost:8080/&quot;);
 webSocket.setUrl(url);
 // Optional heart beat, sent every 45 seconds when there is not any traffic
 // to make sure that load balancers do not kill an idle connection.
 webSocket.setPingInterval(45);
 // Per message deflate connection is enabled by default. You can tweak its parameters or disable it
 webSocket.disablePerMessageDeflate();
 // Setup a callback to be fired when a message or an event (open, close, error) is received
 webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr&amp; msg)
    {
        if (msg-&gt;type == ix::WebSocketMessageType::Message)
        {
            std::cout &lt;&lt; msg-&gt;str &lt;&lt; std::endl;
        }
    }
 );
 // Now that our callback is setup, we can start our background thread and receive messages
 webSocket.start();
 // Send a message to the server (default to TEXT mode)
 webSocket.send(&quot;hello world&quot;);
 // The message can be sent in BINARY mode (useful if you send MsgPack data for example)
 webSocket.sendBinary(&quot;some serialized binary data&quot;);
 // ... finally ...
 // Stop the connection
 webSocket.stop()
 </code></pre>
 <h3 id="sending-messages">Sending messages</h3>
 <p><code>WebSocketSendInfo result = websocket.send("foo")</code> will send a message.</p>
 <p>If the connection was closed, sending will fail, and the success field of the result object  will be set to false. There could also be a compression error in which case the compressError field will be set to true. The payloadSize field and wireSize fields will tell you respectively how much bytes the message weight, and how many bytes were sent on the wire (potentially compressed + counting the message header (a few bytes).</p>
 <p>There is an optional progress callback that can be passed in as the second argument. If a message is large it will be fragmented into chunks which will be sent independantly. Everytime the we can write a fragment into the OS network cache, the callback will be invoked. If a user wants to cancel a slow send, false should be returned from within the callback.</p>
 <p>Here is an example code snippet copied from the ws send sub-command. Each fragment weights 32K, so the total integer is the wireSize divided by 32K. As an example if you are sending 32M of data, uncompressed, total will be 1000. current will be set to 0 for the first fragment, then 1, 2 etc...</p>
 <pre><code>auto result =
    _webSocket.sendBinary(serializedMsg, [this, throttle](int current, int total) -&gt; bool {
        spdlog::info(&quot;ws_send: Step {} out of {}&quot;, current + 1, total);
        if (throttle)
        {
            std::chrono::duration&lt;double, std::milli&gt; duration(10);
            std::this_thread::sleep_for(duration);
        }
        return _connected;
    });
 </code></pre>
 <p>The <code>send()</code> and <code>sendText()</code> methods check that the string contains only valid UTF-8 characters. If you know that the string is a valid UTF-8 string you can skip that step and use the <code>sendUtf8Text</code> method instead.</p>
 <p>With the IXWebSocketSendData overloads of <code>sendUtf8Text</code> and <code>sendBinary</code> it is possible to not only send std::string but also <code>std::vector&lt;char&gt;</code>, <code>std::vector&lt;uint8_t&gt;</code> and <code>char*</code>.</p>
 <pre><code>std::vector&lt;uint8_t&gt; data({1, 2, 3, 4});
 auto result = webSocket.sendBinary(data);
 const char* text = &quot;Hello World!&quot;;
 result = webSocket.sendUtf8Text(IXWebSocketSendData(text, strlen(text)));
 </code></pre>
 <h3 id="readystate">ReadyState</h3>
 <p><code>getReadyState()</code> returns the state of the connection. There are 4 possible states.</p>
 <ol>
 <li>ReadyState::Connecting - The connection is not yet open.</li>
 <li>ReadyState::Open       - The connection is open and ready to communicate.</li>
 <li>ReadyState::Closing    - The connection is in the process of closing.</li>
 <li>ReadyState::Closed     - The connection is closed or could not be opened.</li>
 </ol>
 <h3 id="open-and-close-notifications">Open and Close notifications</h3>
 <p>The onMessage event will be fired when the connection is opened or closed. This is similar to the <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSocket">JavaScript browser API</a>, which has <code>open</code> and <code>close</code> events notification that can be registered with the browser <code>addEventListener</code>.</p>
 <pre><code class="language-cpp">webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr&amp; msg)
    {
        if (msg-&gt;type == ix::WebSocketMessageType::Open)
        {
            std::cout &lt;&lt; &quot;send greetings&quot; &lt;&lt; std::endl;
            // Headers can be inspected (pairs of string/string)
            std::cout &lt;&lt; &quot;Handshake Headers:&quot; &lt;&lt; std::endl;
            for (auto it : msg-&gt;headers)
            {
                std::cout &lt;&lt; it.first &lt;&lt; &quot;: &quot; &lt;&lt; it.second &lt;&lt; std::endl;
            }
        }
        else if (msg-&gt;type == ix::WebSocketMessageType::Close)
        {
            std::cout &lt;&lt; &quot;disconnected&quot; &lt;&lt; std::endl;
            // The server can send an explicit code and reason for closing.
            // This data can be accessed through the closeInfo object.
            std::cout &lt;&lt; msg-&gt;closeInfo.code &lt;&lt; std::endl;
            std::cout &lt;&lt; msg-&gt;closeInfo.reason &lt;&lt; std::endl;
        }
    }
 );
 </code></pre>
 <h3 id="error-notification">Error notification</h3>
 <p>A message will be fired when there is an error with the connection. The message type will be <code>ix::WebSocketMessageType::Error</code>. Multiple fields will be available on the event to describe the error.</p>
 <pre><code class="language-cpp">webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr&amp; msg)
    {
        if (msg-&gt;type == ix::WebSocketMessageType::Error)
        {
            std::stringstream ss;
            ss &lt;&lt; &quot;Error: &quot;         &lt;&lt; msg-&gt;errorInfo.reason      &lt;&lt; std::endl;
            ss &lt;&lt; &quot;#retries: &quot;      &lt;&lt; msg-&gt;errorInfo.retries     &lt;&lt; std::endl;
            ss &lt;&lt; &quot;Wait time(ms): &quot; &lt;&lt; msg-&gt;errorInfo.wait_time   &lt;&lt; std::endl;
            ss &lt;&lt; &quot;HTTP Status: &quot;   &lt;&lt; msg-&gt;errorInfo.http_status &lt;&lt; std::endl;
            std::cout &lt;&lt; ss.str() &lt;&lt; std::endl;
        }
    }
 );
 </code></pre>
 <h3 id="start-stop">start, stop</h3>
 <ol>
 <li><code>websocket.start()</code> connect to the remote server and starts the message receiving background thread.</li>
 <li><code>websocket.stop()</code> disconnect from the remote server and closes the background thread.</li>
 </ol>
 <h3 id="configuring-the-remote-url">Configuring the remote url</h3>
 <p>The url can be set and queried after a websocket object has been created. You will have to call <code>stop</code> and <code>start</code> if you want to disconnect and connect to that new url.</p>
 <pre><code class="language-cpp">std::string url(&quot;wss://example.com&quot;);
 websocket.configure(url);
 </code></pre>
 <h3 id="pingpong-support">Ping/Pong support</h3>
 <p>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.</p>
 <pre><code class="language-cpp">webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr&amp; msg)
    {
        if (msg-&gt;type == ix::WebSocketMessageType::Ping ||
            msg-&gt;type == ix::WebSocketMessageType::Pong)
        {
            std::cout &lt;&lt; &quot;pong data: &quot; &lt;&lt; msg-&gt;str &lt;&lt; std::endl;
        }
    }
 );
 </code></pre>
 <p>A ping message can be sent to the server, with an optional data string.</p>
 <pre><code class="language-cpp">websocket.ping(&quot;ping data, optional (empty string is ok): limited to 125 bytes long&quot;);
 </code></pre>
 <h3 id="heartbeat">Heartbeat.</h3>
 <p>You can configure an optional heart beat / keep-alive, sent every 45 seconds
 when there is no any traffic to make sure that load balancers do not kill an
 idle connection.</p>
 <pre><code class="language-cpp">webSocket.setPingInterval(45);
 </code></pre>
 <h3 id="supply-extra-http-headers">Supply extra HTTP headers.</h3>
 <p>You can set extra HTTP headers to be sent during the WebSocket handshake.</p>
 <pre><code class="language-cpp">WebSocketHttpHeaders headers;
 headers[&quot;foo&quot;] = &quot;bar&quot;;
 webSocket.setExtraHeaders(headers);
 </code></pre>
 <h3 id="subprotocols">Subprotocols</h3>
 <p>You can specify subprotocols to be set during the WebSocket handshake. For more info you can refer to <a href="https://hpbn.co/websocket/#subprotocol-negotiation">this doc</a>.</p>
 <pre><code class="language-cpp">webSocket.addSubprotocol(&quot;appProtocol-v1&quot;);
 webSocket.addSubprotocol(&quot;appProtocol-v2&quot;);
 </code></pre>
 <p>The protocol that the server did accept is available in the open info <code>protocol</code> field.</p>
 <pre><code class="language-cpp">std::cout &lt;&lt; &quot;protocol: &quot; &lt;&lt; msg-&gt;openInfo.protocol &lt;&lt; std::endl;
 </code></pre>
 <h3 id="automatic-reconnection">Automatic reconnection</h3>
 <p>Automatic reconnection kicks in when the connection is disconnected without the user consent. This feature is on by default and can be turned off.</p>
 <pre><code class="language-cpp">webSocket.enableAutomaticReconnection();  // turn on
 webSocket.disableAutomaticReconnection(); // turn off
 bool enabled = webSocket.isAutomaticReconnectionEnabled(); // query state
 </code></pre>
 <p>The technique to calculate wait time is called <a href="https://docs.aws.amazon.com/general/latest/gr/api-retries.html">exponential
 backoff</a>. Here
 are the default waiting times between attempts (from connecting with <code>ws connect ws://foo.com</code>)</p>
 <pre><code>&gt; Connection error: Got bad status connecting to foo.com, status: 301, HTTP Status line: HTTP/1.1 301 Moved Permanently
 #retries: 1
 Wait time(ms): 100
 #retries: 2
 Wait time(ms): 200
 #retries: 3
 Wait time(ms): 400
 #retries: 4
 Wait time(ms): 800
 #retries: 5
 Wait time(ms): 1600
 #retries: 6
 Wait time(ms): 3200
 #retries: 7
 Wait time(ms): 6400
 #retries: 8
 Wait time(ms): 10000
 </code></pre>
 <p>The waiting time is capped by default at 10s between 2 attempts, but that value
 can be changed and queried. The minimum waiting time can also be set.</p>
 <pre><code class="language-cpp">webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s
 uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
 webSocket.setMinWaitBetweenReconnectionRetries(1000); // 1000ms = 1s
 uint32_t m = webSocket.getMinWaitBetweenReconnectionRetries();
 </code></pre>
 <h2 id="handshake-timeout">Handshake timeout</h2>
 <p>You can control how long to wait until timing out while waiting for the websocket handshake to be performed.</p>
 <pre><code>int handshakeTimeoutSecs = 1;
 setHandshakeTimeout(handshakeTimeoutSecs);
 </code></pre>
 <h2 id="websocket-server-api">WebSocket server API</h2>
 <h3 id="legacy-api">Legacy api</h3>
 <p>This api was actually changed to take a weak_ptr<WebSocket> as the first argument to setOnConnectionCallback ; previously it would take a shared_ptr<WebSocket> which was creating cycles and then memory leaks problems.</p>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXWebSocketServer.h&gt;
 ...
 // Run a server on localhost at a given port.
 // Bound host name, max connections and listen backlog can also be passed in as parameters.
 int port = 8008;
 std::string host(&quot;127.0.0.1&quot;); // If you need this server to be accessible on a different machine, use &quot;0.0.0.0&quot;
 ix::WebSocketServer server(port, host);
 server.setOnConnectionCallback(
    [&amp;server](std::weak_ptr&lt;WebSocket&gt; webSocket,
              std::shared_ptr&lt;ConnectionState&gt; connectionState)
    {
        std::cout &lt;&lt; &quot;Remote ip: &quot; &lt;&lt; connectionState-&gt;remoteIp &lt;&lt; std::endl;
        auto ws = webSocket.lock();
        if (ws)
        {
            ws-&gt;setOnMessageCallback(
                [webSocket, connectionState, &amp;server](const ix::WebSocketMessagePtr msg)
                {
                    if (msg-&gt;type == ix::WebSocketMessageType::Open)
                    {
                        std::cout &lt;&lt; &quot;New connection&quot; &lt;&lt; std::endl;
                        // A connection state object is available, and has a default id
                        // You can subclass ConnectionState and pass an alternate factory
                        // to override it. It is useful if you want to store custom
                        // attributes per connection (authenticated bool flag, attributes, etc...)
                        std::cout &lt;&lt; &quot;id: &quot; &lt;&lt; connectionState-&gt;getId() &lt;&lt; std::endl;
                        // The uri the client did connect to.
                        std::cout &lt;&lt; &quot;Uri: &quot; &lt;&lt; msg-&gt;openInfo.uri &lt;&lt; std::endl;
                        std::cout &lt;&lt; &quot;Headers:&quot; &lt;&lt; std::endl;
                        for (auto it : msg-&gt;openInfo.headers)
                        {
                            std::cout &lt;&lt; it.first &lt;&lt; &quot;: &quot; &lt;&lt; it.second &lt;&lt; std::endl;
                        }
                    }
                    else if (msg-&gt;type == ix::WebSocketMessageType::Message)
                    {
                        // For an echo server, we just send back to the client whatever was received by the server
                        // All connected clients are available in an std::set. See the broadcast cpp example.
                        // Second parameter tells whether we are sending the message in binary or text mode.
                        // Here we send it in the same mode as it was received.
                        auto ws = webSocket.lock();
                        if (ws)
                        {
                            ws-&gt;send(msg-&gt;str, msg-&gt;binary);
                        }
                    }
                }
            }
        );
    }
 );
 auto res = server.listen();
 if (!res.first)
 {
    // Error handling
    return 1;
 }
 // Per message deflate connection is enabled by default. It can be disabled
 // which might be helpful when running on low power devices such as a Rasbery Pi
 server.disablePerMessageDeflate();
 // Run the server in the background. Server can be stoped by calling server.stop()
 server.start();
 // Block until server.stop() is called.
 server.wait();
 </code></pre>
 <h3 id="new-api">New api</h3>
 <p>The new API does not require to use 2 nested callbacks, which is a bit annoying. The real fix is that there was a memory leak due to a shared_ptr cycle, due to passing down a shared_ptr<WebSocket> down to the callbacks.</p>
 <p>The webSocket reference is guaranteed to be always valid ; by design the callback will never be invoked with a null webSocket object.</p>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXWebSocketServer.h&gt;
 ...
 // Run a server on localhost at a given port.
 // Bound host name, max connections and listen backlog can also be passed in as parameters.
 int port = 8008;
 std::string host(&quot;127.0.0.1&quot;); // If you need this server to be accessible on a different machine, use &quot;0.0.0.0&quot;
 ix::WebSocketServer server(port, host);
 server.setOnClientMessageCallback([](std::shared_ptr&lt;ix::ConnectionState&gt; connectionState, ix::WebSocket &amp; webSocket, const ix::WebSocketMessagePtr &amp; msg) {
    // The ConnectionState object contains information about the connection,
    // at this point only the client ip address and the port.
    std::cout &lt;&lt; &quot;Remote ip: &quot; &lt;&lt; connectionState-&gt;getRemoteIp() &lt;&lt; std::endl;
    if (msg-&gt;type == ix::WebSocketMessageType::Open)
    {
        std::cout &lt;&lt; &quot;New connection&quot; &lt;&lt; std::endl;
        // A connection state object is available, and has a default id
        // You can subclass ConnectionState and pass an alternate factory
        // to override it. It is useful if you want to store custom
        // attributes per connection (authenticated bool flag, attributes, etc...)
        std::cout &lt;&lt; &quot;id: &quot; &lt;&lt; connectionState-&gt;getId() &lt;&lt; std::endl;
        // The uri the client did connect to.
        std::cout &lt;&lt; &quot;Uri: &quot; &lt;&lt; msg-&gt;openInfo.uri &lt;&lt; std::endl;
        std::cout &lt;&lt; &quot;Headers:&quot; &lt;&lt; std::endl;
        for (auto it : msg-&gt;openInfo.headers)
        {
            std::cout &lt;&lt; &quot;\t&quot; &lt;&lt; it.first &lt;&lt; &quot;: &quot; &lt;&lt; it.second &lt;&lt; std::endl;
        }
    }
    else if (msg-&gt;type == ix::WebSocketMessageType::Message)
    {
        // For an echo server, we just send back to the client whatever was received by the server
        // All connected clients are available in an std::set. See the broadcast cpp example.
        // Second parameter tells whether we are sending the message in binary or text mode.
        // Here we send it in the same mode as it was received.
        std::cout &lt;&lt; &quot;Received: &quot; &lt;&lt; msg-&gt;str &lt;&lt; std::endl;
        webSocket.send(msg-&gt;str, msg-&gt;binary);
    }
 });
 auto res = server.listen();
 if (!res.first)
 {
    // Error handling
    return 1;
 }
 // Per message deflate connection is enabled by default. It can be disabled
 // which might be helpful when running on low power devices such as a Rasbery Pi
 server.disablePerMessageDeflate();
 // Run the server in the background. Server can be stoped by calling server.stop()
 server.start();
 // Block until server.stop() is called.
 server.wait();
 </code></pre>
 <h3 id="heartbeat_1">Heartbeat</h3>
 <p>You can configure an optional heartbeat / keep-alive for the WebSocket server. The heartbeat interval can be adjusted or disabled when constructing the <code>WebSocketServer</code>. Setting the interval to <code>-1</code> disables the heartbeat feature; this is the default setting. The parameter you set will be applied to every <code>WebSocket</code> object that the server creates.</p>
 <p>To enable a 45 second heartbeat on a <code>WebSocketServer</code>:</p>
 <pre><code class="language-cpp">int pingIntervalSeconds = 45;
 ix::WebSocketServer server(port, host, backlog, maxConnections, handshakeTimeoutSecs, addressFamily, pingIntervalSeconds);
 </code></pre>
 <h2 id="http-client-api">HTTP client API</h2>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXHttpClient.h&gt;
 ...
 //
 // Preparation
 //
 HttpClient httpClient;
 HttpRequestArgsPtr args = httpClient.createRequest();
 // Custom headers can be set
 WebSocketHttpHeaders headers;
 headers[&quot;Foo&quot;] = &quot;bar&quot;;
 args-&gt;extraHeaders = headers;
 // Timeout options
 args-&gt;connectTimeout = connectTimeout;
 args-&gt;transferTimeout = transferTimeout;
 // Redirect options
 args-&gt;followRedirects = followRedirects;
 args-&gt;maxRedirects = maxRedirects;
 // Misc
 args-&gt;compress = compress; // Enable gzip compression
 args-&gt;verbose = verbose;
 args-&gt;logger = [](const std::string&amp; msg)
 {
    std::cout &lt;&lt; msg;
 };
 //
 // Synchronous Request
 //
 HttpResponsePtr out;
 std::string url = &quot;https://www.google.com&quot;;
 // HEAD request
 out = httpClient.head(url, args);
 // GET request
 out = httpClient.get(url, args);
 // POST request with parameters
 HttpParameters httpParameters;
 httpParameters[&quot;foo&quot;] = &quot;bar&quot;;
 // HTTP form data can be passed in as well, for multi-part upload of files
 HttpFormDataParameters httpFormDataParameters;
 httpParameters[&quot;baz&quot;] = &quot;booz&quot;;
 out = httpClient.post(url, httpParameters, httpFormDataParameters, args);
 // POST request with a body
 out = httpClient.post(url, std::string(&quot;foo=bar&quot;), args);
 // PUT and PATCH are available too.
 //
 // Result
 //
 auto statusCode = response-&gt;statusCode; // Can be HttpErrorCode::Ok, HttpErrorCode::UrlMalformed, etc...
 auto errorCode = response-&gt;errorCode; // 200, 404, etc...
 auto responseHeaders = response-&gt;headers; // All the headers in a special case-insensitive unordered_map of (string, string)
 auto body = response-&gt;body; // All the bytes from the response as an std::string
 auto errorMsg = response-&gt;errorMsg; // Descriptive error message in case of failure
 auto uploadSize = response-&gt;uploadSize; // Byte count of uploaded data
 auto downloadSize = response-&gt;downloadSize; // Byte count of downloaded data
 //
 // Asynchronous Request
 //
 bool async = true;
 HttpClient httpClient(async);
 auto args = httpClient.createRequest(url, HttpClient::kGet);
 // If you define a chunk callback it will be called repeteadly with the
 // incoming data. This allows to process data on the go or write it to disk
 // instead of accumulating the data in memory.
 args.onChunkCallback = [](const std::string&amp; data)
 {
    // process data
 };
 // Push the request to a queue,
 bool ok = httpClient.performRequest(args, [](const HttpResponsePtr&amp; response)
    {
        // This callback execute in a background thread. Make sure you uses appropriate protection such as mutex
        auto statusCode = response-&gt;statusCode; // acess results
        // response-&gt;body is empty if onChunkCallback was used
    }
 );
 // ok will be false if your httpClient is not async
 // A request in progress can be cancelled by setting the cancel flag. It does nothing if the request already completed.
 args-&gt;cancel = true;
 </code></pre>
 <p>See this <a href="https://github.com/machinezone/IXWebSocket/issues/209">issue</a> for links about uploading files with HTTP multipart.</p>
 <h2 id="http-server-api">HTTP server API</h2>
 <pre><code class="language-cpp">#include &lt;ixwebsocket/IXHttpServer.h&gt;
 ix::HttpServer server(port, hostname);
 auto res = server.listen();
 if (!res.first)
 {
    std::cerr &lt;&lt; res.second &lt;&lt; std::endl;
    return 1;
 }
 server.start();
 server.wait();
 </code></pre>
 <p>If you want to handle how requests are processed, implement the setOnConnectionCallback callback, which takes an HttpRequestPtr as input, and returns an HttpResponsePtr. You can look at HttpServer::setDefaultConnectionCallback for a slightly more advanced callback example.</p>
 <pre><code class="language-cpp">setOnConnectionCallback(
    [this](HttpRequestPtr request,
           std::shared_ptr&lt;ConnectionState&gt; connectionState) -&gt; HttpResponsePtr
    {
        // Build a string for the response
        std::stringstream ss;
        ss &lt;&lt; connectionState-&gt;getRemoteIp();
           &lt;&lt; &quot; &quot;
           &lt;&lt; request-&gt;method
           &lt;&lt; &quot; &quot;
           &lt;&lt; request-&gt;uri;
        std::string content = ss.str();
        return std::make_shared&lt;HttpResponse&gt;(200, &quot;OK&quot;,
                                              HttpErrorCode::Ok,
                                              WebSocketHttpHeaders(),
                                              content);
 }
 </code></pre>
 <h2 id="tls-support-and-configuration">TLS support and configuration</h2>
 <p>To leverage TLS features, the library must be compiled with the option <code>USE_TLS=1</code>.</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>
 <p>Then, secure sockets are automatically used when connecting to a <code>wss://*</code> url.</p>
 <p>Additional TLS options can be configured by passing a <code>ix::SocketTLSOptions</code> instance to the
 <code>setTLSOptions</code> on <code>ix::WebSocket</code> (or <code>ix::WebSocketServer</code> or <code>ix::HttpServer</code>)</p>
 <pre><code class="language-cpp">webSocket.setTLSOptions({
    .certFile = &quot;path/to/cert/file.pem&quot;,
    .keyFile = &quot;path/to/key/file.pem&quot;,
    .caFile = &quot;path/to/trust/bundle/file.pem&quot;, // as a file, or in memory buffer in PEM format
    .tls = true // required in server mode
 });
 </code></pre>
 <p>Specifying <code>certFile</code> and <code>keyFile</code> configures the certificate that will be used to communicate with TLS peers.</p>
 <p>On a client, this is only necessary for connecting to servers that require a client certificate.</p>
 <p>On a server, this is necessary for TLS support.</p>
 <p>Specifying <code>caFile</code> configures the trusted roots bundle file (in PEM format) that will be used to verify peer certificates.
 - The special value of <code>SYSTEM</code> (the default) indicates that the system-configured trust bundle should be used; this is generally what you want when connecting to any publicly exposed API/server.
 - The special value of <code>NONE</code> can be used to disable peer verification; this is only recommended to rule out certificate verification when testing connectivity.
 - If the value contain the special value <code>-----BEGIN CERTIFICATE-----</code>, the value will be read from memory, and not from a file. This is convenient on platforms like Android where reading / writing to the file system can be challenging without proper permissions, or without knowing the location of a temp directory.</p>
 <p>For a client, specifying <code>caFile</code> can be used if connecting to a server that uses a self-signed cert, or when using a custom CA in an internal environment.</p>
 <p>For a server, specifying <code>caFile</code> implies that:
 1. You require clients to present a certificate
 1. It must be signed by one of the trusted roots in the file</p>
 <p>By default, a destination's hostname is always validated against the certificate that it presents. To accept certificates with any hostname, set <code>ix::SocketTLSOptions::disable_hostname_validation</code> to <code>true</code>.</p></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,472 +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>Ws - 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 active">
                                <a href="./" 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="../usage/" class="nav-link">
                                    <i class="fa fa-arrow-left"></i> Previous
                                </a>
                            </li>
                            <li class="nav-item">
                                <a rel="next" class="nav-link disabled">
                                    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="#general" class="nav-link">General</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#curl" class="nav-link">curl</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#connect" class="nav-link">connect</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#echo-server" class="nav-link">echo server</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#websocket-proxy" class="nav-link">Websocket proxy</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#file-transfer" class="nav-link">File transfer</a>
              <ul class="nav flex-column">
              </ul>
            </li>
            <li class="nav-item" data-level="2"><a href="#http-client" class="nav-link">HTTP Client</a>
              <ul class="nav flex-column">
              </ul>
            </li>
        </ul>
    </div>
 </div></div>
                    <div class="col-md-9" role="main">
 <h2 id="general">General</h2>
 <p>ws is a command line tool that should exercise most of the IXWebSocket code, and provide example code.</p>
 <pre><code>ws is a websocket tool
 Usage: ws [OPTIONS] SUBCOMMAND
 Options:
  -h,--help                   Print this help message and exit
 Subcommands:
  send                        Send a file
  receive                     Receive a file
  transfer                    Broadcasting server
  connect                     Connect to a remote server
  chat                        Group chat
  echo_server                 Echo server
  broadcast_server            Broadcasting server
  ping                        Ping pong
  curl                        HTTP Client
  httpd                       HTTP server
 </code></pre>
 <h2 id="curl">curl</h2>
 <p>The curl subcommand try to be compatible with the curl syntax, to fetch http pages.</p>
 <p>Making a HEAD request with the -I parameter.</p>
 <pre><code>$ ws curl -I https://www.google.com/
 Accept-Ranges: none
 Alt-Svc: quic=&quot;:443&quot;; ma=2592000; v=&quot;46,43&quot;,h3-Q048=&quot;:443&quot;; ma=2592000,h3-Q046=&quot;:443&quot;; ma=2592000,h3-Q043=&quot;:443&quot;; ma=2592000
 Cache-Control: private, max-age=0
 Content-Type: text/html; charset=ISO-8859-1
 Date: Tue, 08 Oct 2019 21:36:57 GMT
 Expires: -1
 P3P: CP=&quot;This is not a P3P policy! See g.co/p3phelp for more info.&quot;
 Server: gws
 Set-Cookie: NID=188=ASwfz8GrXQrHCLqAz-AndLOMLcz0rC9yecnf3h0yXZxRL3rTufTU_GDDwERp7qQL7LZ_EB8gCRyPXGERyOSAgaqgnrkoTmvWrwFemRLMaOZ896GrHobi5fV7VLklnSG2w48Gj8xMlwxfP7Z-bX-xR9UZxep1tHM6UmFQdD_GkBE; expires=Wed, 08-Apr-2020 21:36:57 GMT; path=/; domain=.google.com; HttpOnly
 Transfer-Encoding: chunked
 Vary: Accept-Encoding
 X-Frame-Options: SAMEORIGIN
 X-XSS-Protection: 0
 Upload size: 143
 Download size: 0
 Status: 200
 </code></pre>
 <p>Making a POST request with the -F parameter.</p>
 <pre><code>$ ws curl -F foo=bar https://httpbin.org/post
 foo: bar
 Downloaded 438 bytes out of 438
 Access-Control-Allow-Credentials: true
 Access-Control-Allow-Origin: *
 Connection: keep-alive
 Content-Encoding:
 Content-Length: 438
 Content-Type: application/json
 Date: Tue, 08 Oct 2019 21:47:54 GMT
 Referrer-Policy: no-referrer-when-downgrade
 Server: nginx
 X-Content-Type-Options: nosniff
 X-Frame-Options: DENY
 X-XSS-Protection: 1; mode=block
 Upload size: 219
 Download size: 438
 Status: 200
 payload: {
  &quot;args&quot;: {},
  &quot;data&quot;: &quot;&quot;,
  &quot;files&quot;: {},
  &quot;form&quot;: {
    &quot;foo&quot;: &quot;bar&quot;
  },
  &quot;headers&quot;: {
    &quot;Accept&quot;: &quot;*/*&quot;,
    &quot;Content-Length&quot;: &quot;7&quot;,
    &quot;Content-Type&quot;: &quot;application/x-www-form-urlencoded&quot;,
    &quot;Host&quot;: &quot;httpbin.org&quot;,
    &quot;User-Agent&quot;: &quot;ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11&quot;
  },
  &quot;json&quot;: null,
  &quot;origin&quot;: &quot;155.94.127.118, 155.94.127.118&quot;,
  &quot;url&quot;: &quot;https://httpbin.org/post&quot;
 }
 </code></pre>
 <p>Passing in a custom header with -H.</p>
 <pre><code>$ ws curl -F foo=bar -H 'my_custom_header: baz' https://httpbin.org/post
 my_custom_header:  baz
 foo: bar
 Downloaded 470 bytes out of 470
 Access-Control-Allow-Credentials: true
 Access-Control-Allow-Origin: *
 Connection: keep-alive
 Content-Encoding:
 Content-Length: 470
 Content-Type: application/json
 Date: Tue, 08 Oct 2019 21:50:25 GMT
 Referrer-Policy: no-referrer-when-downgrade
 Server: nginx
 X-Content-Type-Options: nosniff
 X-Frame-Options: DENY
 X-XSS-Protection: 1; mode=block
 Upload size: 243
 Download size: 470
 Status: 200
 payload: {
  &quot;args&quot;: {},
  &quot;data&quot;: &quot;&quot;,
  &quot;files&quot;: {},
  &quot;form&quot;: {
    &quot;foo&quot;: &quot;bar&quot;
  },
  &quot;headers&quot;: {
    &quot;Accept&quot;: &quot;*/*&quot;,
    &quot;Content-Length&quot;: &quot;7&quot;,
    &quot;Content-Type&quot;: &quot;application/x-www-form-urlencoded&quot;,
    &quot;Host&quot;: &quot;httpbin.org&quot;,
    &quot;My-Custom-Header&quot;: &quot;baz&quot;,
    &quot;User-Agent&quot;: &quot;ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11&quot;
  },
  &quot;json&quot;: null,
  &quot;origin&quot;: &quot;155.94.127.118, 155.94.127.118&quot;,
  &quot;url&quot;: &quot;https://httpbin.org/post&quot;
 }
 </code></pre>
 <h2 id="connect">connect</h2>
 <p>The connect command connects to a websocket endpoint, and starts an interactive prompt. Line editing, such as using the direction keys to fetch the last thing you tried to type) is provided. That command is pretty useful to try to send random data to an endpoint and verify that the service handles it with grace (such as sending invalid json).</p>
 <pre><code>ws connect wss://echo.websocket.org
 Type Ctrl-D to exit prompt...
 Connecting to url: wss://echo.websocket.org
 &gt; ws_connect: connected
 Uri: /
 Handshake Headers:
 Connection: Upgrade
 Date: Tue, 08 Oct 2019 21:38:44 GMT
 Sec-WebSocket-Accept: 2j6LBScZveqrMx1W/GJkCWvZo3M=
 sec-websocket-extensions:
 Server: Kaazing Gateway
 Upgrade: websocket
 Received ping
 Received ping
 Received ping
 Hello world !
 &gt; Received 13 bytes
 ws_connect: received message: Hello world !
 &gt; Hello world !
 &gt; Received 13 bytes
 ws_connect: received message: Hello world !
 </code></pre>
 <pre><code>ws connect 'ws://jeanserge.com/v2?appkey=_pubsub'
 Type Ctrl-D to exit prompt...
 Connecting to url: ws://jeanserge.com/v2?appkey=_pubsub
 &gt; ws_connect: connected
 Uri: /v2?appkey=_pubsub
 Handshake Headers:
 Connection: Upgrade
 Date: Tue, 08 Oct 2019 21:45:28 GMT
 Sec-WebSocket-Accept: LYHmjh9Gsu/Yw7aumQqyPObOEV4=
 Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
 Server: Python/3.7 websockets/8.0.2
 Upgrade: websocket
 bababababababab
 &gt; ws_connect: connection closed: code 1000 reason
 ws_connect: connected
 Uri: /v2?appkey=_pubsub
 Handshake Headers:
 Connection: Upgrade
 Date: Tue, 08 Oct 2019 21:45:44 GMT
 Sec-WebSocket-Accept: I1rqxdLgTU+opPi5/zKPBTuXdLw=
 Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
 Server: Python/3.7 websockets/8.0.2
 Upgrade: websocket
 </code></pre>
 <p>It is possible to pass custom HTTP header when doing the connection handshake,
 the remote server might process them to implement a simple authorization
 scheme.</p>
 <pre><code>src$ ws connect -H Authorization:supersecret ws://localhost:8008
 Type Ctrl-D to exit prompt...
 [2020-12-17 22:35:08.732] [info] Authorization: supersecret
 Connecting to url: ws://localhost:8008
 &gt; [2020-12-17 22:35:08.736] [info] ws_connect: connected
 [2020-12-17 22:35:08.736] [info] Uri: /
 [2020-12-17 22:35:08.736] [info] Headers:
 [2020-12-17 22:35:08.736] [info] Connection: Upgrade
 [2020-12-17 22:35:08.736] [info] Sec-WebSocket-Accept: 2yaTFcdwn8KL6IzSMj2u6Le7KTg=
 [2020-12-17 22:35:08.736] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
 [2020-12-17 22:35:08.736] [info] Server: ixwebsocket/11.0.4 macos ssl/SecureTransport zlib 1.2.11
 [2020-12-17 22:35:08.736] [info] Upgrade: websocket
 [2020-12-17 22:35:08.736] [info] Received 25 bytes
 ws_connect: received message: Authorization suceeded!
 [2020-12-17 22:35:08.736] [info] Received pong ixwebsocket::heartbeat::30s::0
 hello
 &gt; [2020-12-17 22:35:25.157] [info] Received 7 bytes
 ws_connect: received message: hello
 </code></pre>
 <p>If the wrong header is passed in, the server would close the connection with a custom close code (&gt;4000, and &lt;4999).</p>
 <pre><code>[2020-12-17 22:39:37.044] [info] Upgrade: websocket
 ws_connect: connection closed: code 4001 reason Permission denied
 </code></pre>
 <h2 id="echo-server">echo server</h2>
 <p>The ws echo server will respond what the client just sent him. If we use the
 simple --http_authorization_header we can enforce that client need to pass a
 special value in the Authorization header to connect.</p>
 <pre><code>$ ws echo_server --http_authorization_header supersecret
 [2020-12-17 22:35:06.192] [info] Listening on 127.0.0.1:8008
 [2020-12-17 22:35:08.735] [info] New connection
 [2020-12-17 22:35:08.735] [info] remote ip: 127.0.0.1
 [2020-12-17 22:35:08.735] [info] id: 0
 [2020-12-17 22:35:08.735] [info] Uri: /
 [2020-12-17 22:35:08.735] [info] Headers:
 [2020-12-17 22:35:08.735] [info] Authorization: supersecret
 [2020-12-17 22:35:08.735] [info] Connection: Upgrade
 [2020-12-17 22:35:08.735] [info] Host: localhost:8008
 [2020-12-17 22:35:08.735] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
 [2020-12-17 22:35:08.735] [info] Sec-WebSocket-Key: eFF2Gf25dC7eC15Ab1135G==
 [2020-12-17 22:35:08.735] [info] Sec-WebSocket-Version: 13
 [2020-12-17 22:35:08.735] [info] Upgrade: websocket
 [2020-12-17 22:35:08.735] [info] User-Agent: ixwebsocket/11.0.4 macos ssl/SecureTransport zlib 1.2.11
 [2020-12-17 22:35:25.157] [info] Received 7 bytes
 </code></pre>
 <h2 id="websocket-proxy">Websocket proxy</h2>
 <pre><code>ws proxy_server --remote_host ws://127.0.0.1:9000 -v
 Listening on 127.0.0.1:8008
 </code></pre>
 <p>If you connect to ws://127.0.0.1:8008, the proxy will connect to ws://127.0.0.1:9000 and pass all traffic to this server.</p>
 <p>You can also use a more complex setup if you want to redirect to different websocket servers based on the hostname your client is trying to connect to. If you have multiple CNAME aliases that point to the same server.</p>
 <p>A JSON config file is used to express that mapping ; here connecting to echo.jeanserge.com will proxy the client to ws://localhost:8008 on the local machine (which actually runs ws echo_server), while connecting to bavarde.jeanserge.com will proxy the client to ws://localhost:5678 where a cobra python server is running. As a side note you will need a wildcard SSL certificate if you want to have SSL enabled on that machine.</p>
 <pre><code>echo.jeanserge.com=ws://localhost:8008
 bavarde.jeanserge.com=ws://localhost:5678
 </code></pre>
 <p>The --config_path option is required to instruct ws proxy_server to read that file.</p>
 <pre><code>ws proxy_server --config_path proxyConfig.json --port 8765
 </code></pre>
 <h2 id="file-transfer">File transfer</h2>
 <pre><code># Start transfer server, which is just a broadcast server at this point
 ws transfer # running on port 8080.
 # Start receiver first
 ws receive ws://localhost:8080
 # Then send a file. File will be received and written to disk by the receiver process
 ws send ws://localhost:8080 /file/to/path
 </code></pre>
 <h2 id="http-client">HTTP Client</h2>
 <pre><code>$ ws curl --help
 HTTP Client
 Usage: ws curl [OPTIONS] url
 Positionals:
  url TEXT REQUIRED           Connection url
 Options:
  -h,--help                   Print this help message and exit
  -d TEXT                     Form data
  -F TEXT                     Form data
  -H TEXT                     Header
  --output TEXT               Output file
  -I                          Send a HEAD request
  -L                          Follow redirects
  --max-redirects INT         Max Redirects
  -v                          Verbose
  -O                          Save output to disk
  --compress                  Enable gzip compression
  --connect-timeout INT       Connection timeout
  --transfer-timeout INT      Transfer timeout
 </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>
Author	SHA1	Message	Date
Benjamin Sergeant	a9ffa7da11	win code runs	2018-10-08 21:31:02 -07:00
Benjamin Sergeant	44e5ab7f7d	non blocking	2018-10-08 20:20:09 -07:00
Benjamin Sergeant	280d1d7366	bring includes from rtm	2018-10-08 20:17:31 -07:00
Benjamin Sergeant	37e899e872	compile errors	2018-10-08 18:42:56 -07:00
Benjamin Sergeant	644d988c29	Revert "win port wip" This reverts commit `b68a4c26f2`.	2018-10-08 18:27:32 -07:00
Benjamin Sergeant	b68a4c26f2	win port wip	2018-10-08 18:24:40 -07:00
Benjamin Sergeant	c3bf260330	windows port wip	2018-10-08 18:01:16 -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