do not hardcode server ports in unittest, get one dynamically with bind(0)

.clang-format

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

.dockerignore

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

.pre-commit-config.yaml

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

.travis.yml

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

CMake/FindMbedTLS.cmake

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

CMakeLists.txt

@@ -4,99 +4,53 @@
 #
 
 cmake_minimum_required(VERSION 3.4.1)
-set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/CMake;${CMAKE_MODULE_PATH}")
-
 project(ixwebsocket C CXX)
 
 set (CMAKE_CXX_STANDARD 14)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 
-if (UNIX)
+if (NOT WIN32)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 
-if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
-  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wshorten-64-to-32")
-endif()
-
 set( IXWEBSOCKET_SOURCES
-    ixwebsocket/IXCancellationRequest.cpp
-    ixwebsocket/IXConnectionState.cpp
-    ixwebsocket/IXDNSLookup.cpp
-    ixwebsocket/IXExponentialBackoff.cpp
-    ixwebsocket/IXHttp.cpp
-    ixwebsocket/IXHttpClient.cpp
-    ixwebsocket/IXHttpServer.cpp
-    ixwebsocket/IXNetSystem.cpp
-    ixwebsocket/IXSelectInterrupt.cpp
-    ixwebsocket/IXSelectInterruptFactory.cpp
+    ixwebsocket/IXEventFd.cpp
     ixwebsocket/IXSocket.cpp
-    ixwebsocket/IXSocketConnect.cpp
-    ixwebsocket/IXSocketFactory.cpp
     ixwebsocket/IXSocketServer.cpp
-    ixwebsocket/IXUrlParser.cpp
-    ixwebsocket/IXUserAgent.cpp
+    ixwebsocket/IXSocketConnect.cpp
+    ixwebsocket/IXDNSLookup.cpp
+    ixwebsocket/IXCancellationRequest.cpp
     ixwebsocket/IXWebSocket.cpp
-    ixwebsocket/IXWebSocketCloseConstants.cpp
+    ixwebsocket/IXWebSocketServer.cpp
+    ixwebsocket/IXWebSocketTransport.cpp
     ixwebsocket/IXWebSocketHandshake.cpp
-    ixwebsocket/IXWebSocketHttpHeaders.cpp
-    ixwebsocket/IXWebSocketMessageQueue.cpp
     ixwebsocket/IXWebSocketPerMessageDeflate.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
-    ixwebsocket/IXWebSocketServer.cpp
-    ixwebsocket/IXWebSocketTransport.cpp
-    ixwebsocket/LUrlParser.cpp
 )
 
 set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXCancellationRequest.h
-    ixwebsocket/IXConnectionState.h
-    ixwebsocket/IXDNSLookup.h
-    ixwebsocket/IXExponentialBackoff.h
-    ixwebsocket/IXHttp.h
-    ixwebsocket/IXHttpClient.h
-    ixwebsocket/IXHttpServer.h
-    ixwebsocket/IXNetSystem.h
-    ixwebsocket/IXProgressCallback.h
-    ixwebsocket/IXSelectInterrupt.h
-    ixwebsocket/IXSelectInterruptFactory.h
-    ixwebsocket/IXSetThreadName.h
+    ixwebsocket/IXEventFd.h
     ixwebsocket/IXSocket.h
-    ixwebsocket/IXSocketConnect.h
-    ixwebsocket/IXSocketFactory.h
     ixwebsocket/IXSocketServer.h
-    ixwebsocket/IXUrlParser.h
-    ixwebsocket/IXUtf8Validator.h
-    ixwebsocket/IXUserAgent.h
+    ixwebsocket/IXSocketConnect.h
+    ixwebsocket/IXSetThreadName.h
+    ixwebsocket/IXDNSLookup.h
+    ixwebsocket/IXCancellationRequest.h
     ixwebsocket/IXWebSocket.h
-    ixwebsocket/IXWebSocketCloseConstants.h
-    ixwebsocket/IXWebSocketCloseInfo.h
-    ixwebsocket/IXWebSocketErrorInfo.h
+    ixwebsocket/IXWebSocketServer.h
+    ixwebsocket/IXWebSocketTransport.h
     ixwebsocket/IXWebSocketHandshake.h
-    ixwebsocket/IXWebSocketHttpHeaders.h
-    ixwebsocket/IXWebSocketMessage.h
-    ixwebsocket/IXWebSocketMessageQueue.h
-    ixwebsocket/IXWebSocketMessageType.h
-    ixwebsocket/IXWebSocketOpenInfo.h
+    ixwebsocket/IXWebSocketSendInfo.h
+    ixwebsocket/IXWebSocketErrorInfo.h
     ixwebsocket/IXWebSocketPerMessageDeflate.h
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.h
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.h
-    ixwebsocket/IXWebSocketSendInfo.h
-    ixwebsocket/IXWebSocketServer.h
-    ixwebsocket/IXWebSocketTransport.h
-    ixwebsocket/IXWebSocketVersion.h
-    ixwebsocket/LUrlParser.h
+    ixwebsocket/IXWebSocketHttpHeaders.h
     ixwebsocket/libwshandshake.hpp
 )
 
-if (UNIX)
-    # Linux, Mac, iOS, Android
-    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptPipe.cpp )
-    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptPipe.h )
-endif()
-
 # Platform specific code
 if (APPLE)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/apple/IXSetThreadName_apple.cpp)
@@ -104,27 +58,18 @@ elseif (WIN32)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
 else()
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/linux/IXSetThreadName_linux.cpp)
-    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptEventFd.cpp)
-    list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSelectInterruptEventFd.h)
 endif()
 
-if (WIN32)
-  set(USE_MBED_TLS TRUE)
-endif()
-
-set(USE_OPEN_SSL FALSE)
 if (USE_TLS)
-    if (USE_MBED_TLS)
-        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketMbedTLS.h)
-        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketMbedTLS.cpp)
-    elseif (APPLE)
+    add_definitions(-DIXWEBSOCKET_USE_TLS)
+
+    if (APPLE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketAppleSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketAppleSSL.cpp)
     elseif (WIN32)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketSChannel.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketSChannel.cpp)
     else()
-        set(USE_OPEN_SSL TRUE)
         list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketOpenSSL.h)
         list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketOpenSSL.cpp)
     endif()
@@ -135,90 +80,35 @@ add_library( ixwebsocket STATIC
     ${IXWEBSOCKET_HEADERS}
 )
 
-if (USE_TLS)
-    target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_TLS)
-    if (USE_MBED_TLS)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_MBED_TLS)
-    elseif (APPLE)
-    elseif (WIN32)
-    else()
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
-    endif()
-endif()
+# gcc/Linux needs -pthread
+find_package(Threads)
 
-if (APPLE AND USE_TLS AND NOT USE_MBED_TLS)
-  target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
-endif()
-
-if (WIN32)
-  target_link_libraries(ixwebsocket wsock32 ws2_32)
-  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-endif()
-
-if (UNIX)
-  find_package(Threads)
-  target_link_libraries(ixwebsocket ${CMAKE_THREAD_LIBS_INIT})
-endif()
-
-if (USE_TLS AND USE_OPEN_SSL)
+if(UNIX AND NOT APPLE)
   find_package(OpenSSL REQUIRED)
   add_definitions(${OPENSSL_DEFINITIONS})
   message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
   include_directories(${OPENSSL_INCLUDE_DIR})
-  target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
 endif()
 
-if (USE_TLS AND USE_MBED_TLS)
-  if (USE_VENDORED_THIRD_PARTY)
-    set (ENABLE_PROGRAMS OFF)
-    add_subdirectory(third_party/mbedtls)
-    include_directories(third_party/mbedtls/include)
+if (WIN32)
+  get_filename_component(libz_path
+    ${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/release_dynamic/x64/lib/zlib.lib
+    ABSOLUTE)
+  add_library(libz STATIC IMPORTED)
+  set_target_properties(libz PROPERTIES IMPORTED_LOCATION
+    ${libz_path})
 
-    target_link_libraries(ixwebsocket mbedtls)
-  else()
-    find_package(MbedTLS REQUIRED)
-    target_include_directories(ixwebsocket PUBLIC ${MBEDTLS_INCLUDE_DIRS})
-    target_link_libraries(ixwebsocket ${MBEDTLS_LIBRARIES})
-  endif()
-endif()
+  include_directories(${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/include)
 
-find_package(ZLIB)
-if (ZLIB_FOUND)
-  include_directories(${ZLIB_INCLUDE_DIRS})
-  target_link_libraries(ixwebsocket ${ZLIB_LIBRARIES})
+  target_link_libraries(ixwebsocket libz wsock32 ws2_32)
+  add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+  
 else()
-  add_subdirectory(third_party/zlib)
-  include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
-  target_link_libraries(ixwebsocket zlibstatic)
+  target_link_libraries(ixwebsocket 
+    z ${OPENSSL_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
 endif()
 
 set( IXWEBSOCKET_INCLUDE_DIRS
     .
-)
-
-if (CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
-    # Build with Multiple Processes
-    target_compile_options(ixwebsocket PRIVATE /MP)
-endif()
-
-target_include_directories(ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS})
-
-set_target_properties(ixwebsocket PROPERTIES PUBLIC_HEADER "${IXWEBSOCKET_HEADERS}")
-
-install(TARGETS ixwebsocket
-        ARCHIVE DESTINATION ${CMAKE_INSTALL_PREFIX}/lib
-        PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_PREFIX}/include/ixwebsocket/
-)
-
-if (USE_WS OR USE_TEST)
-  add_subdirectory(ixcore)
-  add_subdirectory(ixcrypto)
-  add_subdirectory(ixcobra)
-
-  if (USE_WS)
-      add_subdirectory(ws)
-  endif()
-  if (USE_TEST)
-      add_subdirectory(test)
-  endif()
-endif()
+    ../../shared/OpenSSL/include)
+target_include_directories( ixwebsocket PUBLIC ${IXWEBSOCKET_INCLUDE_DIRS} )

DOCKER_VERSION

@@ -1 +0,0 @@
-6.2.1

Dockerfile

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

README.md

@@ -1,13 +1,321 @@
-## Hello world
+# General
 
 ![Alt text](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
 
-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.
+## Introduction
 
-It is been used on big mobile video game titles sending and receiving tons of messages since 2017 (iOS and Android).
+[*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex
+communication channels over a single TCP connection. *IXWebSocket* is a C++ library for client and server Websocket communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient) and from the [Satori C SDK](https://github.com/satori-com/satori-rtm-sdk-c). It has been tested on the following platforms.
 
-Interested ? Go read the [docs](https://machinezone.github.io/IXWebSocket/) ! If things don't work as expected, please create an issue in github, or even better a pull request if you know how to fix your problem.
+* macOS
+* iOS
+* Linux
+* Android 
+* Windows (no TLS support yet)
 
-IXWebSocket is actively being developed, check out the [changelog](CHANGELOG.md) to know what's cooking. If you are looking for a real time messaging service (the chat-like 'server' your websocket code will talk to) with many features such as history, backed by Redis, look at [cobra](https://github.com/machinezone/cobra).
+## Examples
 
-IXWebSocket client code is autobahn compliant beginning with the 6.0.0 version. See the current [test results](https://bsergean.github.io/IXWebSocket/autobahn/index.html). Some tests are still failing in the server code.
+The examples folder countains a simple chat program, using a node.js broadcast server.
+
+Here is what the client API looks like.
+
+```
+ix::WebSocket webSocket;
+
+std::string url("ws://localhost:8080/");
+webSocket.setUrl(url);
+
+// Optional heart beat, sent every 45 seconds when there isn't any traffic
+// to make sure that load balancers do not kill an idle connection.
+webSocket.setHeartBeatPeriod(45);
+
+// Setup a callback to be fired when a message or an event (open, close, error) is received
+webSocket.setOnMessageCallback(
+    [](ix::WebSocketMessageType messageType,
+       const std::string& str,
+       size_t wireSize,
+       const ix::WebSocketErrorInfo& error,
+       const ix::WebSocketCloseInfo& closeInfo,
+       const ix::WebSocketHttpHeaders& headers)
+    {
+        if (messageType == ix::WebSocket_MessageType_Message)
+        {
+            std::cout << str << std::endl;
+        }
+});
+
+// Now that our callback is setup, we can start our background thread and receive messages
+webSocket.start();
+
+// Send a message to the server
+webSocket.send("hello world");
+
+// ... finally ...
+
+// Stop the connection
+webSocket.stop()
+```
+
+Here is what the server API looks like. Note that server support is very recent and subject to changes.
+
+```
+// Run a server on localhost at a given port.
+// Bound host name, max connections and listen backlog can also be passed in as parameters.
+ix::WebSocketServer server(port);
+
+server.setOnConnectionCallback(
+    [&server](std::shared_ptr<ix::WebSocket> webSocket)
+    {
+        webSocket->setOnMessageCallback(
+            [webSocket, &server](ix::WebSocketMessageType messageType,
+               const std::string& str,
+               size_t wireSize,
+               const ix::WebSocketErrorInfo& error,
+               const ix::WebSocketOpenInfo& openInfo,
+               const ix::WebSocketCloseInfo& closeInfo)
+            {
+                if (messageType == ix::WebSocket_MessageType_Open)
+                {
+                    std::cerr << "New connection" << std::endl;
+                    std::cerr << "Uri: " << openInfo.uri << std::endl;
+                    std::cerr << "Headers:" << std::endl;
+                    for (auto it : openInfo.headers)
+                    {
+                        std::cerr << it.first << ": " << it.second << std::endl;
+                    }
+                }
+                else if (messageType == ix::WebSocket_MessageType_Message)
+                {
+                    // For an echo server, we just send back to the client whatever was received by the server
+                    // All connected clients are available in an std::set. See the broadcast cpp example.
+                    webSocket->send(str);
+                }
+            }
+        );
+    }
+);
+
+auto res = server.listen();
+if (!res.first)
+{
+    // Error handling
+    return 1;
+}
+
+// Run the server in the background. Server can be stoped by calling server.stop()
+server.start();
+
+// Block until server.stop() is called.
+server.wait();
+
+```
+
+## Build
+
+CMakefiles for the library and the examples are available. This library has few dependencies, so it is possible to just add the source files into your project.
+
+There is a Dockerfile for running some code on Linux, and a unittest which can be executed by typing `make test`.
+
+## Implementation details
+
+### Per Message Deflate compression.
+
+The per message deflate compression option is supported. It can lead to very nice bandbwith savings (20x !) if your messages are similar, which is often the case for example for chat applications. All features of the spec should be supported.
+
+### TLS/SSL
+
+Connections can be optionally secured and encrypted with TLS/SSL when using a wss:// endpoint, or using normal un-encrypted socket with ws:// endpoints. AppleSSL is used on iOS and macOS, and OpenSSL is used on Android and Linux.
+
+### Polling and background thread work
+
+No manual polling to fetch data is required. Data is sent and received instantly by using a background thread for receiving data and the select [system](http://man7.org/linux/man-pages/man2/select.2.html) call to be notified by the OS of incoming data. No timeout is used for select so that the background thread is only woken up when data is available, to optimize battery life. This is also the recommended way of using select according to the select tutorial, section [select law](https://linux.die.net/man/2/select_tut). Read and Writes to the socket are non blocking. Data is sent right away and not enqueued by writing directly to the socket, which is [possible](https://stackoverflow.com/questions/1981372/are-parallel-calls-to-send-recv-on-the-same-socket-valid) since system socket implementations allow concurrent read/writes. However concurrent writes need to be protected with mutex.
+
+### Automatic reconnection
+
+If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds.
+
+## Limitations
+
+* There is no text support for sending data, only the binary protocol is supported. Sending json or text over the binary protocol works well.
+* Automatic reconnection works at the TCP socket level, and will detect remote end disconnects. However, if the device/computer network become unreachable (by turning off wifi), it is quite hard to reliably and timely detect it at the socket level using `recv` and `send` error codes. [Here](https://stackoverflow.com/questions/14782143/linux-socket-how-to-detect-disconnected-network-in-a-client-program) is a good discussion on the subject. This behavior is consistent with other runtimes such as node.js. One way to detect a disconnected device with low level C code is to do a name resolution with DNS but this can be expensive. Mobile devices have good and reliable API to do that.
+* The server code is using select to detect incoming data, and creates one OS thread per connection. This isn't as scalable as strategies using epoll or kqueue.
+
+## 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. `./cmd_websocket_chat bob`
+6. Bring up a third terminal. `./cmd_websocket_chat bill`
+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.
+
+```
++-----------------------+ --- Public
+|                       | Start the receiving Background thread. Auto reconnection. Simple websocket Ping.
+|  IXWebSocket          | Interface used by C++ test clients. No IX dependencies.
+|                       | 
++-----------------------+
+|                       |
+|  IXWebSocketServer    | Run a server and give each connections its own WebSocket object.
+|                       | Each connection is handled in a new OS thread.
+|                       |
++-----------------------+ --- Private 
+|                       |
+|  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
+|                       |
++-----------------------+
+|                       |
+|  IXWebSocketHandshake | Establish the connection between client and server.
+|                       |
++-----------------------+
+|                       |
+|  IXWebSocket          | ws://  Unencrypted Socket handler
+|  IXWebSocketAppleSSL  | wss:// TLS encrypted Socket AppleSSL handler. Used on iOS and macOS
+|  IXWebSocketOpenSSL   | wss:// TLS encrypted Socket OpenSSL handler.  Used on Android and Linux
+|                       |                                               Can be used on macOS too.
++-----------------------+
+|                       |
+|  IXSocketConnect      | Connect to the remote host (client).
+|                       |
++-----------------------+
+|                       |
+|  IXDNSLookup          | Does DNS resolution asynchronously so that it can be interrupted.
+|                       |
++-----------------------+
+```
+
+## API
+
+### Sending messages
+
+`websocket.send("foo")` will send a message.
+
+If the connection was closed and sending failed, the return value will be set to false.
+
+### ReadyState
+
+`getReadyState()` returns the state of the connection. There are 4 possible states.
+
+1. WebSocket_ReadyState_Connecting - The connection is not yet open.
+2. WebSocket_ReadyState_Open       - The connection is open and ready to communicate.
+3. WebSocket_ReadyState_Closing    - The connection is in the process of closing.
+4. WebSocket_MessageType_Close     - The connection is closed or 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(
+    [](ix::WebSocketMessageType messageType,
+       const std::string& str,
+       size_t wireSize,
+       const ix::WebSocketErrorInfo& error,
+       const ix::WebSocketCloseInfo& closeInfo,
+       const ix::WebSocketHttpHeaders& headers)
+    {
+        if (messageType == ix::WebSocket_MessageType_Open)
+        {
+            std::cout << "send greetings" << std::endl;
+
+            // Headers can be inspected (pairs of string/string)
+            std::cout << "Handshake Headers:" << std::endl;
+            for (auto it : headers)
+            {
+                std::cout << it.first << ": " << it.second << std::endl;
+            }
+        }
+        else if (messageType == ix::WebSocket_MessageType_Close)
+        {
+            std::cout << "disconnected" << std::endl;
+
+            // The server can send an explicit code and reason for closing.
+            // This data can be accessed through the closeInfo object.
+            std::cout << closeInfo.code << std::endl;
+            std::cout << closeInfo.reason << std::endl;
+        }
+    }
+);
+```
+
+### Error notification
+
+A message will be fired when there is an error with the connection. The message type will be `ix::WebSocket_MessageType_Error`. Multiple fields will be available on the event to describe the error.
+
+```
+webSocket.setOnMessageCallback(
+    [](ix::WebSocketMessageType messageType,
+       const std::string& str,
+       size_t wireSize,
+       const ix::WebSocketErrorInfo& error,
+       const ix::WebSocketCloseInfo& closeInfo,
+       const ix::WebSocketHttpHeaders& headers)
+    {
+        if (messageType == ix::WebSocket_MessageType_Error)
+        {
+            std::stringstream ss;
+            ss << "Error: "         << error.reason      << std::endl;
+            ss << "#retries: "      << event.retries     << std::endl;
+            ss << "Wait time(ms): " << event.wait_time   << std::endl;
+            ss << "HTTP Status: "   << event.http_status << std::endl;
+            std::cout << ss.str() << std::endl;
+        }
+    }
+);
+```
+
+### start, stop
+
+1. `websocket.start()` connect to the remote server and starts the message receiving background thread.
+2. `websocket.stop()` disconnect from the remote server and closes the background thread.
+
+### Configuring the remote url
+
+The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
+
+```
+std::string url("wss://example.com");
+websocket.configure(url);
+```
+
+### Ping/Pong support
+
+Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
+
+```
+webSocket.setOnMessageCallback(
+    [](ix::WebSocketMessageType messageType,
+       const std::string& str,
+       size_t wireSize,
+       const ix::WebSocketErrorInfo& error,
+       const ix::WebSocketCloseInfo& closeInfo,
+       const ix::WebSocketHttpHeaders& headers)
+    {
+        if (messageType == ix::WebSocket_MessageType_Ping ||
+            messageType == ix::WebSocket_MessageType_Pong)
+        {
+            std::cout << "pong data: " << str << std::endl;
+        }
+    }
+);
+```
+
+A ping message can be sent to the server, with an optional data string.
+
+```
+websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
+
+### Heartbeat.
+
+You can configure an optional heart beat / keep-alive, sent every 45 seconds
+when there isn't any traffic to make sure that load balancers do not kill an
+idle connection.
+
+```
+webSocket.setHeartBeatPeriod(45);
+```

appveyor.yml

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

docker-compose.yml

@@ -1,43 +0,0 @@
-version: "3"
-services:
-  snake:
-    image: bsergean/ws:build
-    entrypoint: ws snake --port 8765 --host 0.0.0.0 --redis_hosts redis1
-    ports:
-      - "8765:8765"
-    networks:
-      - ws-net
-    depends_on:
-      - redis1
-
-  ws:
-    security_opt:
-    - seccomp:unconfined
-    cap_add:
-    - SYS_PTRACE
-    stdin_open: true
-    tty: true
-    image: bsergean/ws:build
-    entrypoint: bash
-    networks:
-      - ws-net
-    depends_on:
-      - redis1
-
-  redis1:
-    image: redis:alpine
-    networks:
-      - ws-net
-
-  statsd:
-    image: jaconel/statsd
-    ports:
-      - "8125:8125"
-    environment:
-      - STATSD_DUMP_MSG=true
-      - GRAPHITE_HOST=127.0.0.1
-    networks:
-      - ws-net
-
-networks:
-  ws-net:

docker/Dockerfile

@@ -0,0 +1,16 @@
+FROM debian:stretch
+
+# RUN yum install -y gcc-c++ make cmake openssl-devel gdb
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update 
+RUN apt-get -y install g++ 
+RUN apt-get -y install libssl-dev
+RUN apt-get -y install gdb
+RUN apt-get -y install screen
+RUN apt-get -y install procps
+RUN apt-get -y install lsof
+
+COPY . .
+
+WORKDIR examples/ws_connect
+RUN ["sh", "build_linux.sh"]

docker/Dockerfile.alpine

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

docker/Dockerfile.centos

@@ -0,0 +1,11 @@
+FROM alpine:3.8
+
+RUN apk add --no-cache g++ musl-dev make cmake openssl-dev
+
+COPY . .
+
+WORKDIR examples/ws_connect
+RUN ["sh", "build_linux.sh"]
+
+EXPOSE 8765
+CMD ["ws_connect"]

docker/Dockerfile.debian

@@ -1,52 +1,19 @@
-# Build time
-FROM debian:buster as build
+FROM debian:stretch
 
 ENV DEBIAN_FRONTEND noninteractive
 RUN apt-get update 
-RUN apt-get -y install wget 
-RUN mkdir -p /tmp/cmake
-WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
-RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
-
 RUN apt-get -y install g++ 
 RUN apt-get -y install libssl-dev
+RUN apt-get -y install gdb
+RUN apt-get -y install screen
+RUN apt-get -y install procps
+RUN apt-get -y install lsof
 RUN apt-get -y install libz-dev
+RUN apt-get -y install vim
 RUN apt-get -y install make
+RUN apt-get -y install cmake
 
 COPY . .
 
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-RUN ["make"]
-
-# Runtime
-FROM debian:buster as runtime
-
-ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update 
-# Runtime 
-RUN apt-get install -y libssl1.1 
-RUN apt-get install -y ca-certificates
-RUN ["update-ca-certificates"]
-
-# Debugging
-RUN apt-get install -y strace
-RUN apt-get install -y procps
-RUN apt-get install -y htop
-
-RUN adduser --disabled-password --gecos '' app
-COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
-RUN chmod +x /usr/local/bin/ws
-RUN ldd /usr/local/bin/ws
-
-# Now run in usermode
-USER app
-WORKDIR /home/app
-
-COPY --chown=app:app ws/snake/appsConfig.json .
-COPY --chown=app:app ws/cobraMetricsSample.json .
-
-ENTRYPOINT ["ws"]
-CMD ["--help"]
+WORKDIR test
+RUN ["sh", "build_linux.sh"]

docker/Dockerfile.fedora

@@ -1,43 +0,0 @@
-FROM fedora:30 as build
-
-RUN yum install -y gcc-g++
-RUN yum install -y cmake
-RUN yum install -y make
-RUN yum install -y openssl-devel
-
-RUN yum install -y wget
-RUN mkdir -p /tmp/cmake
-WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
-RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
-
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-RUN yum install -y python
-RUN yum install -y libtsan
-RUN yum install -y zlib-devel
-
-COPY . .
-# RUN ["make", "test"]
-RUN ["make"]
-
-# Runtime
-FROM fedora:30 as runtime
-
-RUN yum install -y libtsan
-
-RUN groupadd app && useradd -g app app 
-COPY --chown=app:app --from=build /usr/local/bin/ws /usr/local/bin/ws
-RUN chmod +x /usr/local/bin/ws
-RUN ldd /usr/local/bin/ws
-
-# Now run in usermode
-USER app
-WORKDIR /home/app
-
-COPY --chown=app:app ws/snake/appsConfig.json .
-COPY --chown=app:app ws/cobraMetricsSample.json .
-
-ENTRYPOINT ["ws"]
-CMD ["--help"]

docker/Dockerfile.gcc

@@ -0,0 +1,8 @@
+FROM gcc:8
+
+# RUN yum install -y gcc-c++ make cmake openssl-devel gdb
+
+COPY . .
+
+WORKDIR examples/ws_connect
+RUN ["sh", "build_linux.sh"]

docker/Dockerfile.ubuntu_bionic

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

docker/Dockerfile.ubuntu_disco

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

docker/Dockerfile.ubuntu_xenial

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

docs/CHANGELOG.md

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

docs/build.md

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

docs/design.md

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

docs/index.md

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

docs/usage.md

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

docs/ws.md

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

examples/broadcast_server/.gitignore

@@ -0,0 +1,9 @@
+CMakeCache.txt
+package-lock.json
+CMakeFiles		
+ixwebsocket_unittest	
+cmake_install.cmake	
+node_modules
+ixwebsocket
+Makefile
+build

examples/broadcast_server/CMakeLists.txt

@@ -0,0 +1,30 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+#
+
+cmake_minimum_required (VERSION 3.4.1)
+project (broadcast_server)
+
+# There's -Weverything too for clang
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
+
+set (OPENSSL_PREFIX /usr/local/opt/openssl) # Homebrew openssl
+
+set (CMAKE_CXX_STANDARD 14)
+
+option(USE_TLS "Add TLS support" ON)
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
+
+include_directories(broadcast_server .)
+
+add_executable(broadcast_server 
+  broadcast_server.cpp)
+
+if (APPLE AND USE_TLS)
+    target_link_libraries(broadcast_server "-framework foundation" "-framework security")
+endif()
+
+target_link_libraries(broadcast_server ixwebsocket)
+install(TARGETS broadcast_server DESTINATION bin)

examples/broadcast_server/broadcast_server.cpp

@@ -0,0 +1,74 @@
+/*
+ *  broadcast_server.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#include <iostream>
+#include <sstream>
+#include <ixwebsocket/IXWebSocketServer.h>
+
+int main(int argc, char** argv)
+{
+    int port = 8080;
+    if (argc == 2)
+    {
+        std::stringstream ss;
+        ss << argv[1];
+        ss >> port;
+    }
+
+    ix::WebSocketServer server(port);
+
+    server.setOnConnectionCallback(
+        [&server](std::shared_ptr<ix::WebSocket> webSocket)
+        {
+            webSocket->setOnMessageCallback(
+                [webSocket, &server](ix::WebSocketMessageType messageType,
+                   const std::string& str,
+                   size_t wireSize,
+                   const ix::WebSocketErrorInfo& error,
+                   const ix::WebSocketOpenInfo& openInfo,
+                   const ix::WebSocketCloseInfo& closeInfo)
+                {
+                    if (messageType == ix::WebSocket_MessageType_Open)
+                    {
+                        std::cerr << "New connection" << std::endl;
+                        std::cerr << "Uri: " << openInfo.uri << std::endl;
+                        std::cerr << "Headers:" << std::endl;
+                        for (auto it : openInfo.headers)
+                        {
+                            std::cerr << it.first << ": " << it.second << std::endl;
+                        }
+                    }
+                    else if (messageType == ix::WebSocket_MessageType_Close)
+                    {
+                        std::cerr << "Closed connection" << std::endl;
+                    }
+                    else if (messageType == ix::WebSocket_MessageType_Message)
+                    {
+                        for (auto&& client : server.getClients())
+                        {
+                            if (client != webSocket)
+                            {
+                                client->send(str);
+                            }
+                        }
+                    }
+                }
+            );
+        }
+    );
+
+    auto res = server.listen();
+    if (!res.first)
+    {
+        std::cerr << res.second << std::endl;
+        return 1;
+    }
+
+    server.start();
+    server.wait();
+
+    return 0;
+}

examples/chat/.gitignore

@@ -1,2 +1,3 @@
 build
+venv
 node_modules

examples/chat/CMakeLists.txt

@@ -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 14)
+
+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)

examples/chat/README.md

@@ -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
+```

examples/chat/build_linux.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+#
+
+# 'manual' way of building. You can also use cmake.
+
+g++ --std=c++11 \
+    ../../ixwebsocket/IXSocket.cpp	\
+    ../../ixwebsocket/IXWebSocketTransport.cpp \
+    ../../ixwebsocket/IXWebSocket.cpp \
+    -I ../.. \
+    cmd_websocket_chat.cpp \
+    -o cmd_websocket_chat

examples/chat/build_macos.sh

@@ -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

examples/chat/cmd_websocket_chat.cpp

@@ -1,12 +1,12 @@
 /*
- *  ws_chat.cpp
+ *  cmd_websocket_chat.cpp
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  */
 
 //
-// Simple chat program that talks to a broadcast server
-// Broadcast server can be ran with `ws broadcast_server`
+// Simple chat program that talks to the node.js server at
+// websocket_chat_server/broacast-server.js
 //
 
 #include <iostream>
@@ -20,13 +20,19 @@
 // for convenience
 using json = nlohmann::json;
 
-namespace ix
+using namespace ix;
+
+namespace
 {
+    void log(const std::string& msg)
+    {
+        std::cout << msg << std::endl;
+    }
+
     class WebSocketChat
     {
         public:
-            WebSocketChat(const std::string& url,
-                          const std::string& user);
+            WebSocketChat(const std::string& user);
 
             void subscribe(const std::string& channel);
             void start();
@@ -40,27 +46,19 @@ namespace ix
             std::pair<std::string, std::string> decodeMessage(const std::string& str);
 
         private:
-            std::string _url;
             std::string _user;
-            ix::WebSocket _webSocket;
-            std::queue<std::string> _receivedQueue;
 
-            void log(const std::string& msg);
+            ix::WebSocket _webSocket;
+
+            std::queue<std::string> _receivedQueue;
     };
 
-    WebSocketChat::WebSocketChat(const std::string& url,
-                                 const std::string& user) :
-        _url(url),
+    WebSocketChat::WebSocketChat(const std::string& user) :
         _user(user)
     {
         ;
     }
 
-    void WebSocketChat::log(const std::string& msg)
-    {
-        std::cout << msg << std::endl;
-    }
-
     size_t WebSocketChat::getReceivedMessagesCount() const
     {
         return _receivedQueue.size();
@@ -68,7 +66,7 @@ namespace ix
 
     bool WebSocketChat::isReady() const
     {
-        return _webSocket.getReadyState() == ix::ReadyState::Open;
+        return _webSocket.getReadyState() == ix::WebSocket_ReadyState_Open;
     }
 
     void WebSocketChat::stop()
@@ -78,42 +76,38 @@ namespace ix
 
     void WebSocketChat::start()
     {
-        _webSocket.setUrl(_url);
+        std::string url("ws://localhost:8080/");
+        _webSocket.setUrl(url);
 
         std::stringstream ss;
-        log(std::string("Connecting to url: ") + _url);
+        log(std::string("Connecting to url: ") + url);
 
         _webSocket.setOnMessageCallback(
-            [this](const WebSocketMessagePtr& msg)
+            [this](ix::WebSocketMessageType messageType,
+               const std::string& str,
+               size_t wireSize,
+               const ix::WebSocketErrorInfo& error,
+               const ix::WebSocketOpenInfo& openInfo,
+               const ix::WebSocketCloseInfo& closeInfo)
             {
                 std::stringstream ss;
-                if (msg->type == ix::WebSocketMessageType::Open)
+                if (messageType == ix::WebSocket_MessageType_Open)
                 {
-                    log("ws chat: connected");
-                    std::cout << "Uri: " << msg->openInfo.uri << std::endl;
-                    std::cout << "Handshake Headers:" << std::endl;
-                    for (auto it : msg->openInfo.headers)
-                    {
-                        std::cout << it.first << ": " << it.second << std::endl;
-                    }
-
-                    ss << "ws chat: user "
+                    ss << "cmd_websocket_chat: user "
                        << _user
                        << " Connected !";
                        log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Close)
+                else if (messageType == ix::WebSocket_MessageType_Close)
                 {
-                    ss << "ws chat: user "
+                    ss << "cmd_websocket_chat: user "
                        << _user
-                       << " disconnected !"
-                       << " code " << msg->closeInfo.code
-                       << " reason " << msg->closeInfo.reason;
+                       << " disconnected !";
                        log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Message)
+                else if (messageType == ix::WebSocket_MessageType_Message)
                 {
-                    auto result = decodeMessage(msg->str);
+                    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.
@@ -121,18 +115,18 @@ namespace ix
                     // store text
                     _receivedQueue.push(result.second);
 
-                    ss << std::endl
-                       << result.first << "(" << msg->wireSize << " bytes)" << " > " << result.second
+                    ss << std::endl 
+                       << result.first << " > " << result.second
                        << std::endl
                        << _user << " > ";
                     log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Error)
+                else if (messageType == ix::WebSocket_MessageType_Error)
                 {
-                    ss << "Connection error: " << msg->errorInfo.reason      << std::endl;
-                    ss << "#retries: "         << msg->errorInfo.retries     << std::endl;
-                    ss << "Wait time(ms): "    << msg->errorInfo.wait_time   << std::endl;
-                    ss << "HTTP Status: "      << msg->errorInfo.http_status << std::endl;
+                    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
@@ -167,14 +161,13 @@ namespace ix
 
     void WebSocketChat::sendMessage(const std::string& text)
     {
-        _webSocket.sendText(encodeMessage(text));
+        _webSocket.send(encodeMessage(text));
     }
 
-    int ws_chat_main(const std::string& url,
-                     const std::string& user)
+    void interactiveMain(const std::string& user)
     {
         std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
-        WebSocketChat webSocketChat(url, user);
+        WebSocketChat webSocketChat(user);
         webSocketChat.start();
 
         while (true)
@@ -193,7 +186,18 @@ namespace ix
 
         std::cout << std::endl;
         webSocketChat.stop();
-
-        return 0;
     }
 }
+
+int main(int argc, char** argv)
+{
+    std::string user("user");
+    if (argc == 2)
+    {
+        user = argv[1];
+    }
+
+    Socket::init();
+    interactiveMain(user);
+    return 0;
+}

examples/chat/package-lock.json

@@ -0,0 +1,31 @@
+{
+  "requires": true,
+  "lockfileVersion": 1,
+  "dependencies": {
+    "async-limiter": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.0.tgz",
+      "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg=="
+    },
+    "safe-buffer": {
+      "version": "5.1.2",
+      "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.1.2.tgz",
+      "integrity": "sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g=="
+    },
+    "ultron": {
+      "version": "1.1.1",
+      "resolved": "https://registry.npmjs.org/ultron/-/ultron-1.1.1.tgz",
+      "integrity": "sha512-UIEXBNeYmKptWH6z8ZnqTeS8fV74zG0/eRU9VGkpzz+LIJNs8W/zM/L+7ctCkRrgbNnnR0xxw4bKOr0cW0N0Og=="
+    },
+    "ws": {
+      "version": "3.3.3",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-3.3.3.tgz",
+      "integrity": "sha512-nnWLa/NwZSt4KQJu51MYlCcSQ5g7INpOrOMt4XV8j4dqTXdmlUmSHQ8/oLC069ckre0fRsgfvsKwbTdtKLCDkA==",
+      "requires": {
+        "async-limiter": "1.0.0",
+        "safe-buffer": "5.1.2",
+        "ultron": "1.1.1"
+      }
+    }
+  }
+}

examples/chat/package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "msgpack-js": "^0.3.0",
+    "ws": "^3.3.3"
+  }
+}

examples/cobra_publisher/.gitignore

@@ -0,0 +1,3 @@
+venv
+build
+node_modules

examples/cobra_publisher/CMakeLists.txt

@@ -0,0 +1,40 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+#
+
+cmake_minimum_required (VERSION 3.4.1)
+project (cobra_publisher)
+
+# There's -Weverything too for clang
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
+
+set (OPENSSL_PREFIX /usr/local/opt/openssl) # Homebrew openssl
+
+set (CMAKE_CXX_STANDARD 14)
+
+option(USE_TLS "Add TLS support" ON)
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
+
+include_directories(cobra_publisher ${OPENSSL_PREFIX}/include)
+include_directories(cobra_publisher .)
+
+add_executable(cobra_publisher 
+  jsoncpp/jsoncpp.cpp
+  ixcrypto/IXHMac.cpp
+  ixcrypto/IXBase64.cpp
+  IXCobraConnection.cpp
+  cobra_publisher.cpp)
+
+if (APPLE AND USE_TLS)
+    target_link_libraries(cobra_publisher "-framework foundation" "-framework security")
+endif()
+
+get_filename_component(crypto_lib_path ${OPENSSL_PREFIX}/lib/libcrypto.a ABSOLUTE)
+add_library(lib_crypto STATIC IMPORTED)
+set_target_properties(lib_crypto PROPERTIES IMPORTED_LOCATION ${crypto_lib_path})
+
+link_directories(/usr/local/opt/openssl/lib)
+target_link_libraries(cobra_publisher ixwebsocket lib_crypto)
+install(TARGETS cobra_publisher DESTINATION bin)

examples/cobra_publisher/IXCobraConnection.cpp

@@ -6,28 +6,23 @@
 
 #include "IXCobraConnection.h"
 #include <ixcrypto/IXHMac.h>
-#include <ixwebsocket/IXWebSocket.h>
 
 #include <algorithm>
 #include <stdexcept>
 #include <cmath>
 #include <cassert>
 #include <cstring>
-#include <iostream>
 
 
 namespace ix
 {
     TrafficTrackerCallback CobraConnection::_trafficTrackerCallback = nullptr;
-    PublishTrackerCallback CobraConnection::_publishTrackerCallback = nullptr;
     constexpr size_t CobraConnection::kQueueMaxSize;
 
     CobraConnection::CobraConnection() :
-        _webSocket(new WebSocket()),
-        _publishMode(CobraConnection_PublishMode_Immediate),
         _authenticated(false),
         _eventCallback(nullptr),
-        _id(0)
+        _publishMode(CobraConnection_PublishMode_Immediate)
     {
         _pdu["action"] = "rtm/publish";
 
@@ -37,7 +32,6 @@ namespace ix
     CobraConnection::~CobraConnection()
     {
         disconnect();
-        setEventCallback(nullptr);
     }
 
     void CobraConnection::setTrafficTrackerCallback(const TrafficTrackerCallback& callback)
@@ -58,24 +52,6 @@ namespace ix
         }
     }
 
-    void CobraConnection::setPublishTrackerCallback(const PublishTrackerCallback& callback)
-    {
-        _publishTrackerCallback = callback;
-    }
-
-    void CobraConnection::resetPublishTrackerCallback()
-    {
-        setPublishTrackerCallback(nullptr);
-    }
-
-    void CobraConnection::invokePublishTrackerCallback(bool sent, bool acked)
-    {
-        if (_publishTrackerCallback)
-        {
-            _publishTrackerCallback(sent, acked);
-        }
-    }
-
     void CobraConnection::setEventCallback(const EventCallback& eventCallback)
     {
         std::lock_guard<std::mutex> lock(_eventCallbackMutex);
@@ -83,70 +59,70 @@ namespace ix
     }
 
     void CobraConnection::invokeEventCallback(ix::CobraConnectionEventType eventType,
-                                              const std::string& errorMsg,
-                                              const WebSocketHttpHeaders& headers,
-                                              const std::string& subscriptionId,
-                                              CobraConnection::MsgId msgId)
+                                               const std::string& errorMsg,
+                                               const WebSocketHttpHeaders& headers)
     {
         std::lock_guard<std::mutex> lock(_eventCallbackMutex);
         if (_eventCallback)
         {
-            _eventCallback(eventType, errorMsg, headers, subscriptionId, msgId);
+            _eventCallback(eventType, errorMsg, headers);
         }
     }
 
-    void CobraConnection::invokeErrorCallback(const std::string& errorMsg,
-                                              const std::string& serializedPdu)
+    void CobraConnection::invokeErrorCallback(const std::string& errorMsg)
     {
-        std::stringstream ss;
-        ss << errorMsg << " : received pdu => " << serializedPdu;
-        invokeEventCallback(ix::CobraConnection_EventType_Error, ss.str());
+        invokeEventCallback(ix::CobraConnection_EventType_Error, errorMsg);
     }
 
     void CobraConnection::disconnect()
     {
         _authenticated = false;
-        _webSocket->stop();
+        _webSocket.stop();
     }
 
     void CobraConnection::initWebSocketOnMessageCallback()
     {
-        _webSocket->setOnMessageCallback(
-            [this](const ix::WebSocketMessagePtr& msg)
+        _webSocket.setOnMessageCallback(
+            [this](ix::WebSocketMessageType messageType,
+                   const std::string& str,
+                   size_t wireSize,
+                   const ix::WebSocketErrorInfo& error,
+                   const ix::WebSocketCloseInfo& closeInfo,
+                   const ix::WebSocketHttpHeaders& headers)
             {
-                CobraConnection::invokeTrafficTrackerCallback(msg->wireSize, true);
+                CobraConnection::invokeTrafficTrackerCallback(wireSize, true);
 
                 std::stringstream ss;
-                if (msg->type == ix::WebSocketMessageType::Open)
+                if (messageType == ix::WebSocket_MessageType_Open)
                 {
                     invokeEventCallback(ix::CobraConnection_EventType_Open,
                                         std::string(),
-                                        msg->openInfo.headers);
+                                        headers);
                     sendHandshakeMessage();
                 }
-                else if (msg->type == ix::WebSocketMessageType::Close)
+                else if (messageType == ix::WebSocket_MessageType_Close)
                 {
                     _authenticated = false;
 
                     std::stringstream ss;
-                    ss << "Close code " << msg->closeInfo.code;
-                    ss << " reason " << msg->closeInfo.reason;
+                    ss << "Close code " << closeInfo.code;
+                    ss << " reason " << closeInfo.reason;
                     invokeEventCallback(ix::CobraConnection_EventType_Closed,
                                         ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Message)
+                else if (messageType == ix::WebSocket_MessageType_Message)
                 {
                     Json::Value data;
                     Json::Reader reader;
-                    if (!reader.parse(msg->str, data))
+                    if (!reader.parse(str, data))
                     {
-                        invokeErrorCallback("Invalid json", msg->str);
+                        invokeErrorCallback(std::string("Invalid json: ") + str);
                         return;
                     }
 
                     if (!data.isMember("action"))
                     {
-                        invokeErrorCallback("Missing action", msg->str);
+                        invokeErrorCallback("Missing action");
                         return;
                     }
 
@@ -156,12 +132,12 @@ namespace ix
                     {
                         if (!handleHandshakeResponse(data))
                         {
-                            invokeErrorCallback("Error extracting nonce from handshake response", msg->str);
+                            invokeErrorCallback("Error extracting nonce from handshake response");
                         }
                     }
                     else if (action == "auth/handshake/error")
                     {
-                        invokeErrorCallback("Handshake error", msg->str);
+                        invokeErrorCallback("Handshake error."); // print full message ?
                     }
                     else if (action == "auth/authenticate/ok")
                     {
@@ -171,58 +147,25 @@ namespace ix
                     }
                     else if (action == "auth/authenticate/error")
                     {
-                        invokeErrorCallback("Authentication error", msg->str);
+                        invokeErrorCallback("Authentication error."); // print full message ?
                     }
                     else if (action == "rtm/subscription/data")
                     {
                         handleSubscriptionData(data);
                     }
-                    else if (action == "rtm/subscribe/ok")
-                    {
-                        if (!handleSubscriptionResponse(data))
-                        {
-                            invokeErrorCallback("Error processing subscribe response", msg->str);
-                        }
-                    }
-                    else if (action == "rtm/subscribe/error")
-                    {
-                        invokeErrorCallback("Subscription error", msg->str);
-                    }
-                    else if (action == "rtm/unsubscribe/ok")
-                    {
-                        if (!handleUnsubscriptionResponse(data))
-                        {
-                            invokeErrorCallback("Error processing unsubscribe response", msg->str);
-                        }
-                    }
-                    else if (action == "rtm/unsubscribe/error")
-                    {
-                        invokeErrorCallback("Unsubscription error", msg->str);
-                    }
-                    else if (action == "rtm/publish/ok")
-                    {
-                        if (!handlePublishResponse(data))
-                        {
-                            invokeErrorCallback("Error processing publish response", msg->str);
-                        }
-                    }
-                    else if (action == "rtm/publish/error")
-                    {
-                        invokeErrorCallback("Publish error", msg->str);
-                    }
                     else
                     {
-                        invokeErrorCallback("Un-handled message type", msg->str);
+                        invokeErrorCallback(std::string("Un-handled message type: ") + action);
                     }
                 }
-                else if (msg->type == ix::WebSocketMessageType::Error)
+                else if (messageType == ix::WebSocket_MessageType_Error)
                 {
                     std::stringstream ss;
-                    ss << "Connection error: " << msg->errorInfo.reason      << std::endl;
-                    ss << "#retries: "         << msg->errorInfo.retries     << std::endl;
-                    ss << "Wait time(ms): "    << msg->errorInfo.wait_time   << std::endl;
-                    ss << "HTTP Status: "      << msg->errorInfo.http_status << std::endl;
-                    invokeErrorCallback(ss.str(), std::string());
+                    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;
+                    invokeErrorCallback(ss.str());
                 }
         });
     }
@@ -233,22 +176,24 @@ namespace ix
     }
 
     void CobraConnection::configure(const std::string& appkey,
-                                    const std::string& endpoint,
-                                    const std::string& rolename,
-                                    const std::string& rolesecret,
-                                    const WebSocketPerMessageDeflateOptions& webSocketPerMessageDeflateOptions)
+                                     const std::string& endpoint,
+                                     const std::string& rolename,
+                                     const std::string& rolesecret,
+                                     WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions)
     {
-        _roleName = rolename;
-        _roleSecret = rolesecret;
+        _appkey = appkey;
+        _endpoint = endpoint;
+        _role_name = rolename;
+        _role_secret = rolesecret;
 
         std::stringstream ss;
-        ss << endpoint;
+        ss << _endpoint;
         ss << "/v2?appkey=";
-        ss << appkey;
+        ss << _appkey;
 
         std::string url = ss.str();
-        _webSocket->setUrl(url);
-        _webSocket->setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
+        _webSocket.setUrl(url);
+        _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
     }
 
     //
@@ -268,7 +213,7 @@ namespace ix
     bool CobraConnection::sendHandshakeMessage()
     {
         Json::Value data;
-        data["role"] = _roleName;
+        data["role"] = _role_name;
 
         Json::Value body;
         body["data"] = data;
@@ -277,15 +222,14 @@ namespace ix
         Json::Value pdu;
         pdu["action"] = "auth/handshake";
         pdu["body"] = body;
-        pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(pdu);
         CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
 
-        return _webSocket->send(serializedJson).success;
+        return _webSocket.send(serializedJson).success;
     }
 
-    //
+    // 
     // Extract the nonce from the handshake response
     // use it to compute a hash during authentication
     //
@@ -301,8 +245,6 @@ namespace ix
     //
     bool CobraConnection::handleHandshakeResponse(const Json::Value& pdu)
     {
-        if (!pdu.isObject()) return false;
-
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
@@ -333,7 +275,7 @@ namespace ix
     bool CobraConnection::sendAuthMessage(const std::string& nonce)
     {
         Json::Value credentials;
-        credentials["hash"] = hmac(nonce, _roleSecret);
+        credentials["hash"] = hmac(nonce, _role_secret);
 
         Json::Value body;
         body["credentials"] = credentials;
@@ -342,58 +284,20 @@ namespace ix
         Json::Value pdu;
         pdu["action"] = "auth/authenticate";
         pdu["body"] = body;
-        pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(pdu);
         CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
 
-        return _webSocket->send(serializedJson).success;
+        return _webSocket.send(serializedJson).success;
     }
 
-    bool CobraConnection::handleSubscriptionResponse(const Json::Value& pdu)
-    {
-        if (!pdu.isObject()) return false;
-
-        if (!pdu.isMember("body")) return false;
-        Json::Value body = pdu["body"];
-
-        if (!body.isMember("subscription_id")) return false;
-        Json::Value subscriptionId = body["subscription_id"];
-
-        if (!subscriptionId.isString()) return false;
-
-        invokeEventCallback(ix::CobraConnection_EventType_Subscribed,
-                            std::string(), WebSocketHttpHeaders(),
-                            subscriptionId.asString());
-        return true;
-    }
-
-    bool CobraConnection::handleUnsubscriptionResponse(const Json::Value& pdu)
-    {
-        if (!pdu.isObject()) return false;
-
-        if (!pdu.isMember("body")) return false;
-        Json::Value body = pdu["body"];
-
-        if (!body.isMember("subscription_id")) return false;
-        Json::Value subscriptionId = body["subscription_id"];
-
-        if (!subscriptionId.isString()) return false;
-
-        invokeEventCallback(ix::CobraConnection_EventType_UnSubscribed,
-                            std::string(), WebSocketHttpHeaders(),
-                            subscriptionId.asString());
-        return true;
-    }
 
     bool CobraConnection::handleSubscriptionData(const Json::Value& pdu)
     {
-        if (!pdu.isObject()) return false;
-
         if (!pdu.isMember("body")) return false;
         Json::Value body = pdu["body"];
 
-        // Identify subscription_id, so that we can find
+        // Identify subscription_id, so that we can find 
         // which callback to execute
         if (!body.isMember("subscription_id")) return false;
         Json::Value subscriptionId = body["subscription_id"];
@@ -414,40 +318,15 @@ namespace ix
         return true;
     }
 
-    bool CobraConnection::handlePublishResponse(const Json::Value& pdu)
-    {
-        if (!pdu.isObject()) return false;
-
-        if (!pdu.isMember("id")) return false;
-        Json::Value id = pdu["id"];
-
-        if (!id.isUInt64()) return false;
-
-        uint64_t msgId = id.asUInt64();
-
-        invokeEventCallback(ix::CobraConnection_EventType_Published,
-                            std::string(), WebSocketHttpHeaders(),
-                            std::string(), msgId);
-
-        invokePublishTrackerCallback(false, true);
-
-        return true;
-    }
-
     bool CobraConnection::connect()
     {
-        _webSocket->start();
+        _webSocket.start();
         return true;
     }
 
     bool CobraConnection::isConnected() const
     {
-        return _webSocket->getReadyState() == ix::ReadyState::Open;
-    }
-
-    bool CobraConnection::isAuthenticated() const
-    {
-        return isConnected() && _authenticated;
+        return _webSocket.getReadyState() == ix::WebSocket_ReadyState_Open;
     }
 
     std::string CobraConnection::serializeJson(const Json::Value& value)
@@ -459,57 +338,50 @@ namespace ix
     //
     // publish is not thread safe as we are trying to reuse some Json objects.
     //
-    CobraConnection::MsgId CobraConnection::publish(const Json::Value& channels,
-                                                    const Json::Value& msg)
+    bool CobraConnection::publish(const Json::Value& channels,
+                                   const Json::Value& msg)
     {
-        invokePublishTrackerCallback(true, false);
-
-        CobraConnection::MsgId msgId = _id;
-
         _body["channels"] = channels;
         _body["message"] = msg;
         _pdu["body"] = _body;
-        _pdu["id"] = Json::UInt64(_id++);
 
         std::string serializedJson = serializeJson(_pdu);
 
-        //
-        // 1. When we use batch mode, we just enqueue and will do the flush explicitely
-        // 2. When we aren't authenticated yet to the cobra server, we need to enqueue
-        //    and retry later
-        // 3. If the network connection was droped (WebSocket::send will return false),
-        //    it means the message won't be sent so we need to enqueue as well.
-        //
-        // The order of the conditionals is important.
-        //
-        if (_publishMode == CobraConnection_PublishMode_Batch || !_authenticated ||
-            !publishMessage(serializedJson))
+        if (_publishMode == CobraConnection_PublishMode_Batch)
         {
             enqueue(serializedJson);
+            return true;
         }
 
-        return msgId;
+        //
+        // Fast path. We are authenticated and the publishing succeed
+        //            This should happen for 99% of the cases.
+        //
+        if (_authenticated && publishMessage(serializedJson))
+        {
+            return true;
+        }
+        else // Or else we enqueue
+             // Slow code path is when we haven't connected yet (startup),
+             // or when the connection drops for some reason.
+        {
+            enqueue(serializedJson);
+            return false;
+        }
     }
 
     void CobraConnection::subscribe(const std::string& channel,
-                                    const std::string& filter,
-                                    SubscriptionCallback cb)
+                                     SubscriptionCallback cb)
     {
         // Create and send a subscribe pdu
         Json::Value body;
         body["channel"] = channel;
 
-        if (!filter.empty())
-        {
-            body["filter"] = filter;
-        }
-
         Json::Value pdu;
         pdu["action"] = "rtm/subscribe";
         pdu["body"] = body;
-        pdu["id"] = Json::UInt64(_id++);
 
-        _webSocket->send(pdu.toStyledString());
+        _webSocket.send(pdu.toStyledString());
 
         // Set the callback
         std::lock_guard<std::mutex> lock(_cbsMutex);
@@ -528,14 +400,13 @@ namespace ix
 
         // Create and send an unsubscribe pdu
         Json::Value body;
-        body["subscription_id"] = channel;
+        body["channel"] = channel;
 
         Json::Value pdu;
         pdu["action"] = "rtm/unsubscribe";
         pdu["body"] = body;
-        pdu["id"] = Json::UInt64(_id++);
 
-        _webSocket->send(pdu.toStyledString());
+        _webSocket.send(pdu.toStyledString());
     }
 
     //
@@ -585,9 +456,9 @@ namespace ix
 
     bool CobraConnection::publishMessage(const std::string& serializedJson)
     {
-        auto webSocketSendInfo = _webSocket->send(serializedJson);
+        auto webSocketSendInfo = _webSocket.send(serializedJson);
         CobraConnection::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize,
-                                                      false);
+                                                       false);
         return webSocketSendInfo.success;
     }
 
@@ -600,5 +471,5 @@ namespace ix
     {
         connect();
     }
-
+    
 } // namespace ix

examples/cobra_publisher/IXCobraConnection.h

@@ -6,30 +6,24 @@
 
 #pragma once
 
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
-#include <jsoncpp/json/json.h>
-#include <memory>
 #include <mutex>
 #include <queue>
 #include <string>
 #include <thread>
 #include <unordered_map>
-#include <limits>
+
+#include <jsoncpp/json/json.h>
+#include <ixwebsocket/IXWebSocket.h>
+#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
 
 namespace ix
 {
-    class WebSocket;
-
     enum CobraConnectionEventType
     {
         CobraConnection_EventType_Authenticated = 0,
         CobraConnection_EventType_Error = 1,
         CobraConnection_EventType_Open = 2,
-        CobraConnection_EventType_Closed = 3,
-        CobraConnection_EventType_Subscribed = 4,
-        CobraConnection_EventType_UnSubscribed = 5,
-        CobraConnection_EventType_Published = 6
+        CobraConnection_EventType_Closed = 3
     };
 
     enum CobraConnectionPublishMode
@@ -41,18 +35,12 @@ namespace ix
     using SubscriptionCallback = std::function<void(const Json::Value&)>;
     using EventCallback = std::function<void(CobraConnectionEventType,
                                              const std::string&,
-                                             const WebSocketHttpHeaders&,
-                                             const std::string&,
-                                             uint64_t msgId)>;
-
+                                             const WebSocketHttpHeaders&)>;
     using TrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
-    using PublishTrackerCallback = std::function<void(bool sent, bool acked)>;
 
     class CobraConnection
     {
     public:
-        using MsgId = uint64_t;
-
         CobraConnection();
         ~CobraConnection();
 
@@ -62,20 +50,13 @@ namespace ix
                        const std::string& endpoint,
                        const std::string& rolename,
                        const std::string& rolesecret,
-                       const WebSocketPerMessageDeflateOptions& webSocketPerMessageDeflateOptions);
+                       WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions);
 
-        /// Set the traffic tracker callback
         static void setTrafficTrackerCallback(const TrafficTrackerCallback& callback);
 
         /// Reset the traffic tracker callback to an no-op one.
         static void resetTrafficTrackerCallback();
 
-        /// Set the publish tracker callback
-        static void setPublishTrackerCallback(const PublishTrackerCallback& callback);
-
-        /// Reset the publish tracker callback to an no-op one.
-        static void resetPublishTrackerCallback();
-
         /// Set the closed callback
         void setEventCallback(const EventCallback& eventCallback);
 
@@ -85,13 +66,12 @@ namespace ix
         /// Publish a message to a channel
         ///
         /// No-op if the connection is not established
-        MsgId publish(const Json::Value& channels, const Json::Value& msg);
+        bool publish(const Json::Value& channels,
+                     const Json::Value& msg);
 
         // Subscribe to a channel, and execute a callback when an incoming
         // message arrives.
-        void subscribe(const std::string& channel,
-                       const std::string& filter = std::string(),
-                       SubscriptionCallback cb = nullptr);
+        void subscribe(const std::string& channel, SubscriptionCallback cb);
 
         /// Unsubscribe from a channel
         void unsubscribe(const std::string& channel);
@@ -104,10 +84,7 @@ namespace ix
 
         /// Returns true only if we're connected
         bool isConnected() const;
-
-        /// Returns true only if we're authenticated
-        bool isAuthenticated() const;
-
+        
         /// Flush the publish queue
         bool flushQueue();
 
@@ -123,9 +100,6 @@ namespace ix
         bool handleHandshakeResponse(const Json::Value& data);
         bool sendAuthMessage(const std::string& nonce);
         bool handleSubscriptionData(const Json::Value& pdu);
-        bool handleSubscriptionResponse(const Json::Value& pdu);
-        bool handleUnsubscriptionResponse(const Json::Value& pdu);
-        bool handlePublishResponse(const Json::Value& pdu);
 
         void initWebSocketOnMessageCallback();
 
@@ -136,25 +110,22 @@ namespace ix
         /// Invoke the traffic tracker callback
         static void invokeTrafficTrackerCallback(size_t size, bool incoming);
 
-        /// Invoke the publish tracker callback
-        static void invokePublishTrackerCallback(bool sent, bool acked);
-
         /// Invoke event callbacks
         void invokeEventCallback(CobraConnectionEventType eventType,
                                  const std::string& errorMsg = std::string(),
-                                 const WebSocketHttpHeaders& headers = WebSocketHttpHeaders(),
-                                 const std::string& subscriptionId = std::string(),
-                                 uint64_t msgId = std::numeric_limits<uint64_t>::max());
-        void invokeErrorCallback(const std::string& errorMsg, const std::string& serializedPdu);
+                                 const WebSocketHttpHeaders& headers = WebSocketHttpHeaders());
+        void invokeErrorCallback(const std::string& errorMsg);
 
         ///
         /// Member variables
-        ///
-        std::unique_ptr<WebSocket> _webSocket;
+        /// 
+        WebSocket _webSocket;
 
         /// Configuration data
-        std::string _roleName;
-        std::string _roleSecret;
+        std::string _appkey;
+        std::string _endpoint;
+        std::string _role_name;
+        std::string _role_secret;
         std::atomic<CobraConnectionPublishMode> _publishMode;
 
         // Can be set on control+background thread, protecting with an atomic
@@ -169,9 +140,6 @@ namespace ix
         /// Traffic tracker callback
         static TrafficTrackerCallback _trafficTrackerCallback;
 
-        /// Publish tracker callback
-        static PublishTrackerCallback _publishTrackerCallback;
-
         /// Cobra events callbacks
         EventCallback _eventCallback;
         mutable std::mutex _eventCallbackMutex;
@@ -180,19 +148,16 @@ namespace ix
         std::unordered_map<std::string, SubscriptionCallback> _cbs;
         mutable std::mutex _cbsMutex;
 
-        // Message Queue can be touched on control+background thread,
+        // Message Queue can be touched on control+background thread, 
         // protecting with a mutex.
         //
-        // Message queue is used when there are problems sending messages so
+        // Message queue is used when there are problems sending messages so 
         // that sending can be retried later.
         std::deque<std::string> _messageQueue;
         mutable std::mutex _queueMutex;
 
         // Cap the queue size (100 elems so far -> ~100k)
         static constexpr size_t kQueueMaxSize = 256;
-
-        // Each pdu sent should have an incremental unique id
-        std::atomic<uint64_t> _id;
     };
-
+    
 } // namespace ix

examples/cobra_publisher/README.md

@@ -0,0 +1,6 @@
+```
+mkdir build
+cd build
+cmake ..
+make && (cd .. ; sh cobra_publisher.sh)
+```

examples/cobra_publisher/cobra_publisher.cpp

@@ -0,0 +1,123 @@
+/*
+ *  cobra_publisher.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#include <iostream>
+#include <sstream>
+#include <fstream>
+#include <atomic>
+#include <ixwebsocket/IXWebSocket.h>
+#include "IXCobraConnection.h"
+#include "jsoncpp/json/json.h"
+
+void msleep(int ms)
+{
+    std::chrono::duration<double, std::milli> duration(ms);
+    std::this_thread::sleep_for(duration);
+}
+
+int main(int argc, char* argv[])
+{
+    if (argc != 7)
+    {
+        std::cerr << "Usage error: need 6 arguments." << std::endl;
+    }
+
+    std::string endpoint = argv[1];
+    std::string appkey = argv[2];
+    std::string channel = argv[3];
+    std::string rolename = argv[4];
+    std::string rolesecret = argv[5];
+    std::string path = argv[6];
+
+    std::atomic<size_t> incomingBytes(0);
+    std::atomic<size_t> outgoingBytes(0);
+    ix::CobraConnection::setTrafficTrackerCallback(
+        [&incomingBytes, &outgoingBytes](size_t size, bool incoming)
+        {
+            if (incoming)
+            {
+                incomingBytes += size;
+            }
+            else
+            {
+                outgoingBytes += size;
+            }
+        }
+    );
+
+    bool done = false;
+    ix::CobraConnection cobraConnection;
+    ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(
+        true, false, false, 15, 15);
+    cobraConnection.configure(appkey, endpoint, rolename, rolesecret,
+                               webSocketPerMessageDeflateOptions);
+    cobraConnection.connect();
+    cobraConnection.setEventCallback(
+        [&cobraConnection, channel, path, &done]
+        (ix::CobraConnectionEventType eventType,
+         const std::string& errMsg,
+         const ix::WebSocketHttpHeaders& headers)
+        {
+            if (eventType == ix::CobraConnection_EventType_Open)
+            {
+                std::cout << "Handshake Headers:" << std::endl;
+                for (auto it : headers)
+                {
+                    std::cout << it.first << ": " << it.second << std::endl;
+                }
+            }
+            else if (eventType == ix::CobraConnection_EventType_Authenticated)
+            {
+                std::cout << "Authenticated" << std::endl;
+
+                std::string line;
+                std::ifstream f(path);
+                if (!f.is_open())
+                {
+                    std::cerr << "Error while opening file: " << path << std::endl;
+                }
+
+                int n = 0;
+                while (getline(f, line))
+                {
+                    Json::Value value;
+                    Json::Reader reader;
+                    reader.parse(line, value);
+
+                    cobraConnection.publish(channel, value);
+                    n++;
+                }
+                std::cerr << "#published messages: " << n << std::endl;
+
+                if (f.bad())
+                {
+                    std::cerr << "Error while opening file: " << path << std::endl;
+                }
+
+                done = true;
+            }
+            else if (eventType == ix::CobraConnection_EventType_Error)
+            {
+                std::cerr << "Cobra Error received: " << errMsg << std::endl;
+                done = true;
+            }
+            else if (eventType == ix::CobraConnection_EventType_Closed)
+            {
+                std::cerr << "Cobra connection closed" << std::endl;
+            }
+        }
+    );
+
+    while (!done)
+    {
+        msleep(1);
+    }
+
+    std::cout << "Incoming bytes: " << incomingBytes << std::endl;
+    std::cout << "Outgoing bytes: " << outgoingBytes << std::endl;
+
+    return 0;
+}

examples/cobra_publisher/cobra_publisher.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+
+endpoint="ws://127.0.0.1:8765"
+endpoint="ws://127.0.0.1:5678"
+appkey="appkey"
+channel="foo"
+rolename="a_role"
+rolesecret="a_secret"
+filename=${FILENAME:=events.jsonl}
+
+build/cobra_publisher $endpoint $appkey $channel $rolename $rolesecret $filename

examples/cobra_publisher/devnull_server.js

@@ -0,0 +1,45 @@
+/*
+ *  devnull_server.js
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+const WebSocket = require('ws');
+
+let wss = new WebSocket.Server({ port: 5678, perMessageDeflate: true })
+
+wss.on('connection', (ws) => {
+
+  let handshake = false
+  let authenticated = false
+
+  ws.on('message', (data) => {
+
+    console.log(data.toString('utf-8'))
+
+    if (!handshake) {
+      let response = {
+          "action": "auth/handshake/ok",
+          "body": {
+              "data": {
+                  "nonce": "MTI0Njg4NTAyMjYxMzgxMzgzMg==",
+                  "version": "0.0.24"
+              }
+          },
+          "id": 1
+      }
+      ws.send(JSON.stringify(response))
+      handshake = true
+    } else if (!authenticated) {
+      let response = {
+        "action": "auth/authenticate/ok",
+        "body": {},
+        "id": 2
+      }
+      
+      ws.send(JSON.stringify(response))
+      authenticated = true
+    } else {
+      console.log(data)
+    }
+  });
+})

examples/cobra_publisher/devnull_server.py

@@ -0,0 +1,43 @@
+#!/usr/bin/env python
+
+import os
+import json
+import asyncio
+import websockets
+
+
+async def echo(websocket, path):
+    handshake = False
+    authenticated = False
+
+    async for message in websocket:
+        print(message)
+
+        if not handshake:
+            response = {
+                "action": "auth/handshake/ok",
+                "body": {
+                    "data": {
+                        "nonce": "MTI0Njg4NTAyMjYxMzgxMzgzMg==",
+                        "version": "0.0.24"
+                    }
+                },
+                "id": 1
+            }
+            await websocket.send(json.dumps(response))
+            handshake = True
+
+        elif not authenticated:
+            response = {
+                "action": "auth/authenticate/ok",
+                "body": {},
+                "id": 2
+            }
+          
+            await websocket.send(json.dumps(response))
+            authenticated = True
+
+
+asyncio.get_event_loop().run_until_complete(
+    websockets.serve(echo, 'localhost', 5678))
+asyncio.get_event_loop().run_forever()

examples/cobra_publisher/events.jsonl

@@ -0,0 +1,3 @@
+{"array":[1,2,3],"boolean":true,"color":"#82b92c","null":null,"number":123,"object":{"a":"b","c":"d","e":"f"},"string":"Foo"}
+{"array":[1,2,3],"boolean":true,"color":"#82b92c","null":null,"number":123,"object":{"a":"b","c":"d","e":"f"},"string":"Bar"}
+{"array":[1,2,3],"boolean":true,"color":"#82b92c","null":null,"number":123,"object":{"a":"b","c":"d","e":"f"},"string":"Baz"}

examples/cobra_publisher/ixcrypto/IXBase64.cpp

@@ -1,39 +1,39 @@
 /*
  base64.cpp and base64.h
-
+ 
  Copyright (C) 2004-2008 René Nyffenegger
-
+ 
  This source code is provided 'as-is', without any express or implied
  warranty. In no event will the author be held liable for any damages
  arising from the use of this software.
-
+ 
  Permission is granted to anyone to use this software for any purpose,
  including commercial applications, and to alter it and redistribute it
  freely, subject to the following restrictions:
-
+ 
  1. The origin of this source code must not be misrepresented; you must not
  claim that you wrote the original source code. If you use this source code
  in a product, an acknowledgment in the product documentation would be
  appreciated but is not required.
-
+ 
  2. Altered source versions must be plainly marked as such, and must not be
  misrepresented as being the original source code.
-
+ 
  3. This notice may not be removed or altered from any source distribution.
-
+ 
  René Nyffenegger rene.nyffenegger@adp-gmbh.ch
-
+ 
  */
 
 #include "IXBase64.h"
-
+    
 namespace ix
 {
     static const std::string base64_chars =
     "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
     "abcdefghijklmnopqrstuvwxyz"
     "0123456789+/";
-
+    
     std::string base64_encode(const std::string& data, size_t len)
     {
         std::string ret;
@@ -41,9 +41,9 @@ namespace ix
         int j = 0;
         unsigned char char_array_3[3];
         unsigned char char_array_4[4];
-
+        
         const char* bytes_to_encode = data.c_str();
-
+        
         while(len--)
         {
             char_array_3[i++] = *(bytes_to_encode++);
@@ -53,83 +53,32 @@ namespace ix
                 char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
                 char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
                 char_array_4[3] = char_array_3[2] & 0x3f;
-
+                
                 for(i = 0; (i <4) ; i++)
                     ret += base64_chars[char_array_4[i]];
-
+                
                 i = 0;
             }
         }
-
+        
         if(i)
         {
             for(j = i; j < 3; j++)
                 char_array_3[j] = '\0';
-
+            
             char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
             char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
             char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
             char_array_4[3] = char_array_3[2] & 0x3f;
-
+            
             for(j = 0; (j < i + 1); j++)
                 ret += base64_chars[char_array_4[j]];
-
+            
             while((i++ < 3))
                 ret += '=';
-
+            
         }
-
-        return ret;
-    }
-
-    static inline bool is_base64(unsigned char c)
-    {
-        return (isalnum(c) || (c == '+') || (c == '/'));
-    }
-
-    std::string base64_decode(const std::string& encoded_string)
-    {
-        int in_len = (int)encoded_string.size();
-        int i = 0;
-        int j = 0;
-        int in_ = 0;
-        unsigned char char_array_4[4], char_array_3[3];
-        std::string ret;
-
-        while(in_len-- && ( encoded_string[in_] != '=') && is_base64(encoded_string[in_]))
-        {
-            char_array_4[i++] = encoded_string[in_]; in_++;
-            if(i ==4)
-            {
-                for(i = 0; i <4; i++)
-                    char_array_4[i] = base64_chars.find(char_array_4[i]);
-
-                char_array_3[0] = (char_array_4[0] << 2) + ((char_array_4[1] & 0x30) >> 4);
-                char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2);
-                char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3];
-
-                for(i = 0; (i < 3); i++)
-                    ret += char_array_3[i];
-
-                i = 0;
-            }
-        }
-
-        if(i)
-        {
-            for(j = i; j <4; j++)
-                char_array_4[j] = 0;
-
-            for(j = 0; j <4; j++)
-                char_array_4[j] = base64_chars.find(char_array_4[j]);
-
-            char_array_3[0] = (char_array_4[0] << 2) + ((char_array_4[1] & 0x30) >> 4);
-            char_array_3[1] = ((char_array_4[1] & 0xf) << 4) + ((char_array_4[2] & 0x3c) >> 2);
-            char_array_3[2] = ((char_array_4[2] & 0x3) << 6) + char_array_4[3];
-
-            for(j = 0; (j < i - 1); j++) ret += char_array_3[j];
-        }
-
+        
         return ret;
     }
 }

examples/cobra_publisher/ixcrypto/IXBase64.h

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

examples/cobra_publisher/ixcrypto/IXHMac.cpp

@@ -0,0 +1,27 @@
+/*
+ *  IXHMac.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone. All rights reserved.
+ */
+#include "IXHMac.h"
+#include "IXBase64.h"
+
+#include <openssl/hmac.h>
+
+namespace ix
+{
+    std::string hmac(const std::string& data, const std::string& key)
+    {
+        constexpr size_t hashSize = 16;
+        unsigned char hash[hashSize];
+
+        HMAC(EVP_md5(),
+             key.c_str(), (int) key.size(),
+             (unsigned char *) data.c_str(), (int) data.size(),
+             (unsigned char *) hash, nullptr);
+
+        std::string hashString(reinterpret_cast<char*>(hash), hashSize);
+
+        return base64_encode(hashString, (uint32_t) hashString.size());
+    }
+}

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

@@ -7,32 +7,32 @@
 // //////////////////////////////////////////////////////////////////////
 
 /*
-The JsonCpp library's source code, including accompanying documentation,
+The JsonCpp library's source code, including accompanying documentation, 
 tests and demonstration applications, are licensed under the following
 conditions...
 
-The author (Baptiste Lepilleur) explicitly disclaims copyright in all
-jurisdictions which recognize such a disclaimer. In such jurisdictions,
+Baptiste Lepilleur and The JsonCpp Authors explicitly disclaim copyright in all 
+jurisdictions which recognize such a disclaimer. In such jurisdictions, 
 this software is released into the Public Domain.
 
 In jurisdictions which do not recognize Public Domain property (e.g. Germany as of
-2010), this software is Copyright (c) 2007-2010 by Baptiste Lepilleur, and is
-released under the terms of the MIT License (see below).
+2010), this software is Copyright (c) 2007-2010 by Baptiste Lepilleur and
+The JsonCpp Authors, and is released under the terms of the MIT License (see below).
 
-In jurisdictions which recognize Public Domain property, the user of this
-software may choose to accept it either as 1) Public Domain, 2) under the
-conditions of the MIT License (see below), or 3) under the terms of dual
+In jurisdictions which recognize Public Domain property, the user of this 
+software may choose to accept it either as 1) Public Domain, 2) under the 
+conditions of the MIT License (see below), or 3) under the terms of dual 
 Public Domain/MIT License conditions described here, as they choose.
 
 The MIT License is about as close to Public Domain as a license can get, and is
 described in clear, concise terms at:
 
    http://en.wikipedia.org/wiki/MIT_License
-
+   
 The full text of the MIT License follows:
 
 ========================================================================
-Copyright (c) 2007-2010 Baptiste Lepilleur
+Copyright (c) 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -83,13 +83,16 @@ license you like.
 // Beginning of content of file: include/json/config.h
 // //////////////////////////////////////////////////////////////////////
 
-// Copyright 2007-2010 Baptiste Lepilleur
+// Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 // Distributed under MIT license, or public domain if desired and
 // recognized in your jurisdiction.
 // See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE
 
 #ifndef JSON_CONFIG_H_INCLUDED
 #define JSON_CONFIG_H_INCLUDED
+#include <stddef.h>
+#include <string> //typedef String
+#include <stdint.h> //typedef int64_t, uint64_t
 
 /// If defined, indicates that json library is embedded in CppTL library.
 //# define JSON_IN_CPPTL 1
@@ -122,12 +125,12 @@ license you like.
 #ifdef JSON_IN_CPPTL
 #define JSON_API CPPTL_API
 #elif defined(JSON_DLL_BUILD)
-#if defined(_MSC_VER)
+#if defined(_MSC_VER) || defined(__MINGW32__)
 #define JSON_API __declspec(dllexport)
 #define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
 #endif // if defined(_MSC_VER)
 #elif defined(JSON_DLL)
-#if defined(_MSC_VER)
+#if defined(_MSC_VER) || defined(__MINGW32__)
 #define JSON_API __declspec(dllimport)
 #define JSONCPP_DISABLE_DLL_INTERFACE_WARNING
 #endif // if defined(_MSC_VER)
@@ -136,49 +139,101 @@ license you like.
 #define JSON_API
 #endif
 
-#if !defined(JSON_HAS_UNIQUE_PTR)
-#if __cplusplus >= 201103L
-#define JSON_HAS_UNIQUE_PTR (1)
-#elif _MSC_VER >= 1600
-#define JSON_HAS_UNIQUE_PTR (1)
-#else
-#define JSON_HAS_UNIQUE_PTR (0)
-#endif
-#endif
-
 // If JSON_NO_INT64 is defined, then Json only support C++ "int" type for
 // integer
 // Storages, and 64 bits integer support is disabled.
 // #define JSON_NO_INT64 1
 
-#if defined(_MSC_VER) && _MSC_VER <= 1200 // MSVC 6
-// Microsoft Visual Studio 6 only support conversion from __int64 to double
-// (no conversion from unsigned __int64).
-#define JSON_USE_INT64_DOUBLE_CONVERSION 1
-// Disable warning 4786 for VS6 caused by STL (identifier was truncated to '255'
-// characters in the debug information)
-// All projects I've ever seen with VS6 were using this globally (not bothering
-// with pragma push/pop).
-#pragma warning(disable : 4786)
-#endif // if defined(_MSC_VER)  &&  _MSC_VER < 1200 // MSVC 6
+#if defined(_MSC_VER) // MSVC
+#  if _MSC_VER <= 1200 // MSVC 6
+    // Microsoft Visual Studio 6 only support conversion from __int64 to double
+    // (no conversion from unsigned __int64).
+#    define JSON_USE_INT64_DOUBLE_CONVERSION 1
+    // Disable warning 4786 for VS6 caused by STL (identifier was truncated to '255'
+    // characters in the debug information)
+    // All projects I've ever seen with VS6 were using this globally (not bothering
+    // with pragma push/pop).
+#    pragma warning(disable : 4786)
+#  endif // MSVC 6
 
-#if defined(_MSC_VER) && _MSC_VER >= 1500 // MSVC 2008
-/// Indicates that the following function is deprecated.
-#define JSONCPP_DEPRECATED(message) __declspec(deprecated(message))
-#elif defined(__clang__) && defined(__has_feature)
-#if __has_feature(attribute_deprecated_with_message)
-#define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
+#  if _MSC_VER >= 1500 // MSVC 2008
+    /// Indicates that the following function is deprecated.
+#    define JSONCPP_DEPRECATED(message) __declspec(deprecated(message))
+#  endif
+
+#endif // defined(_MSC_VER)
+
+// In c++11 the override keyword allows you to explicity define that a function
+// is intended to override the base-class version.  This makes the code more
+// managable and fixes a set of common hard-to-find bugs.
+#if __cplusplus >= 201103L
+# define JSONCPP_OVERRIDE override
+# define JSONCPP_NOEXCEPT noexcept
+#elif defined(_MSC_VER) && _MSC_VER > 1600 && _MSC_VER < 1900
+# define JSONCPP_OVERRIDE override
+# define JSONCPP_NOEXCEPT throw()
+#elif defined(_MSC_VER) && _MSC_VER >= 1900
+# define JSONCPP_OVERRIDE override
+# define JSONCPP_NOEXCEPT noexcept
+#else
+# define JSONCPP_OVERRIDE
+# define JSONCPP_NOEXCEPT throw()
 #endif
-#elif defined(__GNUC__) &&  (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
-#define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
-#elif defined(__GNUC__) &&  (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
-#define JSONCPP_DEPRECATED(message)  __attribute__((__deprecated__))
+
+#ifndef JSON_HAS_RVALUE_REFERENCES
+
+#if defined(_MSC_VER) && _MSC_VER >= 1600 // MSVC >= 2010
+#define JSON_HAS_RVALUE_REFERENCES 1
+#endif // MSVC >= 2010
+
+#ifdef __clang__
+#if __has_feature(cxx_rvalue_references)
+#define JSON_HAS_RVALUE_REFERENCES 1
+#endif  // has_feature
+
+#elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
+#if defined(__GXX_EXPERIMENTAL_CXX0X__) || (__cplusplus >= 201103L)
+#define JSON_HAS_RVALUE_REFERENCES 1
+#endif  // GXX_EXPERIMENTAL
+
+#endif // __clang__ || __GNUC__
+
+#endif // not defined JSON_HAS_RVALUE_REFERENCES
+
+#ifndef JSON_HAS_RVALUE_REFERENCES
+#define JSON_HAS_RVALUE_REFERENCES 0
 #endif
 
+#ifdef __clang__
+#  if __has_extension(attribute_deprecated_with_message)
+#    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
+#  endif
+#elif defined __GNUC__ // not clang (gcc comes later since clang emulates gcc)
+#  if (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
+#    define JSONCPP_DEPRECATED(message)  __attribute__ ((deprecated(message)))
+#  elif (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
+#    define JSONCPP_DEPRECATED(message)  __attribute__((__deprecated__))
+#  endif  // GNUC version
+#endif // __clang__ || __GNUC__
+
 #if !defined(JSONCPP_DEPRECATED)
 #define JSONCPP_DEPRECATED(message)
 #endif // if !defined(JSONCPP_DEPRECATED)
 
+#if __GNUC__ >= 6
+#  define JSON_USE_INT64_DOUBLE_CONVERSION 1
+#endif
+
+#if !defined(JSON_IS_AMALGAMATION)
+
+# include "version.h"
+
+# if JSONCPP_USING_SECURE_MEMORY
+#  include "allocator.h" //typedef Allocator
+# endif
+
+#endif // if !defined(JSON_IS_AMALGAMATION)
+
 namespace Json {
 typedef int Int;
 typedef unsigned int UInt;
@@ -192,13 +247,26 @@ typedef unsigned int LargestUInt;
 typedef __int64 Int64;
 typedef unsigned __int64 UInt64;
 #else                 // if defined(_MSC_VER) // Other platforms, use long long
-typedef long long int Int64;
-typedef unsigned long long int UInt64;
+typedef int64_t Int64;
+typedef uint64_t UInt64;
 #endif // if defined(_MSC_VER)
 typedef Int64 LargestInt;
 typedef UInt64 LargestUInt;
 #define JSON_HAS_INT64
 #endif // if defined(JSON_NO_INT64)
+#if JSONCPP_USING_SECURE_MEMORY
+#define JSONCPP_STRING        std::basic_string<char, std::char_traits<char>, Json::SecureAllocator<char> >
+#define JSONCPP_OSTRINGSTREAM std::basic_ostringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
+#define JSONCPP_OSTREAM       std::basic_ostream<char, std::char_traits<char>>
+#define JSONCPP_ISTRINGSTREAM std::basic_istringstream<char, std::char_traits<char>, Json::SecureAllocator<char> >
+#define JSONCPP_ISTREAM       std::istream
+#else
+#define JSONCPP_STRING        std::string
+#define JSONCPP_OSTRINGSTREAM std::ostringstream
+#define JSONCPP_OSTREAM       std::ostream
+#define JSONCPP_ISTRINGSTREAM std::istringstream
+#define JSONCPP_ISTREAM       std::istream
+#endif // if JSONCPP_USING_SECURE_MEMORY
 } // end namespace Json
 
 #endif // JSON_CONFIG_H_INCLUDED
@@ -216,7 +284,7 @@ typedef UInt64 LargestUInt;
 // Beginning of content of file: include/json/forwards.h
 // //////////////////////////////////////////////////////////////////////
 
-// Copyright 2007-2010 Baptiste Lepilleur
+// Copyright 2007-2010 Baptiste Lepilleur and The JsonCpp Authors
 // Distributed under MIT license, or public domain if desired and
 // recognized in your jurisdiction.
 // See file LICENSE for detail or copy at http://jsoncpp.sourceforge.net/LICENSE

examples/cobra_publisher/package-lock.json

@@ -8,9 +8,9 @@
       "integrity": "sha512-jp/uFnooOiO+L211eZOoSyzpOITMXx1rBITauYykG3BRYPu8h0UcxsPNB04RR5vo4Tyz3+ay17tR6JVf9qzYWg=="
     },
     "ws": {
-      "version": "6.2.0",
-      "resolved": "https://registry.npmjs.org/ws/-/ws-6.2.0.tgz",
-      "integrity": "sha512-deZYUNlt2O4buFCa3t5bKLf8A7FPP/TVjwOeVNpw818Ma5nk4MLXls2eoEGS39o8119QIYxTrTDoPQ5B/gTD6w==",
+      "version": "6.1.0",
+      "resolved": "https://registry.npmjs.org/ws/-/ws-6.1.0.tgz",
+      "integrity": "sha512-H3dGVdGvW2H8bnYpIDc3u3LH8Wue3Qh+Zto6aXXFzvESkTVT6rAfKR6tR/+coaUvxs8yHtmNV0uioBF62ZGSTg==",
       "requires": {
         "async-limiter": "1.0.0"
       }

examples/echo_server/CMakeLists.txt

@@ -0,0 +1,30 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+#
+
+cmake_minimum_required (VERSION 3.4.1)
+project (echo_server)
+
+# There's -Weverything too for clang
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic -Wshorten-64-to-32")
+
+set (OPENSSL_PREFIX /usr/local/opt/openssl) # Homebrew openssl
+
+set (CMAKE_CXX_STANDARD 14)
+
+option(USE_TLS "Add TLS support" ON)
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
+
+include_directories(echo_server .)
+
+add_executable(echo_server 
+  echo_server.cpp)
+
+if (APPLE AND USE_TLS)
+    target_link_libraries(echo_server "-framework foundation" "-framework security")
+endif()
+
+target_link_libraries(echo_server ixwebsocket)
+install(TARGETS echo_server DESTINATION bin)

examples/echo_server/echo_server.cpp

@@ -0,0 +1,68 @@
+/*
+ *  echo_server.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#include <iostream>
+#include <sstream>
+#include <ixwebsocket/IXWebSocketServer.h>
+
+int main(int argc, char** argv)
+{
+    int port = 8080;
+    if (argc == 2)
+    {
+        std::stringstream ss;
+        ss << argv[1];
+        ss >> port;
+    }
+
+    ix::WebSocketServer server(port);
+
+    server.setOnConnectionCallback(
+        [&server](std::shared_ptr<ix::WebSocket> webSocket)
+        {
+            webSocket->setOnMessageCallback(
+                [webSocket, &server](ix::WebSocketMessageType messageType,
+                   const std::string& str,
+                   size_t wireSize,
+                   const ix::WebSocketErrorInfo& error,
+                   const ix::WebSocketOpenInfo& openInfo,
+                   const ix::WebSocketCloseInfo& closeInfo)
+                {
+                    if (messageType == ix::WebSocket_MessageType_Open)
+                    {
+                        std::cerr << "New connection" << std::endl;
+                        std::cerr << "Uri: " << openInfo.uri << std::endl;
+                        std::cerr << "Headers:" << std::endl;
+                        for (auto it : openInfo.headers)
+                        {
+                            std::cerr << it.first << ": " << it.second << std::endl;
+                        }
+                    }
+                    else if (messageType == ix::WebSocket_MessageType_Close)
+                    {
+                        std::cerr << "Closed connection" << std::endl;
+                    }
+                    else if (messageType == ix::WebSocket_MessageType_Message)
+                    {
+                        webSocket->send(str);
+                    }
+                }
+            );
+        }
+    );
+
+    auto res = server.listen();
+    if (!res.first)
+    {
+        std::cerr << res.second << std::endl;
+        return 1;
+    }
+
+    server.start();
+    server.wait();
+
+    return 0;
+}

examples/ping_pong/.gitignore

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

examples/ping_pong/CMakeLists.txt

@@ -0,0 +1,27 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+#
+
+cmake_minimum_required (VERSION 3.4.1)
+project (ping_pong)
+
+set (CMAKE_CXX_STANDARD 14)
+
+option(USE_TLS "Add TLS support" ON)
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
+
+add_executable(ping_pong ping_pong.cpp)
+
+if (APPLE AND USE_TLS)
+    target_link_libraries(ping_pong "-framework foundation" "-framework security")
+endif()
+
+if (WIN32)
+    target_link_libraries(ping_pong wsock32 ws2_32)
+    add_definitions(-D_CRT_SECURE_NO_WARNINGS)
+endif()
+
+target_link_libraries(ping_pong ixwebsocket)
+install(TARGETS ping_pong DESTINATION bin)

examples/ping_pong/build_linux.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+#
+
+# 'manual' way of building. You can also use cmake.
+
+g++ --std=c++11 \
+    ../../ixwebsocket/IXSocket.cpp	\
+    ../../ixwebsocket/IXWebSocketTransport.cpp \
+    ../../ixwebsocket/IXWebSocket.cpp \
+    -I ../.. \
+    cmd_websocket_chat.cpp \
+    -o cmd_websocket_chat

examples/ping_pong/client.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+
+import asyncio
+import websockets
+
+async def hello(uri):
+    async with websockets.connect(uri) as websocket:
+        await websocket.send("Hello world!")
+        response = await websocket.recv()
+        print(response)
+
+        pong_waiter = await websocket.ping('coucou')
+        ret = await pong_waiter   # only if you want to wait for the pong
+        print(ret)
+
+asyncio.get_event_loop().run_until_complete(
+    hello('ws://localhost:5678'))

examples/ping_pong/ping_pong.cpp

@@ -1,7 +1,7 @@
 /*
- *  ws_ping_pong.cpp
+ *  ping_pong.cpp
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
  */
 
 #include <iostream>
@@ -9,8 +9,15 @@
 #include <ixwebsocket/IXWebSocket.h>
 #include <ixwebsocket/IXSocket.h>
 
-namespace ix
+using namespace ix;
+
+namespace
 {
+    void log(const std::string& msg)
+    {
+        std::cout << msg << std::endl;
+    }
+
     class WebSocketPingPong
     {
         public:
@@ -26,8 +33,6 @@ namespace ix
         private:
             std::string _url;
             ix::WebSocket _webSocket;
-
-            void log(const std::string& msg);
     };
 
     WebSocketPingPong::WebSocketPingPong(const std::string& url) :
@@ -36,11 +41,6 @@ namespace ix
         ;
     }
 
-    void WebSocketPingPong::log(const std::string& msg)
-    {
-        std::cout << msg << std::endl;
-    }
-
     void WebSocketPingPong::stop()
     {
         _webSocket.stop();
@@ -54,54 +54,50 @@ namespace ix
         log(std::string("Connecting to url: ") + _url);
 
         _webSocket.setOnMessageCallback(
-            [this](const ix::WebSocketMessagePtr& msg)
+            [this](ix::WebSocketMessageType messageType,
+               const std::string& str,
+               size_t wireSize,
+               const ix::WebSocketErrorInfo& error,
+               const ix::WebSocketOpenInfo& openInfo,
+               const ix::WebSocketCloseInfo& closeInfo)
             {
-                std::cerr << "Received " << msg->wireSize << " bytes" << std::endl;
-
                 std::stringstream ss;
-                if (msg->type == ix::WebSocketMessageType::Open)
+                if (messageType == ix::WebSocket_MessageType_Open)
                 {
                     log("ping_pong: connected");
-
-                    std::cout << "Uri: " << msg->openInfo.uri << std::endl;
-                    std::cout << "Handshake Headers:" << std::endl;
-                    for (auto it : msg->openInfo.headers)
-                    {
-                        std::cout << it.first << ": " << it.second << std::endl;
-                    }
                 }
-                else if (msg->type == ix::WebSocketMessageType::Close)
+                else if (messageType == ix::WebSocket_MessageType_Close)
                 {
                     ss << "ping_pong: disconnected:"
-                       << " code " << msg->closeInfo.code
-                       << " reason " << msg->closeInfo.reason
-                       << msg->str;
+                       << " code " << closeInfo.code
+                       << " reason " << closeInfo.reason
+                       << str;
                     log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Message)
+                else if (messageType == ix::WebSocket_MessageType_Message)
                 {
                     ss << "ping_pong: received message: "
-                       << msg->str;
+                       << str;
                     log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Ping)
+                else if (messageType == ix::WebSocket_MessageType_Ping)
                 {
                     ss << "ping_pong: received ping message: "
-                       << msg->str;
+                       << str;
                     log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Pong)
+                else if (messageType == ix::WebSocket_MessageType_Pong)
                 {
                     ss << "ping_pong: received pong message: "
-                       << msg->str;
+                       << str;
                     log(ss.str());
                 }
-                else if (msg->type == ix::WebSocketMessageType::Error)
+                else if (messageType == ix::WebSocket_MessageType_Error)
                 {
-                    ss << "Connection error: " << msg->errorInfo.reason      << std::endl;
-                    ss << "#retries: "         << msg->errorInfo.retries     << std::endl;
-                    ss << "Wait time(ms): "    << msg->errorInfo.wait_time   << std::endl;
-                    ss << "HTTP Status: "      << msg->errorInfo.http_status << std::endl;
+                    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
@@ -128,7 +124,7 @@ namespace ix
         _webSocket.send(text);
     }
 
-    int ws_ping_pong_main(const std::string& url)
+    void interactiveMain(const std::string& url)
     {
         std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
         WebSocketPingPong webSocketPingPong(url);
@@ -157,7 +153,19 @@ namespace ix
 
         std::cout << std::endl;
         webSocketPingPong.stop();
-
-        return 0;
     }
 }
+
+int main(int argc, char** argv)
+{
+    if (argc != 2)
+    {
+        std::cerr << "Usage: ping_pong <url>" << std::endl;
+        return 1;
+    }
+    std::string url = argv[1];
+
+    Socket::init();
+    interactiveMain(url);
+    return 0;
+}

examples/ping_pong/server.py

@@ -0,0 +1,21 @@
+#!/usr/bin/env python
+
+import os
+import asyncio
+import websockets
+
+async def echo(websocket, path):
+    async for message in websocket:
+        print(message)
+        await websocket.send(message)
+
+        if os.getenv('TEST_CLOSE'):
+            print('Closing')
+            # breakpoint()
+            await websocket.close(1001, 'close message')
+            # await websocket.close()
+            break
+
+asyncio.get_event_loop().run_until_complete(
+    websockets.serve(echo, 'localhost', 5678))
+asyncio.get_event_loop().run_forever()

examples/ping_pong/test.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+test -d build || {
+    mkdir -p build
+    cd build
+    cmake ..
+}
+(cd build ; make)
+./build/ping_pong ws://localhost:5678

examples/ws_connect/.gitignore

@@ -0,0 +1,3 @@
+build
+venv
+node_modules

examples/ws_connect/CMakeLists.txt

@@ -0,0 +1,22 @@
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+#
+
+cmake_minimum_required (VERSION 3.4.1)
+project (ws_connect)
+
+set (CMAKE_CXX_STANDARD 14)
+
+option(USE_TLS "Add TLS support" ON)
+
+add_subdirectory(${PROJECT_SOURCE_DIR}/../.. ixwebsocket)
+
+add_executable(ws_connect ws_connect.cpp)
+
+if (APPLE AND USE_TLS)
+    target_link_libraries(ws_connect "-framework foundation" "-framework security")
+endif()
+
+target_link_libraries(ws_connect ixwebsocket)
+install(TARGETS ws_connect DESTINATION bin)

examples/ws_connect/README.md

@@ -0,0 +1,11 @@
+# Building
+
+1. mkdir build
+2. cd build
+3. cmake ..
+4. make
+
+## Disable TLS
+
+* Enable: `cmake -DUSE_TLS=OFF ..`
+* Disable: `cmake -DUSE_TLS=ON ..`

examples/ws_connect/build_linux.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+#
+# Author: Benjamin Sergeant
+# Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+#
+
+# 'manual' way of building. You can also use cmake.
+
+g++ --std=c++11 \
+    -DIXWEBSOCKET_USE_TLS \
+    -g \
+    ../../ixwebsocket/IXEventFd.cpp	\
+    ../../ixwebsocket/IXSocket.cpp	\
+    ../../ixwebsocket/IXSetThreadName.cpp	\
+    ../../ixwebsocket/IXWebSocketTransport.cpp \
+    ../../ixwebsocket/IXWebSocket.cpp \
+    ../../ixwebsocket/IXDNSLookup.cpp \
+    ../../ixwebsocket/IXSocketConnect.cpp \
+    ../../ixwebsocket/IXSocketOpenSSL.cpp \
+    ../../ixwebsocket/IXWebSocketPerMessageDeflate.cpp \
+    ../../ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp \
+    -I ../.. \
+    ws_connect.cpp \
+    -o ws_connect \
+    -lcrypto -lssl -lz -lpthread

examples/ws_connect/ws_connect.cpp

@@ -0,0 +1,165 @@
+/*
+ *  ws_connect.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#include <iostream>
+#include <sstream>
+#include <ixwebsocket/IXWebSocket.h>
+#include <ixwebsocket/IXSocket.h>
+
+using namespace ix;
+
+namespace
+{
+    void log(const std::string& msg)
+    {
+        std::cout << msg << std::endl;
+    }
+
+    class WebSocketConnect
+    {
+        public:
+            WebSocketConnect(const std::string& _url);
+
+            void subscribe(const std::string& channel);
+            void start();
+            void stop();
+
+            void sendMessage(const std::string& text);
+
+        private:
+            std::string _url;
+            ix::WebSocket _webSocket;
+    };
+
+    WebSocketConnect::WebSocketConnect(const std::string& url) :
+        _url(url)
+    {
+        ;
+    }
+
+    void WebSocketConnect::stop()
+    {
+        _webSocket.stop();
+    }
+
+    void WebSocketConnect::start()
+    {
+        _webSocket.setUrl(_url);
+
+        ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(
+            true, false, false, 15, 15);
+        _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
+
+        std::stringstream ss;
+        log(std::string("Connecting to url: ") + _url);
+
+        _webSocket.setOnMessageCallback(
+            [this](ix::WebSocketMessageType messageType,
+               const std::string& str,
+               size_t wireSize,
+               const ix::WebSocketErrorInfo& error,
+               const ix::WebSocketOpenInfo& openInfo,
+               const ix::WebSocketCloseInfo& closeInfo)
+            {
+                std::stringstream ss;
+                if (messageType == ix::WebSocket_MessageType_Open)
+                {
+                    log("ws_connect: connected");
+                    std::cout << "Uri: " << openInfo.uri << std::endl;
+                    std::cout << "Handshake Headers:" << std::endl;
+                    for (auto it : openInfo.headers)
+                    {
+                        std::cout << it.first << ": " << it.second << std::endl;
+                    }
+                }
+                else if (messageType == ix::WebSocket_MessageType_Close)
+                {
+                    ss << "ws_connect: connection closed:";
+                    ss << " code " << closeInfo.code;
+                    ss << " reason " << closeInfo.reason << std::endl;
+                    log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Message)
+                {
+                    ss << "ws_connect: received message: "
+                       << str;
+                    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();
+    }
+
+    void WebSocketConnect::sendMessage(const std::string& text)
+    {
+        _webSocket.send(text);
+    }
+
+    void interactiveMain(const std::string& url)
+    {
+        std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
+        WebSocketConnect webSocketChat(url);
+        webSocketChat.start();
+
+        while (true)
+        {
+            std::string text;
+            std::cout << "> " << std::flush;
+            std::getline(std::cin, text);
+
+            if (text == "/stop")
+            {
+                std::cout << "Stopping connection..." << std::endl;
+                webSocketChat.stop();
+                continue;
+            }
+
+            if (text == "/start")
+            {
+                std::cout << "Starting connection..." << std::endl;
+                webSocketChat.start();
+                continue;
+            }
+
+            if (!std::cin)
+            {
+                break;
+            }
+
+            webSocketChat.sendMessage(text);
+        }
+
+        std::cout << std::endl;
+        webSocketChat.stop();
+    }
+}
+
+int main(int argc, char** argv)
+{
+    if (argc != 2)
+    {
+        std::cerr << "Usage: ws_connect <url>" << std::endl;
+        return 1;
+    }
+    std::string url = argv[1];
+
+    Socket::init();
+    interactiveMain(url);
+    return 0;
+}

ixcobra/CMakeLists.txt

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

ixcobra/ixcobra/IXCobraMetricsPublisher.cpp

@@ -1,241 +0,0 @@
-/*
- *  IXCobraMetricsPublisher.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraMetricsPublisher.h"
-
-#include <algorithm>
-#include <stdexcept>
-
-
-namespace ix
-{
-    const int CobraMetricsPublisher::kVersion = 1;
-    const std::string CobraMetricsPublisher::kSetRateControlId = "sms_set_rate_control_id";
-    const std::string CobraMetricsPublisher::kSetBlacklistId = "sms_set_blacklist_id";
-
-    CobraMetricsPublisher::CobraMetricsPublisher() :
-        _enabled(true)
-    {
-    }
-
-    CobraMetricsPublisher::~CobraMetricsPublisher()
-    {
-        ;
-    }
-
-    void CobraMetricsPublisher::configure(const std::string& appkey,
-                                          const std::string& endpoint,
-                                          const std::string& channel,
-                                          const std::string& rolename,
-                                          const std::string& rolesecret,
-                                          bool enablePerMessageDeflate)
-    {
-        // Configure the satori connection and start its publish background thread
-        _cobra_metrics_theaded_publisher.start();
-
-        _cobra_metrics_theaded_publisher.configure(appkey, endpoint, channel,
-                                                   rolename, rolesecret,
-                                                   enablePerMessageDeflate);
-    }
-
-    Json::Value& CobraMetricsPublisher::getGenericAttributes()
-    {
-        std::lock_guard<std::mutex> lock(_device_mutex);
-        return _device;
-    }
-
-    void CobraMetricsPublisher::setGenericAttributes(const std::string& attrName,
-                                                      const Json::Value& value)
-    {
-        std::lock_guard<std::mutex> lock(_device_mutex);
-        _device[attrName] = value;
-    }
-
-    void CobraMetricsPublisher::enable(bool enabled)
-    {
-        _enabled = enabled;
-    }
-
-    void CobraMetricsPublisher::setBlacklist(const std::vector<std::string>& blacklist)
-    {
-        _blacklist = blacklist;
-        std::sort(_blacklist.begin(), _blacklist.end());
-
-        // publish our blacklist
-        Json::Value data;
-        Json::Value metrics;
-        for (auto&& metric : blacklist)
-        {
-            metrics.append(metric);
-        }
-        data["blacklist"] = metrics;
-        push(kSetBlacklistId, data);
-    }
-
-    bool CobraMetricsPublisher::isMetricBlacklisted(const std::string& id) const
-    {
-        return std::binary_search(_blacklist.begin(), _blacklist.end(), id);
-    }
-
-    void CobraMetricsPublisher::setRateControl(
-        const std::unordered_map<std::string, int>& rate_control)
-    {
-        for (auto&& it : rate_control)
-        {
-            if (it.second >= 0)
-            {
-                _rate_control[it.first] = it.second;
-            }
-        }
-
-        // publish our rate_control
-        Json::Value data;
-        Json::Value metrics;
-        for (auto&& it : _rate_control)
-        {
-            metrics[it.first] = it.second;
-        }
-        data["rate_control"] = metrics;
-        push(kSetRateControlId, data);
-    }
-
-    bool CobraMetricsPublisher::isAboveMaxUpdateRate(const std::string& id) const
-    {
-        // Is this metrics rate controlled ?
-        auto rate_control_it = _rate_control.find(id);
-        if (rate_control_it == _rate_control.end()) return false;
-
-        // Was this metrics already sent ?
-        std::lock_guard<std::mutex> lock(_last_update_mutex);
-        auto last_update = _last_update.find(id);
-        if (last_update == _last_update.end()) return false;
-
-        auto timeDeltaFromLastSend =
-            std::chrono::steady_clock::now() - last_update->second;
-
-        return timeDeltaFromLastSend < std::chrono::seconds(rate_control_it->second);
-    }
-
-    void CobraMetricsPublisher::setLastUpdate(const std::string& id)
-    {
-        std::lock_guard<std::mutex> lock(_last_update_mutex);
-        _last_update[id] = std::chrono::steady_clock::now();
-    }
-
-    uint64_t CobraMetricsPublisher::getMillisecondsSinceEpoch() const
-    {
-        auto now = std::chrono::system_clock::now();
-        auto ms =
-            std::chrono::duration_cast<std::chrono::milliseconds>(
-                now.time_since_epoch()).count();
-
-        return ms;
-    }
-
-    void CobraMetricsPublisher::push(const std::string& id,
-                                     const std::string& data,
-                                     bool shouldPushTest)
-    {
-        if (!_enabled) return;
-
-        Json::Value root;
-        Json::Reader reader;
-        if (!reader.parse(data, root)) return;
-
-        push(id, root, shouldPushTest);
-    }
-
-    void CobraMetricsPublisher::push(const std::string& id,
-                                     const CobraMetricsPublisher::Message& data)
-    {
-        if (!_enabled) return;
-
-        Json::Value root;
-        for (auto it : data)
-        {
-            root[it.first] = it.second;
-        }
-
-        push(id, root);
-    }
-
-    bool CobraMetricsPublisher::shouldPush(const std::string& id) const
-    {
-        if (!_enabled) return false;
-        if (isMetricBlacklisted(id)) return false;
-        if (isAboveMaxUpdateRate(id)) return false;
-
-        return true;
-    }
-
-    void CobraMetricsPublisher::push(const std::string& id,
-                                     const Json::Value& data,
-                                     bool shouldPushTest)
-    {
-        if (shouldPushTest && !shouldPush(id)) return;
-
-        setLastUpdate(id);
-
-        Json::Value msg;
-        msg["id"] = id;
-        msg["data"] = data;
-        msg["session"] = _session;
-        msg["version"] = kVersion;
-        msg["timestamp"] = Json::UInt64(getMillisecondsSinceEpoch());
-
-        {
-            std::lock_guard<std::mutex> lock(_device_mutex);
-            msg["device"] = _device;
-        }
-
-        {
-            //
-            // Bump a counter for each id
-            // This is used to make sure that we are not
-            // dropping messages, by checking that all the ids is the list of
-            // all natural numbers until the last value sent (0, 1, 2, ..., N)
-            //
-            std::lock_guard<std::mutex> lock(_device_mutex);
-            auto it = _counters.emplace(id, 0);
-            msg["per_id_counter"] = it.first->second;
-            it.first->second += 1;
-        }
-
-        // Now actually enqueue the task
-        _cobra_metrics_theaded_publisher.push(msg);
-    }
-
-    void CobraMetricsPublisher::setPublishMode(CobraConnectionPublishMode publishMode)
-    {
-        _cobra_metrics_theaded_publisher.setPublishMode(publishMode);
-    }
-
-    bool CobraMetricsPublisher::flushQueue()
-    {
-        return _cobra_metrics_theaded_publisher.flushQueue();
-    }
-
-    void CobraMetricsPublisher::suspend()
-    {
-        _cobra_metrics_theaded_publisher.suspend();
-    }
-
-    void CobraMetricsPublisher::resume()
-    {
-        _cobra_metrics_theaded_publisher.resume();
-    }
-
-    bool CobraMetricsPublisher::isConnected() const
-    {
-        return _cobra_metrics_theaded_publisher.isConnected();
-    }
-
-    bool CobraMetricsPublisher::isAuthenticated() const
-    {
-        return _cobra_metrics_theaded_publisher.isAuthenticated();
-    }
-
-} // namespace ix

ixcobra/ixcobra/IXCobraMetricsPublisher.h

@@ -1,167 +0,0 @@
-/*
- *  IXCobraMetricsPublisher.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-#include "IXCobraMetricsThreadedPublisher.h"
-#include <atomic>
-#include <chrono>
-#include <jsoncpp/json/json.h>
-#include <string>
-#include <unordered_map>
-
-namespace ix
-{
-    class CobraMetricsPublisher
-    {
-    public:
-        CobraMetricsPublisher();
-        ~CobraMetricsPublisher();
-
-        /// Thread safety notes:
-        ///
-        /// 1. _enabled, _blacklist and _rate_control read/writes are not protected by a mutex
-        /// to make shouldPush as fast as possible. _enabled default to false.
-        ///
-        /// The code that set those is ran only once at init, and
-        /// the last value to be set is _enabled, which is also the first value checked in
-        /// shouldPush, so there shouldn't be any race condition.
-        ///
-        /// 2. The queue of messages is thread safe, so multiple metrics can be safely pushed on
-        /// multiple threads
-        ///
-        /// 3. Access to _last_update is protected as it needs to be read/write.
-        ///
-
-        /// Configuration / set keys, etc...
-        /// All input data but the channel name is encrypted with rc4
-        void configure(const std::string& appkey,
-                       const std::string& endpoint,
-                       const std::string& channel,
-                       const std::string& rolename,
-                       const std::string& rolesecret,
-                       bool enablePerMessageDeflate);
-
-        /// Setter for the list of blacklisted metrics ids.
-        /// That list is sorted internally for fast lookups
-        void setBlacklist(const std::vector<std::string>& blacklist);
-
-        /// Set the maximum rate at which a metrics can be sent. Unit is seconds
-        /// if rate_control = { 'foo_id': 60 },
-        /// the foo_id metric cannot be pushed more than once every 60 seconds
-        void setRateControl(const std::unordered_map<std::string, int>& rate_control);
-
-        /// Configuration / enable/disable
-        void enable(bool enabled);
-
-        /// Simple interface, list of key value pairs where typeof(key) == typeof(value) == string
-        typedef std::unordered_map<std::string, std::string> Message;
-        void push(const std::string& id,
-                  const CobraMetricsPublisher::Message& data = CobraMetricsPublisher::Message());
-
-        /// Richer interface using json, which supports types (bool, int, float) and hierarchies of
-        /// elements
-        ///
-        /// The shouldPushTest argument should be set to false, and used in combination with the
-        /// shouldPush method for places where we want to be as lightweight as possible when
-        /// collecting metrics. When set to false, it is used so that we don't do double work when
-        /// computing whether a metrics should be sent or not.
-        void push(const std::string& id, const Json::Value& data, bool shouldPushTest = true);
-
-        /// Interface used by lua. msg is a json encoded string.
-        void push(const std::string& id, const std::string& data, bool shouldPushTest = true);
-
-        /// Tells whether a metric can be pushed.
-        /// A metric can be pushed if it satisfies those conditions:
-        ///
-        /// 1. the metrics system should be enabled
-        /// 2. the metrics shouldn't be black-listed
-        /// 3. the metrics shouldn't have reached its rate control limit at this
-        /// "sampling"/"calling" time
-        bool shouldPush(const std::string& id) const;
-
-        /// Get generic information json object
-        Json::Value& getGenericAttributes();
-
-        /// Set generic information values
-        void setGenericAttributes(const std::string& attrName, const Json::Value& value);
-
-        /// Set a unique id for the session. A uuid can be used.
-        void setSession(const std::string& session) { _session = session; }
-
-        /// Get the unique id used to identify the current session
-        const std::string& getSession() const { return _session; }
-
-        /// Return the number of milliseconds since the epoch (~1970)
-        uint64_t getMillisecondsSinceEpoch() const;
-
-        /// Set satori connection publish mode
-        void setPublishMode(CobraConnectionPublishMode publishMode);
-
-        /// Flush the publish queue
-        bool flushQueue();
-
-        /// Lifecycle management. Free resources when backgrounding
-        void suspend();
-        void resume();
-
-        /// Tells whether the socket connection is opened
-        bool isConnected() const;
-
-        /// Returns true only if we're authenticated
-        bool isAuthenticated() const;
-
-    private:
-        /// Lookup an id in our metrics to see whether it is blacklisted
-        /// Complexity is logarithmic
-        bool isMetricBlacklisted(const std::string& id) const;
-
-        /// Tells whether we should drop a metrics or not as part of an enqueuing
-        /// because it exceed the max update rate (it is sent too often)
-        bool isAboveMaxUpdateRate(const std::string& id) const;
-
-        /// Record when a metric was last sent. Used for rate control
-        void setLastUpdate(const std::string& id);
-
-        ///
-        /// Member variables
-        ///
-
-        CobraMetricsThreadedPublisher _cobra_metrics_theaded_publisher;
-
-        /// A boolean to enable or disable this system
-        /// push becomes a no-op when _enabled is false
-        std::atomic<bool> _enabled;
-
-        /// A uuid used to uniquely identify a session
-        std::string _session;
-
-        /// The _device json blob is populated once when configuring this system
-        /// It record generic metadata about the client, run (version, device model, etc...)
-        Json::Value _device;
-        mutable std::mutex _device_mutex; // protect access to _device
-
-        /// Metrics control (black list + rate control)
-        std::vector<std::string> _blacklist;
-        std::unordered_map<std::string, int> _rate_control;
-        std::unordered_map<std::string, std::chrono::time_point<std::chrono::steady_clock>>
-            _last_update;
-        mutable std::mutex _last_update_mutex; // protect access to _last_update
-
-        /// Bump a counter for each metric type
-        std::unordered_map<std::string, int> _counters;
-        mutable std::mutex _counters_mutex; // protect access to _counters
-
-        // const strings for internal ids
-        static const std::string kSetRateControlId;
-        static const std::string kSetBlacklistId;
-
-        /// Our protocol version. Can be used by subscribers who would want to be backward
-        /// compatible if we change the way we arrange data
-        static const int kVersion;
-    };
-
-} // namespace ix

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.cpp

@@ -1,225 +0,0 @@
-/*
- *  IXCobraMetricsThreadedPublisher.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraMetricsThreadedPublisher.h"
-#include <ixwebsocket/IXSetThreadName.h>
-#include <ixcore/utils/IXCoreLogger.h>
-
-#include <algorithm>
-#include <stdexcept>
-#include <cmath>
-#include <cassert>
-#include <iostream>
-
-
-namespace ix
-{
-    CobraMetricsThreadedPublisher::CobraMetricsThreadedPublisher() :
-        _stop(false)
-    {
-        _cobra_connection.setEventCallback(
-            []
-            (ix::CobraConnectionEventType eventType,
-             const std::string& errMsg,
-             const ix::WebSocketHttpHeaders& headers,
-             const std::string& subscriptionId,
-             CobraConnection::MsgId msgId)
-            {
-                std::stringstream ss;
-
-                if (eventType == ix::CobraConnection_EventType_Open)
-                {
-                    ss << "Handshake headers" << std::endl;
-
-                    for (auto it : headers)
-                    {
-                        ss << it.first << ": " << it.second << std::endl;
-                    }
-                }
-                else if (eventType == ix::CobraConnection_EventType_Authenticated)
-                {
-                    ss << "Authenticated";
-                }
-                else if (eventType == ix::CobraConnection_EventType_Error)
-                {
-                    ss << "Error: " << errMsg;
-                }
-                else if (eventType == ix::CobraConnection_EventType_Closed)
-                {
-                    ss << "Connection closed: " << errMsg;
-                }
-                else if (eventType == ix::CobraConnection_EventType_Subscribed)
-                {
-                    ss << "Subscribed through subscription id: " << subscriptionId;
-                }
-                else if (eventType == ix::CobraConnection_EventType_UnSubscribed)
-                {
-                    ss << "Unsubscribed through subscription id: " << subscriptionId;
-                }
-                else if (eventType == ix::CobraConnection_EventType_Published)
-                {
-                    ss << "Published message " << msgId << " acked";
-                }
-
-                ix::IXCoreLogger::Log(ss.str().c_str());
-        });
-    }
-
-    CobraMetricsThreadedPublisher::~CobraMetricsThreadedPublisher()
-    {
-        // The background thread won't be joinable if it was never
-        // started by calling CobraMetricsThreadedPublisher::start
-        if (!_thread.joinable()) return;
-
-        _stop = true;
-        _condition.notify_one();
-        _thread.join();
-    }
-
-    void CobraMetricsThreadedPublisher::start()
-    {
-        if (_thread.joinable()) return; // we've already been started
-
-        _thread = std::thread(&CobraMetricsThreadedPublisher::run, this);
-    }
-
-    void CobraMetricsThreadedPublisher::configure(const std::string& appkey,
-                                                  const std::string& endpoint,
-                                                  const std::string& channel,
-                                                  const std::string& rolename,
-                                                  const std::string& rolesecret,
-                                                  bool enablePerMessageDeflate)
-    {
-        _channel = channel;
-
-        ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(enablePerMessageDeflate);
-        _cobra_connection.configure(appkey, endpoint,
-                                    rolename, rolesecret,
-                                    webSocketPerMessageDeflateOptions);
-    }
-
-    void CobraMetricsThreadedPublisher::pushMessage(MessageKind messageKind,
-                                                    const Json::Value& msg)
-    {
-        // Enqueue the task
-        {
-            // acquire lock
-            std::unique_lock<std::mutex> lock(_queue_mutex);
-
-            // add the task
-            _queue.push(std::make_pair(messageKind, msg));
-        } // release lock
-
-        // wake up one thread
-        _condition.notify_one();
-    }
-
-    void CobraMetricsThreadedPublisher::setPublishMode(CobraConnectionPublishMode publishMode)
-    {
-        _cobra_connection.setPublishMode(publishMode);
-    }
-
-    bool CobraMetricsThreadedPublisher::flushQueue()
-    {
-        return _cobra_connection.flushQueue();
-    }
-
-    void CobraMetricsThreadedPublisher::run()
-    {
-        setThreadName("CobraMetricsPublisher");
-
-        Json::Value channels;
-        channels.append(std::string());
-        channels.append(std::string());
-        const std::string messageIdKey("id");
-
-        _cobra_connection.connect();
-
-        while (true)
-        {
-            Json::Value msg;
-            MessageKind messageKind;
-
-            {
-                std::unique_lock<std::mutex> lock(_queue_mutex);
-
-                while (!_stop && _queue.empty())
-                {
-                    _condition.wait(lock);
-                }
-                if (_stop)
-                {
-                    _cobra_connection.disconnect();
-                    return;
-                }
-
-                auto item = _queue.front();
-                _queue.pop();
-
-                messageKind = item.first;
-                msg = item.second;
-            }
-
-            switch (messageKind)
-            {
-                case MessageKind::Suspend:
-                {
-                    _cobra_connection.suspend();
-                    continue;
-                }; break;
-
-                case MessageKind::Resume:
-                {
-                    _cobra_connection.resume();
-                    continue;
-                }; break;
-
-                case MessageKind::Message:
-                {
-                    ;
-                }; break;
-            }
-
-            //
-            // Publish to multiple channels. This let the consumer side
-            // easily subscribe to all message of a certain type, without having
-            // to do manipulations on the messages on the server side.
-            //
-            channels[0] = _channel;
-            if (msg.isMember(messageIdKey))
-            {
-                channels[1] = msg[messageIdKey];
-            }
-            _cobra_connection.publish(channels, msg);
-        }
-    }
-
-    void CobraMetricsThreadedPublisher::push(const Json::Value& msg)
-    {
-        pushMessage(MessageKind::Message, msg);
-    }
-
-    void CobraMetricsThreadedPublisher::suspend()
-    {
-        pushMessage(MessageKind::Suspend, Json::Value());
-    }
-
-    void CobraMetricsThreadedPublisher::resume()
-    {
-        pushMessage(MessageKind::Resume, Json::Value());
-    }
-
-    bool CobraMetricsThreadedPublisher::isConnected() const
-    {
-        return _cobra_connection.isConnected();
-    }
-
-    bool CobraMetricsThreadedPublisher::isAuthenticated() const
-    {
-        return _cobra_connection.isAuthenticated();
-    }
-
-} // namespace ix

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.h

@@ -1,104 +0,0 @@
-/*
- *  IXCobraMetricsThreadedPublisher.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-#include "IXCobraConnection.h"
-#include <atomic>
-#include <condition_variable>
-#include <jsoncpp/json/json.h>
-#include <map>
-#include <mutex>
-#include <queue>
-#include <string>
-#include <thread>
-
-namespace ix
-{
-    class CobraMetricsThreadedPublisher
-    {
-    public:
-        CobraMetricsThreadedPublisher();
-        ~CobraMetricsThreadedPublisher();
-
-        /// Configuration / set keys, etc...
-        void configure(const std::string& appkey,
-                       const std::string& endpoint,
-                       const std::string& channel,
-                       const std::string& rolename,
-                       const std::string& rolesecret,
-                       bool enablePerMessageDeflate);
-
-        /// Start the worker thread, used for background publishing
-        void start();
-
-        /// Push a msg to our queue of messages to be published to cobra on the background
-        //  thread. Main user right now is the Cobra Metrics System
-        void push(const Json::Value& msg);
-
-        /// Set cobra connection publish mode
-        void setPublishMode(CobraConnectionPublishMode publishMode);
-
-        /// Flush the publish queue
-        bool flushQueue();
-
-        /// Lifecycle management. Free resources when backgrounding
-        void suspend();
-        void resume();
-
-        /// Tells whether the socket connection is opened
-        bool isConnected() const;
-
-        /// Returns true only if we're authenticated
-        bool isAuthenticated() const;
-
-    private:
-        enum class MessageKind
-        {
-            Message = 0,
-            Suspend = 1,
-            Resume = 2
-        };
-
-        /// Push a message to be processed by the background thread
-        void pushMessage(MessageKind messageKind, const Json::Value& msg);
-
-        /// Get a wait time which is increasing exponentially based on the number of retries
-        uint64_t getWaitTimeExp(int retry_count);
-
-        /// Debugging routine to print the connection parameters to the console
-        void printInfo();
-
-        /// Publish a message to satory
-        /// Will retry multiple times (3) if a problem occurs.
-        ///
-        /// Right now, only called on the publish worker thread.
-        void safePublish(const Json::Value& msg);
-
-        /// The worker thread "daemon" method. That method never returns unless _stop is set to true
-        void run();
-
-        /// Our connection to cobra.
-        CobraConnection _cobra_connection;
-
-        /// The channel we are publishing to
-        std::string _channel;
-
-        /// Internal data structures used to publish to cobra
-        /// Pending messages are stored into a queue, which is protected by a mutex
-        /// We used a condition variable to prevent the worker thread from busy polling
-        /// So we notify the condition variable when an incoming message arrives to signal
-        /// that it should wake up and take care of publishing it to cobra
-        /// To shutdown the worker thread one has to set the _stop boolean to true.
-        /// This is done in the destructor
-        std::queue<std::pair<MessageKind, Json::Value>> _queue;
-        mutable std::mutex _queue_mutex;
-        std::condition_variable _condition;
-        std::atomic<bool> _stop;
-        std::thread _thread;
-    };
-
-} // namespace ix

ixcobra/ixcobra/README.md

@@ -1 +0,0 @@
-Client code to publish to a real time analytic system, described in [https://bsergean.github.io/redis_conf_2019/slides.html#1](link).

ixcore/CMakeLists.txt

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

ixcore/ixcore/utils/IXCoreLogger.cpp

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

ixcore/ixcore/utils/IXCoreLogger.h

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

ixcrypto/CMakeLists.txt

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

ixcrypto/ixcrypto/IXHMac.cpp

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

ixcrypto/ixcrypto/IXHash.cpp

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

ixcrypto/ixcrypto/IXHash.h

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

ixcrypto/ixcrypto/IXUuid.cpp

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

ixcrypto/ixcrypto/IXUuid.h

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

ixwebsocket/IXCancellationRequest.cpp

@@ -8,7 +8,7 @@
 
 #include <chrono>
 
-namespace ix
+namespace ix 
 {
     CancellationRequest makeCancellationRequestWithTimeout(int secs,
                                                            std::atomic<bool>& requestInitCancellation)
@@ -20,7 +20,7 @@ namespace ix
         {
             // Was an explicit cancellation requested ?
             if (requestInitCancellation) return true;
-
+            
             auto now = std::chrono::system_clock::now();
             if ((now - start) > timeout) return true;
 

ixwebsocket/IXCancellationRequest.h

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

ixwebsocket/IXConnectionState.cpp

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

ixwebsocket/IXConnectionState.h

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

ixwebsocket/IXDNSLookup.cpp

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

ixwebsocket/IXDNSLookup.h

@@ -3,7 +3,7 @@
  *  Author: Benjamin Sergeant
  *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
  *
- *  Resolve a hostname+port to a struct addrinfo obtained with getaddrinfo
+ *  Resolve a hostname+port to a struct addrinfo obtained with getaddrinfo 
  *  Does this in a background thread so that it can be cancelled, since
  *  getaddrinfo is a blocking call, and we don't want to block the main thread on Mobile.
  */
@@ -11,55 +11,56 @@
 #pragma once
 
 #include "IXCancellationRequest.h"
-#include <atomic>
-#include <memory>
-#include <mutex>
-#include <set>
+
 #include <string>
+#include <thread>
+#include <atomic>
+#include <condition_variable>
+#include <set>
 
 struct addrinfo;
 
-namespace ix
+namespace ix 
 {
-    class DNSLookup : public std::enable_shared_from_this<DNSLookup>
-    {
+    class DNSLookup {
     public:
-        DNSLookup(const std::string& hostname, int port, int64_t wait = DNSLookup::kDefaultWait);
-        ~DNSLookup() = default;
+        DNSLookup(const std::string& hostname,
+                  int port,
+                  int64_t wait = DNSLookup::kDefaultWait);
+        ~DNSLookup();
 
         struct addrinfo* resolve(std::string& errMsg,
                                  const CancellationRequest& isCancellationRequested,
-                                 bool cancellable = true);
+                                 bool blocking = false);
 
     private:
-        struct addrinfo* resolveCancellable(std::string& errMsg,
-                                            const CancellationRequest& isCancellationRequested);
-        struct addrinfo* resolveUnCancellable(std::string& errMsg,
-                                              const CancellationRequest& isCancellationRequested);
+        struct addrinfo* resolveAsync(std::string& errMsg,
+                                      const CancellationRequest& isCancellationRequested);
+        struct addrinfo* resolveBlocking(std::string& errMsg,
+                                         const CancellationRequest& isCancellationRequested);
 
-        static struct addrinfo* getAddrInfo(const std::string& hostname,
+        static struct addrinfo* getAddrInfo(const std::string& hostname, 
                                             int port,
                                             std::string& errMsg);
 
-        void run(std::weak_ptr<DNSLookup> self, std::string hostname, int port); // thread runner
-
-        void setErrMsg(const std::string& errMsg);
-        const std::string& getErrMsg();
-
-        void setRes(struct addrinfo* addr);
-        struct addrinfo* getRes();
+        void run(uint64_t id, const std::string& hostname, int port); // thread runner
 
         std::string _hostname;
         int _port;
         int64_t _wait;
-        const static int64_t kDefaultWait;
-
-        struct addrinfo* _res;
-        std::mutex _resMutex;
-
         std::string _errMsg;
-        std::mutex _errMsgMutex;
+        struct addrinfo* _res;
 
         std::atomic<bool> _done;
+        std::thread _thread;
+        std::condition_variable _condition;
+        std::mutex _conditionVariableMutex;
+
+        uint64_t _id;
+        static std::atomic<uint64_t> _nextId;
+        static std::set<uint64_t> _activeJobs;
+        static std::mutex _activeJobsMutex;
+
+        const static int64_t kDefaultWait;
     };
-} // namespace ix
+}

ixwebsocket/IXEventFd.cpp

@@ -0,0 +1,82 @@
+/*
+ *  IXEventFd.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// Linux/Android has a special type of virtual files. select(2) will react
+// when reading/writing to those files, unlike closing sockets.
+//
+// https://linux.die.net/man/2/eventfd
+// http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
+//
+// eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
+// is on Kernel 3.x
+//
+// cf Android/Kernel table here 
+// https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
+//
+
+#include "IXEventFd.h"
+
+#ifdef __linux__
+# include <sys/eventfd.h>
+#endif
+
+#ifndef _WIN32
+#include <unistd.h> // for write
+#endif
+
+namespace ix 
+{
+    EventFd::EventFd() : 
+        _eventfd(-1)
+    {
+#ifdef __linux__
+        _eventfd = eventfd(0, 0);
+#endif
+    }
+
+    EventFd::~EventFd()
+    {
+#ifdef __linux__
+        ::close(_eventfd);
+#endif
+    }
+
+    bool EventFd::notify()
+    {
+#if defined(__linux__)
+        if (_eventfd == -1) return false;
+
+        // select will wake up when a non-zero value is written to our eventfd
+        uint64_t value = 1;
+
+        // we should write 8 bytes for an uint64_t
+        return write(_eventfd, &value, sizeof(value)) == 8;
+#else
+        return true;
+#endif
+    }
+
+    bool EventFd::clear()
+    {
+#if defined(__linux__)
+        if (_eventfd == -1) return false;
+
+        // 0 is a special value ; select will not wake up 
+        uint64_t value = 0;
+
+        // we should write 8 bytes for an uint64_t
+        return write(_eventfd, &value, sizeof(value)) == 8;
+#else
+        return true;
+#endif
+    }
+
+    int EventFd::getFd()
+    {
+        return _eventfd;
+    }
+}

ixwebsocket/IXEventFd.h

@@ -0,0 +1,23 @@
+/*
+ *  IXEventFd.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+namespace ix 
+{
+    class EventFd {
+    public:
+        EventFd();
+        virtual ~EventFd();
+
+        bool notify();
+        bool clear();
+        int getFd();
+
+    private:
+        int _eventfd;
+    };
+}

ixwebsocket/IXExponentialBackoff.cpp

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

ixwebsocket/IXExponentialBackoff.h

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

ixwebsocket/IXHttp.cpp

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

ixwebsocket/IXHttp.h

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