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

.github/workflows/ccpp.yml

@@ -1,50 +0,0 @@
-name: C/C++ CI
-
-on: [push]
-
-jobs:
-  linux:
-    runs-on: ubuntu-latest
-    
-    steps:
-    - uses: actions/checkout@v1
-    - name: make test
-      run: make test
-
-  mac:
-    runs-on: macOS-latest
-
-    steps:
-    - uses: actions/checkout@v1
-
-    - name: install redis
-      run: brew install redis
-
-    - name: start redis server
-      run: brew services start redis
-
-    - name: make test
-      run: make test
-
-      #  # Windows does not work yet, I'm stuck at getting CMake to run + finding vcpkg
-      #  win:
-      #    runs-on: windows-2016
-      #
-      #    steps:
-      #    - uses: actions/checkout@v1
-      #
-      #    - name: run cmake
-      #      run: |
-      #        "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
-      #        mkdir build
-      #        cd build
-      #        cmake -DCMAKE_TOOLCHAIN_FILE=%VCPKG_INSTALLATION_ROOT%\scripts\buildsystems\vcpkg.cmake -DUSE_WS=1 -DUSE_TEST=1 -DUSE_TLS=1 -G"NMake Makefiles" ..
-      #    - name: build
-      #      run: |
-      #        "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
-      #        cd build
-      #        nmake
-      #    - name: run tests
-      #      run: 
-      #        cd test
-      #        ..\build\test\ixwebsocket_unittest.exe

.gitignore

@@ -1,7 +0,0 @@
-build
-*.pyc
-venv
-ixsnake/ixsnake/.certs/
-site/
-ws/.certs/
-ws/.srl

.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/FindJsonCpp.cmake

@@ -1,19 +0,0 @@
-# Find package structure taken from libcurl
-
-include(FindPackageHandleStandardArgs)
-
-find_path(JSONCPP_INCLUDE_DIRS json/json.h)
-find_library(JSONCPP_LIBRARY jsoncpp)
-
-find_package_handle_standard_args(JSONCPP
-    FOUND_VAR
-      JSONCPP_FOUND
-    REQUIRED_VARS
-      JSONCPP_LIBRARY
-      JSONCPP_INCLUDE_DIRS
-    FAIL_MESSAGE
-      "Could NOT find jsoncpp"
-)
-
-set(JSONCPP_INCLUDE_DIRS ${JSONCPP_INCLUDE_DIRS})
-set(JSONCPP_LIBRARIES ${JSONCPP_LIBRARY})

CMake/FindMbedTLS.cmake

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

CMakeLists.txt

@@ -4,131 +4,72 @@
 #
 
 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/IXSocketTLSOptions.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/IXSocketTLSOptions.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/IXWebSocketInitResult.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)
 elseif (WIN32)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
-elseif (${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
-    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/freebsd/IXSetThreadName_freebsd.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()
 
 if (USE_TLS)
-    if (USE_MBED_TLS)
-        list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSocketMbedTLS.h)
-        list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSocketMbedTLS.cpp)
-    elseif (APPLE AND NOT USE_OPEN_SSL)
+    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()
@@ -139,104 +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 (USE_OPEN_SSL)
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
-    elseif (APPLE)
-    elseif (WIN32)
-    else()
-        target_compile_definitions(ixwebsocket PUBLIC IXWEBSOCKET_USE_OPEN_SSL)
-    endif()
-endif()
-
-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)
-
-  # Help finding Homebrew's OpenSSL on macOS
-  if (APPLE)
-    set(CMAKE_LIBRARY_PATH ${CMAKE_LIBRARY_PATH} /usr/local/opt/openssl/lib)
-    set(CMAKE_INCLUDE_PATH ${CMAKE_INCLUDE_PATH} /usr/local/opt/openssl/include)
-  endif()
+# gcc/Linux needs -pthread
+find_package(Threads)
 
+if(UNIX AND NOT APPLE)
   find_package(OpenSSL REQUIRED)
   add_definitions(${OPENSSL_DEFINITIONS})
   message(STATUS "OpenSSL: " ${OPENSSL_VERSION})
   include_directories(${OPENSSL_INCLUDE_DIR})
-  target_link_libraries(ixwebsocket ${OPENSSL_LIBRARIES})
 endif()
 
-if (USE_TLS AND USE_MBED_TLS)
-  # FIXME I'm not too sure that this USE_VENDORED_THIRD_PARTY thing works
-  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)
-  add_subdirectory(ixsnake)
-  add_subdirectory(ixsentry)
-
-  add_subdirectory(third_party/spdlog spdlog)
-
-  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} )

Dockerfile

@@ -1,35 +0,0 @@
-FROM alpine:3.11 as build
-
-RUN apk add --no-cache gcc g++ musl-dev linux-headers cmake openssl-dev 
-RUN apk add --no-cache make
-RUN apk add --no-cache zlib-dev
-
-RUN addgroup -S app && adduser -S -G app app 
-RUN chown -R app:app /opt
-RUN chown -R app:app /usr/local
-
-# There is a bug in CMake where we cannot build from the root top folder
-# So we build from /opt
-COPY --chown=app:app . /opt
-WORKDIR /opt
-
-USER app
-RUN [ "make", "ws_install" ]
-
-FROM alpine:3.11 as runtime
-
-RUN apk add --no-cache libstdc++
-RUN apk add --no-cache strace
-
-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"]
-EXPOSE 8008
-CMD ["--help"]

Dockerfile

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

README.md

@@ -1,41 +1,321 @@
-## Hello world
+# General
 
-![Build status badge](https://travis-ci.org/machinezone/IXWebSocket.svg?branch=master)
+![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). It was tested on macOS, iOS, Linux, Android, Windows and FreeBSD. Two important design goals are simplicity and correctness.
+[*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.
 
-```cpp
-// Required on Windows
-ix::initNetSystem();
+* macOS
+* iOS
+* Linux
+* Android 
+* Windows (no TLS support yet)
 
-// Our websocket object
+## Examples
+
+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);
 
-// Setup a callback to be fired (in a background thread, watch out for race conditions !)
-// when a message or an event (open, close, error) is received
-webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
+// 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 (msg->type == ix::WebSocketMessageType::Message)
+        if (messageType == ix::WebSocket_MessageType_Message)
         {
-            std::cout << msg->str << std::endl;
+            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 (default to TEXT mode)
+// Send a message to the server
 webSocket.send("hello world");
+
+// ... finally ...
+
+// Stop the connection
+webSocket.stop()
 ```
 
-Interested? Go read the [docs](https://machinezone.github.io/IXWebSocket/)! If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.
+Here is what the server API looks like. Note that server support is very recent and subject to changes.
 
-IXWebSocket is actively being developed, check out the [changelog](https://machinezone.github.io/IXWebSocket/CHANGELOG/) to know what's cooking. If you are looking for a real time messaging service (the chat-like 'server' your websocket code will talk to) with many features such as history, backed by Redis, look at [cobra](https://github.com/machinezone/cobra).
+```
+// 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);
 
-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.
+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);
+```

SECURITY.md

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

appveyor.yml

@@ -1,22 +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,67 +0,0 @@
-version: "3"
-services:
-  # snake:
-  #   image: bsergean/ws:build
-  #   entrypoint: ws snake --port 8767 --host 0.0.0.0 --redis_hosts redis1
-  #   ports:
-  #     - "8767:8767"
-  #   networks:
-  #     - ws-net
-  #   depends_on:
-  #     - redis1
-
-  # proxy:
-  #   image: bsergean/ws:build
-  #   entrypoint: strace ws proxy_server --remote_host 'wss://cobra.addsrv.com' --host 0.0.0.0 --port 8765 -v
-  #   ports:
-  #     - "8765:8765"
-  #   networks:
-  #     - ws-net
-
-  #pyproxy:
-  #  image: bsergean/ws_proxy:build
-  #  entrypoint: /usr/bin/ws_proxy.py --remote_url 'wss://cobra.addsrv.com' --host 0.0.0.0 --port 8765
-  #  ports:
-  #    - "8765:8765"
-  #  networks:
-  #    - ws-net
-
-  #      #  ws:
-  #      #    security_opt:
-  #      #    - seccomp:unconfined
-  #      #    cap_add:
-  #      #    - SYS_PTRACE
-  #      #    stdin_open: true
-  #      #    tty: true
-  #      #    image: bsergean/ws:build
-  #      #    entrypoint: sh
-  #      #    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
-
-  compile:
-    image: alpine
-    entrypoint: sh
-    stdin_open: true
-    tty: true
-    volumes:
-      - /Users/bsergeant/src/foss:/home/bsergean/src/foss
-
-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,34 +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", "ws_install" ]
-
-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"]
-EXPOSE 8008
-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,24 +0,0 @@
-# Build time
-FROM ubuntu:disco as build
-
-ENV DEBIAN_FRONTEND noninteractive
-RUN apt-get update 
-RUN apt-get -y install wget 
-RUN mkdir -p /tmp/cmake
-WORKDIR /tmp/cmake
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz 
-RUN tar zxf cmake-3.14.0-Linux-x86_64.tar.gz
-
-RUN apt-get -y install g++ 
-RUN apt-get -y install libssl-dev
-RUN apt-get -y install libz-dev
-RUN apt-get -y install make
-RUN apt-get -y install python
-
-COPY . .
-
-ARG CMAKE_BIN_PATH=/tmp/cmake/cmake-3.14.0-Linux-x86_64/bin
-ENV PATH="${CMAKE_BIN_PATH}:${PATH}"
-
-# RUN ["make", "test"]
-CMD ["sh"]

docker/Dockerfile.ubuntu_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,392 +0,0 @@
-# Changelog
-All changes to this project will be documented in this file.
-
-## [7.8.4] - 2019-12-27
-
-(ws cobra to sentry) game is picked in a fair manner, so that all games get the same share of sent events
-
-## [7.8.3] - 2019-12-27
-
-(ws cobra to sentry) refactor queue related code into a class
-
-## [7.8.2] - 2019-12-25
-
-(ws cobra to sentry) bound the queue size used to hold up cobra messages before they are sent to sentry. Default queue size is a 100 messages. Without such limit the program runs out of memory when a subscriber receive a lot of messages that cannot make it to sentry
-
-## [7.8.1] - 2019-12-25
-
-(ws client) use correct compilation defines so that spdlog is not used as a header only library (reduce binary size and increase compilation speed)
-
-## [7.8.0] - 2019-12-24
-
-(ws client) all commands use spdlog instead of std::cerr or std::cout for logging
-
-## [7.6.5] - 2019-12-24
-
-(cobra client) send a websocket ping every 30s to keep the connection opened
-
-## [7.6.4] - 2019-12-22
-
-(client) error handling, quote url in error case when failing to parse one
-(ws) ws_cobra_publish: register callbacks before connecting
-(doc) mention mbedtls in supported ssl server backend
-
-## [7.6.3] - 2019-12-20
-
-(tls) add a simple description of the TLS configuration routine for debugging
-
-## [7.6.2] - 2019-12-20
-
-(mbedtls) correct support for using own certificate and private key
-
-## [7.6.1] - 2019-12-20
-
-(ws commands) in websocket proxy, disable automatic reconnections + in Dockerfile, use alpine 3.11
-
-## [7.6.0] - 2019-12-19
-
-(cobra) Add TLS options to all cobra commands and classes. Add example to the doc.
-
-## [7.5.8] - 2019-12-18
-
-(cobra-to-sentry) capture application version from device field
-
-## [7.5.7] - 2019-12-18
-
-(tls) Experimental TLS server support with mbedtls (windows) + process cert tlsoption (client + server)
-
-## [7.5.6] - 2019-12-18
-
-(tls servers) Make it clear that apple ssl and mbedtls backends do not support SSL in server mode
-
-## [7.5.5] - 2019-12-17
-
-(tls options client) TLSOptions struct _validated member should be initialized to false
-
-## [7.5.4] - 2019-12-16
-
-(websocket client) improve the error message when connecting to a non websocket server
-
-Before:
-
-```
-Connection error: Got bad status connecting to example.com:443, status: 200, HTTP Status line: HTTP/1.1 200 OK
-```
-
-After:
-
-```
-Connection error: Expecting status 101 (Switching Protocol), got 200 status connecting to example.com:443, HTTP Status line: HTTP/1.1 200 OK
-```
-
-## [7.5.3] - 2019-12-12
-
-(server) attempt at fixing #131 by using blocking writes in server mode
-
-## [7.5.2] - 2019-12-11
-
-(ws) cobra to sentry - created events with sentry tags based on tags present in the cobra messages
-
-## [7.5.1] - 2019-12-06
-
-(mac) convert SSL errors to utf8
-
-## [7.5.0] - 2019-12-05
-
-- (ws) cobra to sentry. Handle Error 429 Too Many Requests and politely wait before sending more data to sentry.
-
-In the example below sentry we are sending data too fast, sentry asks us to slow down which we do. Notice how the sent count stop increasing, while we are waiting for 41 seconds.
-
-```
-[2019-12-05 15:50:33.759] [info] messages received 2449 sent 3
-[2019-12-05 15:50:34.759] [info] messages received 5533 sent 7
-[2019-12-05 15:50:35.759] [info] messages received 8612 sent 11
-[2019-12-05 15:50:36.759] [info] messages received 11562 sent 15
-[2019-12-05 15:50:37.759] [info] messages received 14410 sent 19
-[2019-12-05 15:50:38.759] [info] messages received 17236 sent 23
-[2019-12-05 15:50:39.282] [error] Error sending data to sentry: 429
-[2019-12-05 15:50:39.282] [error] Body: {"exception":[{"stacktrace":{"frames":[{"filename":"WorldScene.lua","function":"WorldScene.lua:1935","lineno":1958},{"filename":"WorldScene.lua","function":"onUpdate_WorldCam","lineno":1921},{"filename":"WorldMapTile.lua","function":"__index","lineno":239}]},"value":"noisytypes: Attempt to call nil(nil,2224139838)!"}],"platform":"python","sdk":{"name":"ws","version":"1.0.0"},"tags":[["game","niso"],["userid","107638363"],["environment","live"]],"timestamp":"2019-12-05T23:50:39Z"}
-
-[2019-12-05 15:50:39.282] [error] Response: {"error_name":"rate_limit","error":"Creation of this event was denied due to rate limiting"}
-[2019-12-05 15:50:39.282] [warning] Error 429 - Too Many Requests. ws will sleep and retry after 41 seconds
-[2019-12-05 15:50:39.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:40.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:41.760] [info] messages received 18839 sent 25
-[2019-12-05 15:50:42.761] [info] messages received 18839 sent 25
-[2019-12-05 15:50:43.762] [info] messages received 18839 sent 25
-[2019-12-05 15:50:44.763] [info] messages received 18839 sent 25
-[2019-12-05 15:50:45.768] [info] messages received 18839 sent 25
-```
-
-## [7.4.5] - 2019-12-03
-
-- (ws) #125 / fix build problem when jsoncpp is not installed locally
-
-## [7.4.4] - 2019-12-03
-
-- (ws) #125 / cmake detects an already installed jsoncpp and will try to use this one if present
-
-## [7.4.3] - 2019-12-03
-
-- (http client) use std::unordered_map instead of std::map for HttpParameters and HttpFormDataParameters class aliases
-
-## [7.4.2] - 2019-12-02
-
-- (client) internal IXDNSLookup class requires a valid cancellation request function callback to be passed in
-
-## [7.4.1] - 2019-12-02
-
-- (client) fix an overflow in the exponential back off code
-
-## [7.4.0] - 2019-11-25
-
-- (http client) Add support for multipart HTTP POST upload
-- (ixsentry) Add support for uploading a minidump to sentry
-
-## [7.3.5] - 2019-11-20
-
-- On Darwin SSL, add ability to skip peer verification.
-
-## [7.3.4] - 2019-11-20
-
-- 32-bits compile fix, courtesy of @fcojavmc
-
-## [7.3.1] - 2019-11-16
-
-- ws proxy_server / remote server close not forwarded to the client
-
-## [7.3.0] - 2019-11-15
-
-- New ws command: `ws proxy_server`.
-
-## [7.2.2] - 2019-11-01
-
-- Tag a release + minor reformating.
-
-## [7.2.1] - 2019-10-26
-
-- Add unittest to IXSentryClient to lua backtrace parsing code
-
-## [7.2.0] - 2019-10-24
-
-- Add cobra_metrics_to_redis sub-command to create streams for each cobra metric event being received.
-
-## [7.1.0] - 2019-10-13
-
-- Add client support for websocket subprotocol. Look for the new addSubProtocol method for details.
-
-## [7.0.0] - 2019-10-01
-
-- TLS support in server code, only implemented for the OpenSSL SSL backend for now.
-
-## [6.3.4] - 2019-09-30
-
-- all ws subcommands propagate tls options to servers (unimplemented) or ws or http client (implemented) (contributed by Matt DeBoer)
-
-## [6.3.3] - 2019-09-30
-
-- ws has a --version option
-
-## [6.3.2] - 2019-09-29
-
-- (http + websocket clients) can specify cacert and some other tls options (not implemented on all backend). This makes it so that server certs can finally be validated on windows.
-
-## [6.3.1] - 2019-09-29
-
-- Add ability to use OpenSSL on apple platforms.
-
-## [6.3.0] - 2019-09-28
-
-- ixcobra / fix crash in CobraConnection::publishNext when the queue is empty + handle CobraConnection_PublishMode_Batch in CobraMetricsThreadedPublisher
-
-## [6.2.9] - 2019-09-27
-
-- mbedtls fixes / the unittest now pass on macOS, and hopefully will on Windows/AppVeyor as well.
-
-## [6.2.8] - 2019-09-26
-
-- Http server: add options to ws https to redirect all requests to a given url. POST requests will get a 200 and an empty response.
-
-```
-ws httpd -L --redirect_url https://www.google.com
-```
-
-## [6.2.7] - 2019-09-25
-
-- Stop having ws send subcommand send a binary message in text mode, which would cause error in `make ws_test` shell script test.
-
-## [6.2.6] - 2019-09-24
-
-- Fix 2 race conditions detected with TSan, one in CobraMetricsPublisher::push and another one in WebSocketTransport::sendData (that one was bad).
-
-## [6.2.5] - 2019-09-23
-
-- Add simple Redis Server which is only capable of doing publish / subscribe. New ws redis_server sub-command to use it. The server is used in the unittest, so that we can run on CI in environment where redis isn not available like github actions env.
-
-## [6.2.4] - 2019-09-22
-
-- Add options to configure TLS ; contributed by Matt DeBoer. Only implemented for OpenSSL TLS backend for now.
-
-## [6.2.3] - 2019-09-21
-
-- Fix crash in the Linux unittest in the HTTP client code, in Socket::readBytes
-- Cobra Metrics Publisher code returns the message id of the message that got published, to be used to validated that it got sent properly when receiving an ack.
-
-## [6.2.2] - 2019-09-19
-
-- In DNS lookup code, make sure the weak pointer we use lives through the expected scope (if branch)
-
-## [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`, and a list of the uploaded versions is available on [Bintray](https://bintray.com/oliviazoe0/conan-packages/IXWebSocket%3ALunarWatcher). 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/cobra.md

@@ -1,81 +0,0 @@
-## General
-
-[cobra](https://github.com/machinezone/cobra) is a real time messaging server. The `ws` utility can run a cobra server (named snake), and has client to publish and subscribe to a cobra server.
-
-Bring up 3 terminals and run a server, a publisher and a subscriber in each one. As you publish data you should see it being received by the subscriber. You can run `redis-cli MONITOR` too to see how redis is being used.
-
-### Server
-
-You will need to have a redis server running locally. To run the server:
-
-```bash
-$ cd <ixwebsocket-top-level-folder>/ixsnake/ixsnake
-$ ws snake
-{
-  "apps": {
-    "FC2F10139A2BAc53BB72D9db967b024f": {
-      "roles": {
-        "_sub": {
-          "secret": "66B1dA3ED5fA074EB5AE84Dd8CE3b5ba"
-        },
-        "_pub": {
-          "secret": "1c04DB8fFe76A4EeFE3E318C72d771db"
-        }
-      }
-    }
-  }
-}
-
-redis host: 127.0.0.1
-redis password:
-redis port: 6379
-```
-
-### Publisher
-
-```bash
-$ cd <ixwebsocket-top-level-folder>/ws
-$ ws cobra_publish --appkey FC2F10139A2BAc53BB72D9db967b024f --endpoint ws://127.0.0.1:8008 --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db test_channel cobraMetricsSample.json
-[2019-11-27 09:06:12.980] [info] Publisher connected
-[2019-11-27 09:06:12.980] [info] Connection: Upgrade
-[2019-11-27 09:06:12.980] [info] Sec-WebSocket-Accept: zTtQKMKbvwjdivURplYXwCVUCWM=
-[2019-11-27 09:06:12.980] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-11-27 09:06:12.980] [info] Server: ixwebsocket/7.4.0 macos ssl/DarwinSSL zlib 1.2.11
-[2019-11-27 09:06:12.980] [info] Upgrade: websocket
-[2019-11-27 09:06:12.982] [info] Publisher authenticated
-[2019-11-27 09:06:12.982] [info] Published msg 3
-[2019-11-27 09:06:12.982] [info] Published message id 3 acked
-```
-
-### Subscriber
-
-```bash
-$ ws cobra_subscribe --appkey FC2F10139A2BAc53BB72D9db967b024f --endpoint ws://127.0.0.1:8008 --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db test_channel
-#messages 0 msg/s 0
-[2019-11-27 09:07:39.341] [info] Subscriber connected
-[2019-11-27 09:07:39.341] [info] Connection: Upgrade
-[2019-11-27 09:07:39.341] [info] Sec-WebSocket-Accept: 9vkQWofz49qMCUlTSptCCwHWm+Q=
-[2019-11-27 09:07:39.341] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-11-27 09:07:39.341] [info] Server: ixwebsocket/7.4.0 macos ssl/DarwinSSL zlib 1.2.11
-[2019-11-27 09:07:39.341] [info] Upgrade: websocket
-[2019-11-27 09:07:39.342] [info] Subscriber authenticated
-[2019-11-27 09:07:39.345] [info] Subscriber: subscribed to channel test_channel
-#messages 0 msg/s 0
-#messages 0 msg/s 0
-#messages 0 msg/s 0
-{"baz":123,"foo":"bar"}
-
-#messages 1 msg/s 1
-#messages 1 msg/s 0
-#messages 1 msg/s 0
-{"baz":123,"foo":"bar"}
-
-{"baz":123,"foo":"bar"}
-
-#messages 3 msg/s 2
-#messages 3 msg/s 0
-{"baz":123,"foo":"bar"}
-
-#messages 4 msg/s 1
-^C
-```

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 platforms, with different sanitizers such as a thread sanitizer to catch data races or the undefined behavior sanitizer.
-
-The regression test is running after each commit on travis.
-
-## Limitations
-
-* On Windows and Android certificate validation needs to be setup so that SocketTLSOptions.caFile point to a pem file, such as the one distributed by Firefox. Unless that setup is done connecting to a wss endpoint will display an error. On Windows with mbedtls the message will contain `error in handshake : X509 - Certificate verification failed, e.g. CRL, CA or signature check failed`.
-* 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,51 +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
-* FreeBSD
-
-## Example code
-
-```cpp
-// 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.
-
-## Contributing
-
-IXWebSocket is developed on [GitHub](https://github.com/machinezone/IXWebSocket). We'd love to hear about how you use it; opening up an issue on GitHub is ok for that. If things don't work as expected, please create an issue on GitHub, or even better a pull request if you know how to fix your problem.

docs/usage.md

@@ -1,466 +0,0 @@
-# Examples
-
-The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage.
-
-## Windows note
-
-To use the network system on Windows, you need to initialize it once with *WSAStartup()* and clean it up with *WSACleanup()*. We have helpers for that which you can use, see below. This init would typically take place in your main function.
-
-```cpp
-#include <ixwebsocket/IXNetSystem.h>
-
-int main()
-{
-    ix::initNetSystem();
-
-    ...
-
-    ix::uninitNetSystem();
-    return 0;
-}
-```
-
-## WebSocket client API
-
-```cpp
-#include <ixwebsocket/IXWebSocket.h>
-
-...
-
-// Our websocket object
-ix::WebSocket webSocket;
-
-std::string url("ws://localhost:8080/");
-webSocket.setUrl(url);
-
-// Optional heart beat, sent every 45 seconds when there is not any traffic
-// to make sure that load balancers do not kill an idle connection.
-webSocket.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`.
-
-```cpp
-webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
-    {
-        if (msg->type == ix::WebSocketMessageType::Open)
-        {
-            std::cout << "send greetings" << std::endl;
-
-            // Headers can be inspected (pairs of string/string)
-            std::cout << "Handshake Headers:" << std::endl;
-            for (auto it : msg->headers)
-            {
-                std::cout << it.first << ": " << it.second << std::endl;
-            }
-        }
-        else if (msg->type == ix::WebSocketMessageType::Close)
-        {
-            std::cout << "disconnected" << std::endl;
-
-            // The server can send an explicit code and reason for closing.
-            // This data can be accessed through the closeInfo object.
-            std::cout << msg->closeInfo.code << std::endl;
-            std::cout << msg->closeInfo.reason << std::endl;
-        }
-    }
-);
-```
-
-### Error notification
-
-A message will be fired when there is an error with the connection. The message type will be `ix::WebSocketMessageType::Error`. Multiple fields will be available on the event to describe the error.
-
-```cpp
-webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
-    {
-        if (msg->type == ix::WebSocketMessageType::Error)
-        {
-            std::stringstream ss;
-            ss << "Error: "         << msg->errorInfo.reason      << std::endl;
-            ss << "#retries: "      << msg->eventInfo.retries     << std::endl;
-            ss << "Wait time(ms): " << msg->eventInfo.wait_time   << std::endl;
-            ss << "HTTP Status: "   << msg->eventInfo.http_status << std::endl;
-            std::cout << ss.str() << std::endl;
-        }
-    }
-);
-```
-
-### start, stop
-
-1. `websocket.start()` connect to the remote server and starts the message receiving background thread.
-2. `websocket.stop()` disconnect from the remote server and closes the background thread.
-
-### Configuring the remote url
-
-The url can be set and queried after a websocket object has been created. You will have to call `stop` and `start` if you want to disconnect and connect to that new url.
-
-```cpp
-std::string url("wss://example.com");
-websocket.configure(url);
-```
-
-### Ping/Pong support
-
-Ping/pong messages are used to implement keep-alive. 2 message types exists to identify ping and pong messages. Note that when a ping message is received, a pong is instantly send back as requested by the WebSocket spec.
-
-```cpp
-webSocket.setOnMessageCallback([](const ix::WebSocketMessagePtr& msg)
-    {
-        if (msg->type == ix::WebSocketMessageType::Ping ||
-            msg->type == ix::WebSocketMessageType::Pong)
-        {
-            std::cout << "pong data: " << msg->str << std::endl;
-        }
-    }
-);
-```
-
-A ping message can be sent to the server, with an optional data string.
-
-```cpp
-websocket.ping("ping data, optional (empty string is ok): limited to 125 bytes long");
-```
-
-### Heartbeat.
-
-You can configure an optional heart beat / keep-alive, sent every 45 seconds
-when there is no any traffic to make sure that load balancers do not kill an
-idle connection.
-
-```cpp
-webSocket.setHeartBeatPeriod(45);
-```
-
-### Supply extra HTTP headers.
-
-You can set extra HTTP headers to be sent during the WebSocket handshake.
-
-```cpp
-WebSocketHttpHeaders headers;
-headers["foo"] = "bar";
-webSocket.setExtraHeaders(headers);
-```
-
-### Subprotocols
-
-You can specify subprotocols to be set during the WebSocket handshake. For more info you can refer to [this doc](https://hpbn.co/websocket/#subprotocol-negotiation).
-
-```cpp
-webSocket.addSubprotocol("appProtocol-v1");
-webSocket.addSubprotocol("appProtocol-v2");
-```
-
-The protocol that the server did accept is available in the open info `protocol` field.
-
-```cpp
-std::cout << "protocol: " << msg->openInfo.protocol << std::endl;
-```
-
-### Automatic reconnection
-
-Automatic reconnection kicks in when the connection is disconnected without the user consent. This feature is on by default and can be turned off.
-
-```cpp
-webSocket.enableAutomaticReconnection();  // turn on
-webSocket.disableAutomaticReconnection(); // turn off
-bool enabled = webSocket.isAutomaticReconnectionEnabled(); // query state
-```
-
-The technique to calculate wait time is called [exponential
-backoff](https://docs.aws.amazon.com/general/latest/gr/api-retries.html). Here
-are the default waiting times between attempts (from connecting with `ws connect ws://foo.com`)
-
-```
-> Connection error: Got bad status connecting to foo.com, status: 301, HTTP Status line: HTTP/1.1 301 Moved Permanently
-
-#retries: 1
-Wait time(ms): 100
-#retries: 2
-Wait time(ms): 200
-#retries: 3
-Wait time(ms): 400
-#retries: 4
-Wait time(ms): 800
-#retries: 5
-Wait time(ms): 1600
-#retries: 6
-Wait time(ms): 3200
-#retries: 7
-Wait time(ms): 6400
-#retries: 8
-Wait time(ms): 10000
-```
-
-The waiting time is capped by default at 10s between 2 attempts, but that value can be changed and queried.
-
-```cpp
-webSocket.setMaxWaitBetweenReconnectionRetries(5 * 1000); // 5000ms = 5s
-uint32_t m = webSocket.getMaxWaitBetweenReconnectionRetries();
-```
-
-### TLS support and configuration
-
-To leverage TLS features, the library must be compiled with the option `USE_TLS=1`.
-
-Then, secure sockets are automatically used when connecting to a `wss://*` url.
-
-Additional TLS options can be configured by passing a `ix::SocketTLSOptions` instance to the
-`setTLSOptions` on `ix::WebSocket` (or `ix::WebSocketServer` or `ix::HttpServer`)
-
-```cpp
-webSocket.setTLSOptions({
-    .certFile = "path/to/cert/file.pem",
-    .keyFile = "path/to/key/file.pem",
-    .caFile = "path/to/trust/bundle/file.pem"
-});
-```
-
-Specifying `certFile` and `keyFile` configures the certificate that will be used to communicate with TLS peers.
-
-On a client, this is only necessary for connecting to servers that require a client certificate.
-
-On a server, this is necessary for TLS support.
-
-Specifying `caFile` configures the trusted roots bundle file (in PEM format) that will be used to verify peer certificates.
- - The special value of `SYSTEM` (the default) indicates that the system-configured trust bundle should be used; this is generally what you want when connecting to any publicly exposed API/server.
- - The special value of `NONE` can be used to disable peer verification; this is only recommended to rule out certificate verification when testing connectivity.
-
-For a client, specifying `caFile` can be used if connecting to a server that uses a self-signed cert, or when using a custom CA in an internal environment.
-
-For a server, specifying `caFile` implies that:
-1. You require clients to present a certificate
-1. It must be signed by one of the trusted roots in the file
-
-## WebSocket server API
-
-```cpp
-#include <ixwebsocket/IXWebSocketServer.h>
-
-...
-
-// Run a server on localhost at a given port.
-// Bound host name, max connections and listen backlog can also be passed in as parameters.
-ix::WebSocketServer server(port);
-
-server.setOnConnectionCallback(
-    [&server](std::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
-
-```cpp
-#include <ixwebsocket/IXHttpClient.h>
-
-...
-
-//
-// Preparation
-//
-HttpClient httpClient;
-HttpRequestArgsPtr args = httpClient.createRequest();
-
-// Custom headers can be set
-WebSocketHttpHeaders headers;
-headers["Foo"] = "bar";
-args->extraHeaders = headers;
-
-// Timeout options
-args->connectTimeout = connectTimeout;
-args->transferTimeout = transferTimeout;
-
-// Redirect options
-args->followRedirects = followRedirects;
-args->maxRedirects = maxRedirects;
-
-// Misc
-args->compress = compress; // Enable gzip compression
-args->verbose = verbose;
-args->logger = [](const std::string& msg)
-{
-    std::cout << msg;
-};
-
-//
-// Synchronous Request
-//
-HttpResponsePtr out;
-std::string url = "https://www.google.com";
-
-// HEAD request
-out = httpClient.head(url, args);
-
-// GET request
-out = httpClient.get(url, args);
-
-// POST request with parameters
-HttpParameters httpParameters;
-httpParameters["foo"] = "bar";
-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
-
-```cpp
-#include <ixwebsocket/IXHttpServer.h>
-
-ix::HttpServer server(port, hostname);
-
-auto res = server.listen();
-if (!res.first)
-{
-    std::cerr << res.second << std::endl;
-    return 1;
-}
-
-server.start();
-server.wait();
-```
-
-If you want to handle how requests are processed, implement the setOnConnectionCallback callback, which takes an HttpRequestPtr as input, and returns an HttpResponsePtr. You can look at HttpServer::setDefaultConnectionCallback for a slightly more advanced callback example.
-
-```cpp
-setOnConnectionCallback(
-    [this](HttpRequestPtr request,
-           std::shared_ptr<ConnectionState> /*connectionState*/) -> HttpResponsePtr
-    {
-        // Build a string for the response
-        std::stringstream ss;
-        ss << request->method
-           << " "
-           << request->uri;
-
-        std::string content = ss.str();
-
-        return std::make_shared<HttpResponse>(200, "OK",
-                                              HttpErrorCode::Ok,
-                                              WebSocketHttpHeaders(),
-                                              content);
-}
-```

docs/ws.md

@@ -1,369 +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
-```
-
-## curl
-
-The curl subcommand try to be compatible with the curl syntax, to fetch http pages.
-
-Making a HEAD request with the -I parameter.
-
-```
-$ ws curl -I https://www.google.com/
-
-Accept-Ranges: none
-Alt-Svc: quic=":443"; ma=2592000; v="46,43",h3-Q048=":443"; ma=2592000,h3-Q046=":443"; ma=2592000,h3-Q043=":443"; ma=2592000
-Cache-Control: private, max-age=0
-Content-Type: text/html; charset=ISO-8859-1
-Date: Tue, 08 Oct 2019 21:36:57 GMT
-Expires: -1
-P3P: CP="This is not a P3P policy! See g.co/p3phelp for more info."
-Server: gws
-Set-Cookie: NID=188=ASwfz8GrXQrHCLqAz-AndLOMLcz0rC9yecnf3h0yXZxRL3rTufTU_GDDwERp7qQL7LZ_EB8gCRyPXGERyOSAgaqgnrkoTmvWrwFemRLMaOZ896GrHobi5fV7VLklnSG2w48Gj8xMlwxfP7Z-bX-xR9UZxep1tHM6UmFQdD_GkBE; expires=Wed, 08-Apr-2020 21:36:57 GMT; path=/; domain=.google.com; HttpOnly
-Transfer-Encoding: chunked
-Vary: Accept-Encoding
-X-Frame-Options: SAMEORIGIN
-X-XSS-Protection: 0
-Upload size: 143
-Download size: 0
-Status: 200
-```
-
-Making a POST request with the -F parameter.
-
-```
-$ ws curl -F foo=bar https://httpbin.org/post
-foo: bar
-Downloaded 438 bytes out of 438
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 438
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:47:54 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 219
-Download size: 438
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-Passing in a custom header with -H.
-
-```
-$ ws curl -F foo=bar -H 'my_custom_header: baz' https://httpbin.org/post
-my_custom_header:  baz
-foo: bar
-Downloaded 470 bytes out of 470
-Access-Control-Allow-Credentials: true
-Access-Control-Allow-Origin: *
-Connection: keep-alive
-Content-Encoding:
-Content-Length: 470
-Content-Type: application/json
-Date: Tue, 08 Oct 2019 21:50:25 GMT
-Referrer-Policy: no-referrer-when-downgrade
-Server: nginx
-X-Content-Type-Options: nosniff
-X-Frame-Options: DENY
-X-XSS-Protection: 1; mode=block
-Upload size: 243
-Download size: 470
-Status: 200
-payload: {
-  "args": {},
-  "data": "",
-  "files": {},
-  "form": {
-    "foo": "bar"
-  },
-  "headers": {
-    "Accept": "*/*",
-    "Content-Length": "7",
-    "Content-Type": "application/x-www-form-urlencoded",
-    "Host": "httpbin.org",
-    "My-Custom-Header": "baz",
-    "User-Agent": "ixwebsocket/7.0.0 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11"
-  },
-  "json": null,
-  "origin": "155.94.127.118, 155.94.127.118",
-  "url": "https://httpbin.org/post"
-}
-```
-
-## connect
-
-The connect command connects to a websocket endpoint, and starts an interactive prompt. Line editing, such as using the direction keys to fetch the last thing you tried to type) is provided. That command is pretty useful to try to send random data to an endpoint and verify that the service handles it with grace (such as sending invalid json).
-
-```
-ws connect wss://echo.websocket.org
-Type Ctrl-D to exit prompt...
-Connecting to url: wss://echo.websocket.org
-> ws_connect: connected
-Uri: /
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:38:44 GMT
-Sec-WebSocket-Accept: 2j6LBScZveqrMx1W/GJkCWvZo3M=
-sec-websocket-extensions:
-Server: Kaazing Gateway
-Upgrade: websocket
-Received ping
-Received ping
-Received ping
-Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-> Hello world !
-> Received 13 bytes
-ws_connect: received message: Hello world !
-```
-
-```
-ws connect 'ws://jeanserge.com/v2?appkey=_pubsub'
-Type Ctrl-D to exit prompt...
-Connecting to url: ws://jeanserge.com/v2?appkey=_pubsub
-> ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:28 GMT
-Sec-WebSocket-Accept: LYHmjh9Gsu/Yw7aumQqyPObOEV4=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-bababababababab
-> ws_connect: connection closed: code 1000 reason
-
-ws_connect: connected
-Uri: /v2?appkey=_pubsub
-Handshake Headers:
-Connection: Upgrade
-Date: Tue, 08 Oct 2019 21:45:44 GMT
-Sec-WebSocket-Accept: I1rqxdLgTU+opPi5/zKPBTuXdLw=
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Server: Python/3.7 websockets/8.0.2
-Upgrade: websocket
-```
-
-## Websocket proxy
-
-```
-ws proxy_server --remote_host ws://127.0.0.1:9000 -v
-Listening on 127.0.0.1:8008
-```
-
-If you connect to ws://127.0.0.1:8008, the proxy will connect to ws://127.0.0.1:9000 and pass all traffic to this server.
-
-## 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 and server
-
-[cobra](https://github.com/machinezone/cobra) is a real time messenging server. ws has several sub-command to interact with cobra. There is also a minimal cobra compatible server named snake available.
-
-Below are examples on running a snake server and clients with TLS enabled (the server only works with the OpenSSL and the Mbed TLS backend for now).
-
-First, generate certificates.
-
-```
-$ cd /path/to/IXWebSocket
-$ cd ixsnake/ixsnake
-$ bash ../../ws/generate_certs.sh
-Generating RSA private key, 2048 bit long modulus
-.....+++
-.................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-ca-key.pem
-generated ./.certs/trusted-ca-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..+++
-.......................................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-server-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=trusted-server
-Getting CA Private Key
-generated ./.certs/trusted-server-crt.pem
-Generating RSA private key, 2048 bit long modulus
-...................................+++
-..................................................+++
-e is 65537 (0x10001)
-generated ./.certs/trusted-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=trusted-client
-Getting CA Private Key
-generated ./.certs/trusted-client-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..............+++
-.......................................+++
-e is 65537 (0x10001)
-generated ./.certs/untrusted-ca-key.pem
-generated ./.certs/untrusted-ca-crt.pem
-Generating RSA private key, 2048 bit long modulus
-..........+++
-................................................+++
-e is 65537 (0x10001)
-generated ./.certs/untrusted-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=untrusted-client
-Getting CA Private Key
-generated ./.certs/untrusted-client-crt.pem
-Generating RSA private key, 2048 bit long modulus
-.....................................................................................+++
-...........+++
-e is 65537 (0x10001)
-generated ./.certs/selfsigned-client-key.pem
-Signature ok
-subject=/O=machinezone/O=IXWebSocket/CN=selfsigned-client
-Getting Private key
-generated ./.certs/selfsigned-client-crt.pem
-```
-
-Now run the snake server.
-
-```
-$ export certs=.certs
-$ ws snake --tls --port 8765 --cert-file ${certs}/trusted-server-crt.pem --key-file ${certs}/trusted-server-key.pem --ca-file ${certs}/trusted-ca-crt.pem
-{
-  "apps": {
-    "FC2F10139A2BAc53BB72D9db967b024f": {
-      "roles": {
-        "_sub": {
-          "secret": "66B1dA3ED5fA074EB5AE84Dd8CE3b5ba"
-        },
-        "_pub": {
-          "secret": "1c04DB8fFe76A4EeFE3E318C72d771db"
-        }
-      }
-    }
-  }
-}
-
-redis host: 127.0.0.1
-redis password:
-redis port: 6379
-```
-
-As a new connection comes in, such output should be printed
-
-```
-[2019-12-19 20:27:19.724] [info] New connection
-id: 0
-Uri: /v2?appkey=_health
-Headers:
-Connection: Upgrade
-Host: 127.0.0.1:8765
-Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-Sec-WebSocket-Key: d747B0fE61Db73f7Eh47c0==
-Sec-WebSocket-Protocol: json
-Sec-WebSocket-Version: 13
-Upgrade: websocket
-User-Agent: ixwebsocket/7.5.8 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11
-```
-
-To connect and publish a message, do:
-
-```
-$ export certs=.certs
-$ cd /path/to/ws/folder
-$ ls cobraMetricsSample.json
-cobraMetricsSample.json
-$ ws cobra_publish --endpoint wss://127.0.0.1:8765 --appkey FC2F10139A2BAc53BB72D9db967b024f --rolename _pub --rolesecret 1c04DB8fFe76A4EeFE3E318C72d771db --channel foo --cert-file ${certs}/trusted-client-crt.pem --key-file ${certs}/trusted-client-key.pem --ca-file ${certs}/trusted-ca-crt.pem cobraMetricsSample.json
-[2019-12-19 20:46:42.656] [info] Publisher connected
-[2019-12-19 20:46:42.657] [info] Connection: Upgrade
-[2019-12-19 20:46:42.657] [info] Sec-WebSocket-Accept: rs99IFThoBrhSg+k8G4ixH9yaq4=
-[2019-12-19 20:46:42.657] [info] Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=15; client_max_window_bits=15
-[2019-12-19 20:46:42.657] [info] Server: ixwebsocket/7.5.8 macos ssl/OpenSSL OpenSSL 1.0.2q  20 Nov 2018 zlib 1.2.11
-[2019-12-19 20:46:42.657] [info] Upgrade: websocket
-[2019-12-19 20:46:42.658] [info] Publisher authenticated
-[2019-12-19 20:46:42.658] [info] Published msg 3
-[2019-12-19 20:46:42.659] [info] Published message id 3 acked
-```
-
-To use OpenSSL on macOS, compile with `make ws_openssl`. First you will have to install OpenSSL libraries, which can be done with Homebrew. Use `make ws_mbedtls` accordingly to use MbedTLS.

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

@@ -0,0 +1,203 @@
+/*
+ *  cmd_websocket_chat.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// Simple chat program that talks to the node.js server at
+// websocket_chat_server/broacast-server.js
+//
+
+#include <iostream>
+#include <sstream>
+#include <queue>
+#include <ixwebsocket/IXWebSocket.h>
+#include <ixwebsocket/IXSocket.h>
+
+#include "nlohmann/json.hpp"
+
+// for convenience
+using json = nlohmann::json;
+
+using namespace ix;
+
+namespace
+{
+    void log(const std::string& msg)
+    {
+        std::cout << msg << std::endl;
+    }
+
+    class WebSocketChat
+    {
+        public:
+            WebSocketChat(const std::string& user);
+
+            void subscribe(const std::string& channel);
+            void start();
+            void stop();
+            bool isReady() const;
+
+            void sendMessage(const std::string& text);
+            size_t getReceivedMessagesCount() const;
+
+            std::string encodeMessage(const std::string& text);
+            std::pair<std::string, std::string> decodeMessage(const std::string& str);
+
+        private:
+            std::string _user;
+
+            ix::WebSocket _webSocket;
+
+            std::queue<std::string> _receivedQueue;
+    };
+
+    WebSocketChat::WebSocketChat(const std::string& user) :
+        _user(user)
+    {
+        ;
+    }
+
+    size_t WebSocketChat::getReceivedMessagesCount() const
+    {
+        return _receivedQueue.size();
+    }
+
+    bool WebSocketChat::isReady() const
+    {
+        return _webSocket.getReadyState() == ix::WebSocket_ReadyState_Open;
+    }
+
+    void WebSocketChat::stop()
+    {
+        _webSocket.stop();
+    }
+
+    void WebSocketChat::start()
+    {
+        std::string url("ws://localhost:8080/");
+        _webSocket.setUrl(url);
+
+        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)
+                {
+                    ss << "cmd_websocket_chat: user "
+                       << _user
+                       << " Connected !";
+                       log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Close)
+                {
+                    ss << "cmd_websocket_chat: user "
+                       << _user
+                       << " disconnected !";
+                       log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Message)
+                {
+                    auto result = decodeMessage(str);
+
+                    // Our "chat" / "broacast" node.js server does not send us
+                    // the messages we send, so we don't have to filter it out.
+
+                    // store text
+                    _receivedQueue.push(result.second);
+
+                    ss << std::endl 
+                       << result.first << " > " << result.second
+                       << std::endl
+                       << _user << " > ";
+                    log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Error)
+                {
+                    ss << "Connection error: " << error.reason      << std::endl;
+                    ss << "#retries: "         << error.retries     << std::endl;
+                    ss << "Wait time(ms): "    << error.wait_time   << std::endl;
+                    ss << "HTTP Status: "      << error.http_status << std::endl;
+                    log(ss.str());
+                }
+                else
+                {
+                    ss << "Invalid ix::WebSocketMessageType";
+                    log(ss.str());
+                }
+            });
+
+        _webSocket.start();
+    }
+
+    std::pair<std::string, std::string> WebSocketChat::decodeMessage(const std::string& str)
+    {
+        auto j = json::parse(str);
+
+        std::string msg_user = j["user"];
+        std::string msg_text = j["text"];
+
+        return std::pair<std::string, std::string>(msg_user, msg_text);
+    }
+
+    std::string WebSocketChat::encodeMessage(const std::string& text)
+    {
+        json j;
+        j["user"] = _user;
+        j["text"] = text;
+
+        std::string output = j.dump();
+        return output;
+    }
+
+    void WebSocketChat::sendMessage(const std::string& text)
+    {
+        _webSocket.send(encodeMessage(text));
+    }
+
+    void interactiveMain(const std::string& user)
+    {
+        std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
+        WebSocketChat webSocketChat(user);
+        webSocketChat.start();
+
+        while (true)
+        {
+            std::string text;
+            std::cout << user << " > " << std::flush;
+            std::getline(std::cin, text);
+
+            if (!std::cin)
+            {
+                break;
+            }
+
+            webSocketChat.sendMessage(text);
+        }
+
+        std::cout << std::endl;
+        webSocketChat.stop();
+    }
+}
+
+int main(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

@@ -0,0 +1,475 @@
+/*
+ *  IXCobraConnection.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2017-2018 Machine Zone. All rights reserved.
+ */
+
+#include "IXCobraConnection.h"
+#include <ixcrypto/IXHMac.h>
+
+#include <algorithm>
+#include <stdexcept>
+#include <cmath>
+#include <cassert>
+#include <cstring>
+
+
+namespace ix
+{
+    TrafficTrackerCallback CobraConnection::_trafficTrackerCallback = nullptr;
+    constexpr size_t CobraConnection::kQueueMaxSize;
+
+    CobraConnection::CobraConnection() :
+        _authenticated(false),
+        _eventCallback(nullptr),
+        _publishMode(CobraConnection_PublishMode_Immediate)
+    {
+        _pdu["action"] = "rtm/publish";
+
+        initWebSocketOnMessageCallback();
+    }
+
+    CobraConnection::~CobraConnection()
+    {
+        disconnect();
+    }
+
+    void CobraConnection::setTrafficTrackerCallback(const TrafficTrackerCallback& callback)
+    {
+        _trafficTrackerCallback = callback;
+    }
+
+    void CobraConnection::resetTrafficTrackerCallback()
+    {
+        setTrafficTrackerCallback(nullptr);
+    }
+
+    void CobraConnection::invokeTrafficTrackerCallback(size_t size, bool incoming)
+    {
+        if (_trafficTrackerCallback)
+        {
+            _trafficTrackerCallback(size, incoming);
+        }
+    }
+
+    void CobraConnection::setEventCallback(const EventCallback& eventCallback)
+    {
+        std::lock_guard<std::mutex> lock(_eventCallbackMutex);
+        _eventCallback = eventCallback;
+    }
+
+    void CobraConnection::invokeEventCallback(ix::CobraConnectionEventType eventType,
+                                               const std::string& errorMsg,
+                                               const WebSocketHttpHeaders& headers)
+    {
+        std::lock_guard<std::mutex> lock(_eventCallbackMutex);
+        if (_eventCallback)
+        {
+            _eventCallback(eventType, errorMsg, headers);
+        }
+    }
+
+    void CobraConnection::invokeErrorCallback(const std::string& errorMsg)
+    {
+        invokeEventCallback(ix::CobraConnection_EventType_Error, errorMsg);
+    }
+
+    void CobraConnection::disconnect()
+    {
+        _authenticated = false;
+        _webSocket.stop();
+    }
+
+    void CobraConnection::initWebSocketOnMessageCallback()
+    {
+        _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(wireSize, true);
+
+                std::stringstream ss;
+                if (messageType == ix::WebSocket_MessageType_Open)
+                {
+                    invokeEventCallback(ix::CobraConnection_EventType_Open,
+                                        std::string(),
+                                        headers);
+                    sendHandshakeMessage();
+                }
+                else if (messageType == ix::WebSocket_MessageType_Close)
+                {
+                    _authenticated = false;
+
+                    std::stringstream ss;
+                    ss << "Close code " << closeInfo.code;
+                    ss << " reason " << closeInfo.reason;
+                    invokeEventCallback(ix::CobraConnection_EventType_Closed,
+                                        ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Message)
+                {
+                    Json::Value data;
+                    Json::Reader reader;
+                    if (!reader.parse(str, data))
+                    {
+                        invokeErrorCallback(std::string("Invalid json: ") + str);
+                        return;
+                    }
+
+                    if (!data.isMember("action"))
+                    {
+                        invokeErrorCallback("Missing action");
+                        return;
+                    }
+
+                    auto action = data["action"].asString();
+
+                    if (action == "auth/handshake/ok")
+                    {
+                        if (!handleHandshakeResponse(data))
+                        {
+                            invokeErrorCallback("Error extracting nonce from handshake response");
+                        }
+                    }
+                    else if (action == "auth/handshake/error")
+                    {
+                        invokeErrorCallback("Handshake error."); // print full message ?
+                    }
+                    else if (action == "auth/authenticate/ok")
+                    {
+                        _authenticated = true;
+                        invokeEventCallback(ix::CobraConnection_EventType_Authenticated);
+                        flushQueue();
+                    }
+                    else if (action == "auth/authenticate/error")
+                    {
+                        invokeErrorCallback("Authentication error."); // print full message ?
+                    }
+                    else if (action == "rtm/subscription/data")
+                    {
+                        handleSubscriptionData(data);
+                    }
+                    else
+                    {
+                        invokeErrorCallback(std::string("Un-handled message type: ") + action);
+                    }
+                }
+                else if (messageType == ix::WebSocket_MessageType_Error)
+                {
+                    std::stringstream ss;
+                    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());
+                }
+        });
+    }
+
+    void CobraConnection::setPublishMode(CobraConnectionPublishMode publishMode)
+    {
+        _publishMode = publishMode;
+    }
+
+    void CobraConnection::configure(const std::string& appkey,
+                                     const std::string& endpoint,
+                                     const std::string& rolename,
+                                     const std::string& rolesecret,
+                                     WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions)
+    {
+        _appkey = appkey;
+        _endpoint = endpoint;
+        _role_name = rolename;
+        _role_secret = rolesecret;
+
+        std::stringstream ss;
+        ss << _endpoint;
+        ss << "/v2?appkey=";
+        ss << _appkey;
+
+        std::string url = ss.str();
+        _webSocket.setUrl(url);
+        _webSocket.setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
+    }
+
+    //
+    // Handshake message schema.
+    //
+    // handshake = {
+    //     "action": "auth/handshake",
+    //     "body": {
+    //         "data": {
+    //             "role": role
+    //         },
+    //         "method": "role_secret"
+    //     },
+    // }
+    //
+    //
+    bool CobraConnection::sendHandshakeMessage()
+    {
+        Json::Value data;
+        data["role"] = _role_name;
+
+        Json::Value body;
+        body["data"] = data;
+        body["method"] = "role_secret";
+
+        Json::Value pdu;
+        pdu["action"] = "auth/handshake";
+        pdu["body"] = body;
+
+        std::string serializedJson = serializeJson(pdu);
+        CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
+
+        return _webSocket.send(serializedJson).success;
+    }
+
+    // 
+    // Extract the nonce from the handshake response
+    // use it to compute a hash during authentication
+    //
+    // {
+    //     "action": "auth/handshake/ok",
+    //     "body": {
+    //         "data": {
+    //             "nonce": "MTI0Njg4NTAyMjYxMzgxMzgzMg==",
+    //             "version": "0.0.24"
+    //         }
+    //     }
+    // }
+    //
+    bool CobraConnection::handleHandshakeResponse(const Json::Value& pdu)
+    {
+        if (!pdu.isMember("body")) return false;
+        Json::Value body = pdu["body"];
+
+        if (!body.isMember("data")) return false;
+        Json::Value data = body["data"];
+
+        if (!data.isMember("nonce")) return false;
+        Json::Value nonce = data["nonce"];
+
+        if (!nonce.isString()) return false;
+
+        return sendAuthMessage(nonce.asString());
+    }
+
+    //
+    // Authenticate message schema.
+    //
+    // challenge = {
+    //     "action": "auth/authenticate",
+    //     "body": {
+    //         "method": "role_secret",
+    //         "credentials": {
+    //             "hash": computeHash(secret, nonce)
+    //         }
+    //     },
+    // }
+    //
+    bool CobraConnection::sendAuthMessage(const std::string& nonce)
+    {
+        Json::Value credentials;
+        credentials["hash"] = hmac(nonce, _role_secret);
+
+        Json::Value body;
+        body["credentials"] = credentials;
+        body["method"] = "role_secret";
+
+        Json::Value pdu;
+        pdu["action"] = "auth/authenticate";
+        pdu["body"] = body;
+
+        std::string serializedJson = serializeJson(pdu);
+        CobraConnection::invokeTrafficTrackerCallback(serializedJson.size(), false);
+
+        return _webSocket.send(serializedJson).success;
+    }
+
+
+    bool CobraConnection::handleSubscriptionData(const Json::Value& pdu)
+    {
+        if (!pdu.isMember("body")) return false;
+        Json::Value body = pdu["body"];
+
+        // 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"];
+
+        std::lock_guard<std::mutex> lock(_cbsMutex);
+        auto cb = _cbs.find(subscriptionId.asString());
+        if (cb == _cbs.end()) return false; // cannot find callback
+
+        // Extract messages now
+        if (!body.isMember("messages")) return false;
+        Json::Value messages = body["messages"];
+
+        for (auto&& msg : messages)
+        {
+            cb->second(msg);
+        }
+
+        return true;
+    }
+
+    bool CobraConnection::connect()
+    {
+        _webSocket.start();
+        return true;
+    }
+
+    bool CobraConnection::isConnected() const
+    {
+        return _webSocket.getReadyState() == ix::WebSocket_ReadyState_Open;
+    }
+
+    std::string CobraConnection::serializeJson(const Json::Value& value)
+    {
+        std::lock_guard<std::mutex> lock(_jsonWriterMutex);
+        return _jsonWriter.write(value);
+    }
+
+    //
+    // publish is not thread safe as we are trying to reuse some Json objects.
+    //
+    bool CobraConnection::publish(const Json::Value& channels,
+                                   const Json::Value& msg)
+    {
+        _body["channels"] = channels;
+        _body["message"] = msg;
+        _pdu["body"] = _body;
+
+        std::string serializedJson = serializeJson(_pdu);
+
+        if (_publishMode == CobraConnection_PublishMode_Batch)
+        {
+            enqueue(serializedJson);
+            return true;
+        }
+
+        //
+        // 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,
+                                     SubscriptionCallback cb)
+    {
+        // Create and send a subscribe pdu
+        Json::Value body;
+        body["channel"] = channel;
+
+        Json::Value pdu;
+        pdu["action"] = "rtm/subscribe";
+        pdu["body"] = body;
+
+        _webSocket.send(pdu.toStyledString());
+
+        // Set the callback
+        std::lock_guard<std::mutex> lock(_cbsMutex);
+        _cbs[channel] = cb;
+    }
+
+    void CobraConnection::unsubscribe(const std::string& channel)
+    {
+        {
+            std::lock_guard<std::mutex> lock(_cbsMutex);
+            auto cb = _cbs.find(channel);
+            if (cb == _cbs.end()) return;
+
+            _cbs.erase(cb);
+        }
+
+        // Create and send an unsubscribe pdu
+        Json::Value body;
+        body["channel"] = channel;
+
+        Json::Value pdu;
+        pdu["action"] = "rtm/unsubscribe";
+        pdu["body"] = body;
+
+        _webSocket.send(pdu.toStyledString());
+    }
+
+    //
+    // Enqueue strategy drops old messages when we are at full capacity
+    //
+    // If we want to keep only 3 items max in the queue:
+    //
+    // enqueue(A) -> [A]
+    // enqueue(B) -> [B, A]
+    // enqueue(C) -> [C, B, A]
+    // enqueue(D) -> [D, C, B] -- now we drop A, the oldest message,
+    //                         -- and keep the 'fresh ones'
+    //
+    void CobraConnection::enqueue(const std::string& msg)
+    {
+        std::lock_guard<std::mutex> lock(_queueMutex);
+
+        if (_messageQueue.size() == CobraConnection::kQueueMaxSize)
+        {
+            _messageQueue.pop_back();
+        }
+        _messageQueue.push_front(msg);
+    }
+
+    //
+    // We process messages back (oldest) to front (newest) to respect ordering
+    // when sending them. If we fail to send something, we put it back in the queue
+    // at the end we picked it up originally (at the end).
+    //
+    bool CobraConnection::flushQueue()
+    {
+        std::lock_guard<std::mutex> lock(_queueMutex);
+
+        while (!_messageQueue.empty())
+        {
+            auto&& msg = _messageQueue.back();
+            if (!publishMessage(msg))
+            {
+                _messageQueue.push_back(msg);
+                return false;
+            }
+            _messageQueue.pop_back();
+        }
+
+        return true;
+    }
+
+    bool CobraConnection::publishMessage(const std::string& serializedJson)
+    {
+        auto webSocketSendInfo = _webSocket.send(serializedJson);
+        CobraConnection::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize,
+                                                       false);
+        return webSocketSendInfo.success;
+    }
+
+    void CobraConnection::suspend()
+    {
+        disconnect();
+    }
+
+    void CobraConnection::resume()
+    {
+        connect();
+    }
+    
+} // namespace ix

examples/cobra_publisher/IXCobraConnection.h

@@ -6,32 +6,24 @@
 
 #pragma once
 
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <ixwebsocket/IXWebSocketPerMessageDeflateOptions.h>
-#include <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;
-    struct SocketTLSOptions;
-
     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_Pong = 7
+        CobraConnection_EventType_Closed = 3
     };
 
     enum CobraConnectionPublishMode
@@ -43,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();
 
@@ -64,21 +50,13 @@ namespace ix
                        const std::string& endpoint,
                        const std::string& rolename,
                        const std::string& rolesecret,
-                       const WebSocketPerMessageDeflateOptions& webSocketPerMessageDeflateOptions,
-                       const SocketTLSOptions& socketTLSOptions);
+                       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);
 
@@ -88,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);
@@ -107,44 +84,22 @@ 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();
 
         /// Set the publish mode
         void setPublishMode(CobraConnectionPublishMode publishMode);
 
-        /// Query the publish mode
-        CobraConnectionPublishMode getPublishMode();
-
         /// Lifecycle management. Free resources when backgrounding
         void suspend();
         void resume();
 
-        /// Prepare a message for transmission
-        /// (update the pdu, compute a msgId, serialize json to a string)
-        std::pair<CobraConnection::MsgId, std::string> prePublish(
-            const Json::Value& channels,
-            const Json::Value& msg,
-            bool addToQueue);
-
-        /// Attempt to send next message from the internal queue
-        bool publishNext();
-
-        // An invalid message id, signifying an error.
-        static constexpr MsgId kInvalidMsgId = 0;
-
     private:
         bool sendHandshakeMessage();
         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();
 
@@ -155,28 +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);
-
-        /// Tells whether the internal queue is empty or not
-        bool isQueueEmpty();
+                                 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
@@ -187,14 +136,10 @@ namespace ix
         Json::Value _pdu;
         Json::FastWriter _jsonWriter;
         mutable std::mutex _jsonWriterMutex;
-        std::mutex _prePublishMutex;
 
         /// Traffic tracker callback
         static TrafficTrackerCallback _trafficTrackerCallback;
 
-        /// Publish tracker callback
-        static PublishTrackerCallback _publishTrackerCallback;
-
         /// Cobra events callbacks
         EventCallback _eventCallback;
         mutable std::mutex _eventCallbackMutex;
@@ -203,22 +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;
-
-        // Frequency at which we send a websocket ping to the backing cobra connection
-        static constexpr int kPingIntervalSecs = 30;
     };
-
+    
 } // 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,55 +1,49 @@
 /*
  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)
-    {
-        const char* bytes_to_encode = data.c_str();
-        return base64_encode(bytes_to_encode, len);
-    }
-
-    std::string base64_encode(const char* bytes_to_encode, size_t len)
     {
         std::string ret;
-        ret.reserve(((len + 2) / 3) * 4);
-
         int i = 0;
         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++);
@@ -59,84 +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;
-        ret.reserve(((in_len + 3) / 4) * 3);
-
-        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,6 +11,4 @@
 namespace ix
 {
     std::string base64_encode(const std::string& data, size_t len);
-    std::string base64_encode(const char* 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

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

@@ -0,0 +1,171 @@
+/*
+ *  ping_pong.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 WebSocketPingPong
+    {
+        public:
+            WebSocketPingPong(const std::string& _url);
+
+            void subscribe(const std::string& channel);
+            void start();
+            void stop();
+
+            void ping(const std::string& text);
+            void send(const std::string& text);
+
+        private:
+            std::string _url;
+            ix::WebSocket _webSocket;
+    };
+
+    WebSocketPingPong::WebSocketPingPong(const std::string& url) :
+        _url(url)
+    {
+        ;
+    }
+
+    void WebSocketPingPong::stop()
+    {
+        _webSocket.stop();
+    }
+
+    void WebSocketPingPong::start()
+    {
+        _webSocket.setUrl(_url);
+
+        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("ping_pong: connected");
+                }
+                else if (messageType == ix::WebSocket_MessageType_Close)
+                {
+                    ss << "ping_pong: disconnected:"
+                       << " code " << closeInfo.code
+                       << " reason " << closeInfo.reason
+                       << str;
+                    log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Message)
+                {
+                    ss << "ping_pong: received message: "
+                       << str;
+                    log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Ping)
+                {
+                    ss << "ping_pong: received ping message: "
+                       << str;
+                    log(ss.str());
+                }
+                else if (messageType == ix::WebSocket_MessageType_Pong)
+                {
+                    ss << "ping_pong: received pong 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 WebSocketPingPong::ping(const std::string& text)
+    {
+        if (!_webSocket.ping(text).success)
+        {
+            std::cerr << "Failed to send ping message. Message too long (> 125 bytes) or endpoint is disconnected"
+                      << std::endl;
+        }
+    }
+
+    void WebSocketPingPong::send(const std::string& text)
+    {
+        _webSocket.send(text);
+    }
+
+    void interactiveMain(const std::string& url)
+    {
+        std::cout << "Type Ctrl-D to exit prompt..." << std::endl;
+        WebSocketPingPong webSocketPingPong(url);
+        webSocketPingPong.start();
+
+        while (true)
+        {
+            std::string text;
+            std::cout << "> " << std::flush;
+            std::getline(std::cin, text);
+
+            if (!std::cin)
+            {
+                break;
+            }
+
+            if (text == "/close")
+            {
+                webSocketPingPong.send(text);
+            }
+            else
+            {
+                webSocketPingPong.ping(text);
+            }
+        }
+
+        std::cout << std::endl;
+        webSocketPingPong.stop();
+    }
+}
+
+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,35 +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}
-)
-
-find_package(JsonCpp)
-if (NOT JSONCPP_FOUND)
-  set(JSONCPP_INCLUDE_DIRS ../third_party/jsoncpp)
-endif()
-
-set(IXCOBRA_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ../ixcrypto
-    ${JSONCPP_INCLUDE_DIRS})
-
-target_include_directories( ixcobra PUBLIC ${IXCOBRA_INCLUDE_DIRS} )

ixcobra/ixcobra/IXCobraConnection.cpp

@@ -1,654 +0,0 @@
-/*
- *  IXCobraConnection.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2018 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraConnection.h"
-#include <ixcrypto/IXHMac.h>
-#include <ixwebsocket/IXWebSocket.h>
-#include <ixwebsocket/IXSocketTLSOptions.h>
-
-#include <algorithm>
-#include <stdexcept>
-#include <cmath>
-#include <cassert>
-#include <cstring>
-#include <iostream>
-#include <sstream>
-
-
-namespace ix
-{
-    TrafficTrackerCallback CobraConnection::_trafficTrackerCallback = nullptr;
-    PublishTrackerCallback CobraConnection::_publishTrackerCallback = nullptr;
-    constexpr size_t CobraConnection::kQueueMaxSize;
-    constexpr CobraConnection::MsgId CobraConnection::kInvalidMsgId;
-    constexpr int CobraConnection::kPingIntervalSecs;
-
-    CobraConnection::CobraConnection() :
-        _webSocket(new WebSocket()),
-        _publishMode(CobraConnection_PublishMode_Immediate),
-        _authenticated(false),
-        _eventCallback(nullptr),
-        _id(1)
-    {
-        _pdu["action"] = "rtm/publish";
-
-        _webSocket->addSubProtocol("json");
-        initWebSocketOnMessageCallback();
-    }
-
-    CobraConnection::~CobraConnection()
-    {
-        disconnect();
-        setEventCallback(nullptr);
-    }
-
-    void CobraConnection::setTrafficTrackerCallback(const TrafficTrackerCallback& callback)
-    {
-        _trafficTrackerCallback = callback;
-    }
-
-    void CobraConnection::resetTrafficTrackerCallback()
-    {
-        setTrafficTrackerCallback(nullptr);
-    }
-
-    void CobraConnection::invokeTrafficTrackerCallback(size_t size, bool incoming)
-    {
-        if (_trafficTrackerCallback)
-        {
-            _trafficTrackerCallback(size, incoming);
-        }
-    }
-
-    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);
-        _eventCallback = eventCallback;
-    }
-
-    void CobraConnection::invokeEventCallback(ix::CobraConnectionEventType eventType,
-                                              const std::string& errorMsg,
-                                              const WebSocketHttpHeaders& headers,
-                                              const std::string& subscriptionId,
-                                              CobraConnection::MsgId msgId)
-    {
-        std::lock_guard<std::mutex> lock(_eventCallbackMutex);
-        if (_eventCallback)
-        {
-            _eventCallback(eventType, errorMsg, headers, subscriptionId, msgId);
-        }
-    }
-
-    void CobraConnection::invokeErrorCallback(const std::string& errorMsg,
-                                              const std::string& serializedPdu)
-    {
-        std::stringstream ss;
-        ss << errorMsg << " : received pdu => " << serializedPdu;
-        invokeEventCallback(ix::CobraConnection_EventType_Error, ss.str());
-    }
-
-    void CobraConnection::disconnect()
-    {
-        _authenticated = false;
-        _webSocket->stop();
-    }
-
-    void CobraConnection::initWebSocketOnMessageCallback()
-    {
-        _webSocket->setOnMessageCallback(
-            [this](const ix::WebSocketMessagePtr& msg)
-            {
-                CobraConnection::invokeTrafficTrackerCallback(msg->wireSize, true);
-
-                std::stringstream ss;
-                if (msg->type == ix::WebSocketMessageType::Open)
-                {
-                    invokeEventCallback(ix::CobraConnection_EventType_Open,
-                                        std::string(),
-                                        msg->openInfo.headers);
-                    sendHandshakeMessage();
-                }
-                else if (msg->type == ix::WebSocketMessageType::Close)
-                {
-                    _authenticated = false;
-
-                    std::stringstream ss;
-                    ss << "Close code " << msg->closeInfo.code;
-                    ss << " reason " << msg->closeInfo.reason;
-                    invokeEventCallback(ix::CobraConnection_EventType_Closed,
-                                        ss.str());
-                }
-                else if (msg->type == ix::WebSocketMessageType::Message)
-                {
-                    Json::Value data;
-                    Json::Reader reader;
-                    if (!reader.parse(msg->str, data))
-                    {
-                        invokeErrorCallback("Invalid json", msg->str);
-                        return;
-                    }
-
-                    if (!data.isMember("action"))
-                    {
-                        invokeErrorCallback("Missing action", msg->str);
-                        return;
-                    }
-
-                    auto action = data["action"].asString();
-
-                    if (action == "auth/handshake/ok")
-                    {
-                        if (!handleHandshakeResponse(data))
-                        {
-                            invokeErrorCallback("Error extracting nonce from handshake response", msg->str);
-                        }
-                    }
-                    else if (action == "auth/handshake/error")
-                    {
-                        invokeErrorCallback("Handshake error", msg->str);
-                    }
-                    else if (action == "auth/authenticate/ok")
-                    {
-                        _authenticated = true;
-                        invokeEventCallback(ix::CobraConnection_EventType_Authenticated);
-                        flushQueue();
-                    }
-                    else if (action == "auth/authenticate/error")
-                    {
-                        invokeErrorCallback("Authentication error", msg->str);
-                    }
-                    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);
-                    }
-                }
-                else if (msg->type == ix::WebSocketMessageType::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());
-                }
-                else if (msg->type == ix::WebSocketMessageType::Pong)
-                {
-                    invokeEventCallback(ix::CobraConnection_EventType_Pong);
-                }
-        });
-    }
-
-    void CobraConnection::setPublishMode(CobraConnectionPublishMode publishMode)
-    {
-        _publishMode = publishMode;
-    }
-
-    CobraConnectionPublishMode CobraConnection::getPublishMode()
-    {
-        return _publishMode;
-    }
-
-    void CobraConnection::configure(const std::string& appkey,
-                                    const std::string& endpoint,
-                                    const std::string& rolename,
-                                    const std::string& rolesecret,
-                                    const WebSocketPerMessageDeflateOptions& webSocketPerMessageDeflateOptions,
-                                    const SocketTLSOptions& socketTLSOptions)
-    {
-        _roleName = rolename;
-        _roleSecret = rolesecret;
-
-        std::stringstream ss;
-        ss << endpoint;
-        ss << "/v2?appkey=";
-        ss << appkey;
-
-        std::string url = ss.str();
-        _webSocket->setUrl(url);
-        _webSocket->setPerMessageDeflateOptions(webSocketPerMessageDeflateOptions);
-        _webSocket->setTLSOptions(socketTLSOptions);
-        _webSocket->setPingInterval(kPingIntervalSecs);
-    }
-
-    //
-    // Handshake message schema.
-    //
-    // handshake = {
-    //     "action": "auth/handshake",
-    //     "body": {
-    //         "data": {
-    //             "role": role
-    //         },
-    //         "method": "role_secret"
-    //     },
-    // }
-    //
-    //
-    bool CobraConnection::sendHandshakeMessage()
-    {
-        Json::Value data;
-        data["role"] = _roleName;
-
-        Json::Value body;
-        body["data"] = data;
-        body["method"] = "role_secret";
-
-        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;
-    }
-
-    //
-    // Extract the nonce from the handshake response
-    // use it to compute a hash during authentication
-    //
-    // {
-    //     "action": "auth/handshake/ok",
-    //     "body": {
-    //         "data": {
-    //             "nonce": "MTI0Njg4NTAyMjYxMzgxMzgzMg==",
-    //             "version": "0.0.24"
-    //         }
-    //     }
-    // }
-    //
-    bool CobraConnection::handleHandshakeResponse(const Json::Value& pdu)
-    {
-        if (!pdu.isObject()) return false;
-
-        if (!pdu.isMember("body")) return false;
-        Json::Value body = pdu["body"];
-
-        if (!body.isMember("data")) return false;
-        Json::Value data = body["data"];
-
-        if (!data.isMember("nonce")) return false;
-        Json::Value nonce = data["nonce"];
-
-        if (!nonce.isString()) return false;
-
-        return sendAuthMessage(nonce.asString());
-    }
-
-    //
-    // Authenticate message schema.
-    //
-    // challenge = {
-    //     "action": "auth/authenticate",
-    //     "body": {
-    //         "method": "role_secret",
-    //         "credentials": {
-    //             "hash": computeHash(secret, nonce)
-    //         }
-    //     },
-    // }
-    //
-    bool CobraConnection::sendAuthMessage(const std::string& nonce)
-    {
-        Json::Value credentials;
-        credentials["hash"] = hmac(nonce, _roleSecret);
-
-        Json::Value body;
-        body["credentials"] = credentials;
-        body["method"] = "role_secret";
-
-        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;
-    }
-
-    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
-        // which callback to execute
-        if (!body.isMember("subscription_id")) return false;
-        Json::Value subscriptionId = body["subscription_id"];
-
-        std::lock_guard<std::mutex> lock(_cbsMutex);
-        auto cb = _cbs.find(subscriptionId.asString());
-        if (cb == _cbs.end()) return false; // cannot find callback
-
-        // Extract messages now
-        if (!body.isMember("messages")) return false;
-        Json::Value messages = body["messages"];
-
-        for (auto&& msg : messages)
-        {
-            cb->second(msg);
-        }
-
-        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();
-        return true;
-    }
-
-    bool CobraConnection::isConnected() const
-    {
-        return _webSocket->getReadyState() == ix::ReadyState::Open;
-    }
-
-    bool CobraConnection::isAuthenticated() const
-    {
-        return isConnected() && _authenticated;
-    }
-
-    std::string CobraConnection::serializeJson(const Json::Value& value)
-    {
-        std::lock_guard<std::mutex> lock(_jsonWriterMutex);
-        return _jsonWriter.write(value);
-    }
-
-    std::pair<CobraConnection::MsgId, std::string> CobraConnection::prePublish(
-        const Json::Value& channels,
-        const Json::Value& msg,
-        bool addToQueue)
-    {
-        std::lock_guard<std::mutex> lock(_prePublishMutex);
-
-        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);
-
-        if (addToQueue)
-        {
-            enqueue(serializedJson);
-        }
-
-        return std::make_pair(msgId, serializedJson);
-    }
-
-    bool CobraConnection::publishNext()
-    {
-        std::lock_guard<std::mutex> lock(_queueMutex);
-
-        if (_messageQueue.empty()) return true;
-
-        auto&& msg = _messageQueue.back();
-        if (!publishMessage(msg))
-        {
-            return false;
-        }
-        _messageQueue.pop_back();
-        return true;
-    }
-
-    //
-    // 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)
-    {
-        auto p = prePublish(channels, msg, false);
-        auto msgId = p.first;
-        auto serializedJson = p.second;
-
-        //
-        // 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))
-        {
-            enqueue(serializedJson);
-        }
-
-        return msgId;
-    }
-
-    void CobraConnection::subscribe(const std::string& channel,
-                                    const std::string& filter,
-                                    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());
-
-        // Set the callback
-        std::lock_guard<std::mutex> lock(_cbsMutex);
-        _cbs[channel] = cb;
-    }
-
-    void CobraConnection::unsubscribe(const std::string& channel)
-    {
-        {
-            std::lock_guard<std::mutex> lock(_cbsMutex);
-            auto cb = _cbs.find(channel);
-            if (cb == _cbs.end()) return;
-
-            _cbs.erase(cb);
-        }
-
-        // Create and send an unsubscribe pdu
-        Json::Value body;
-        body["subscription_id"] = channel;
-
-        Json::Value pdu;
-        pdu["action"] = "rtm/unsubscribe";
-        pdu["body"] = body;
-        pdu["id"] = Json::UInt64(_id++);
-
-        _webSocket->send(pdu.toStyledString());
-    }
-
-    //
-    // Enqueue strategy drops old messages when we are at full capacity
-    //
-    // If we want to keep only 3 items max in the queue:
-    //
-    // enqueue(A) -> [A]
-    // enqueue(B) -> [B, A]
-    // enqueue(C) -> [C, B, A]
-    // enqueue(D) -> [D, C, B] -- now we drop A, the oldest message,
-    //                         -- and keep the 'fresh ones'
-    //
-    void CobraConnection::enqueue(const std::string& msg)
-    {
-        std::lock_guard<std::mutex> lock(_queueMutex);
-
-        if (_messageQueue.size() == CobraConnection::kQueueMaxSize)
-        {
-            _messageQueue.pop_back();
-        }
-        _messageQueue.push_front(msg);
-    }
-
-    //
-    // We process messages back (oldest) to front (newest) to respect ordering
-    // when sending them. If we fail to send something, we put it back in the queue
-    // at the end we picked it up originally (at the end).
-    //
-    bool CobraConnection::flushQueue()
-    {
-        while (!isQueueEmpty())
-        {
-            bool ok = publishNext();
-            if (!ok) return false;
-        }
-
-        return true;
-    }
-
-    bool CobraConnection::isQueueEmpty()
-    {
-        std::lock_guard<std::mutex> lock(_queueMutex);
-        return _messageQueue.empty();
-    }
-
-    bool CobraConnection::publishMessage(const std::string& serializedJson)
-    {
-        auto webSocketSendInfo = _webSocket->send(serializedJson);
-        CobraConnection::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize,
-                                                      false);
-        return webSocketSendInfo.success;
-    }
-
-    void CobraConnection::suspend()
-    {
-        disconnect();
-    }
-
-    void CobraConnection::resume()
-    {
-        connect();
-    }
-
-} // namespace ix

ixcobra/ixcobra/IXCobraMetricsPublisher.cpp

@@ -1,244 +0,0 @@
-/*
- *  IXCobraMetricsPublisher.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraMetricsPublisher.h"
-#include <ixwebsocket/IXSocketTLSOptions.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,
-                                          const SocketTLSOptions& socketTLSOptions)
-    {
-        // 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, socketTLSOptions);
-    }
-
-    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;
-    }
-
-    CobraConnection::MsgId CobraMetricsPublisher::push(const std::string& id,
-                                                       const std::string& data,
-                                                       bool shouldPushTest)
-    {
-        if (!_enabled) return CobraConnection::kInvalidMsgId;
-
-        Json::Value root;
-        Json::Reader reader;
-        if (!reader.parse(data, root)) return CobraConnection::kInvalidMsgId;
-
-        return push(id, root, shouldPushTest);
-    }
-
-    CobraConnection::MsgId CobraMetricsPublisher::push(const std::string& id,
-                                                       const CobraMetricsPublisher::Message& data)
-    {
-        if (!_enabled) return CobraConnection::kInvalidMsgId;
-
-        Json::Value root;
-        for (auto it : data)
-        {
-            root[it.first] = it.second;
-        }
-
-        return 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;
-    }
-
-    CobraConnection::MsgId CobraMetricsPublisher::push(
-        const std::string& id,
-        const Json::Value& data,
-        bool shouldPushTest)
-    {
-        if (shouldPushTest && !shouldPush(id)) return CobraConnection::kInvalidMsgId;
-
-        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
-        return _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,171 +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 <json/json.h>
-#include <string>
-#include <unordered_map>
-
-namespace ix
-{
-    struct SocketTLSOptions;
-
-    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,
-                       const SocketTLSOptions& socketTLSOptions);
-
-        /// 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;
-        CobraConnection::MsgId 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.
-        CobraConnection::MsgId push(const std::string& id, const Json::Value& data, bool shouldPushTest = true);
-
-        /// Interface used by lua. msg is a json encoded string.
-        CobraConnection::MsgId 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,231 +0,0 @@
-/*
- *  IXCobraMetricsThreadedPublisher.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2017 Machine Zone. All rights reserved.
- */
-
-#include "IXCobraMetricsThreadedPublisher.h"
-#include <ixwebsocket/IXSetThreadName.h>
-#include <ixwebsocket/IXSocketTLSOptions.h>
-#include <ixcore/utils/IXCoreLogger.h>
-
-#include <algorithm>
-#include <stdexcept>
-#include <cmath>
-#include <cassert>
-#include <iostream>
-#include <sstream>
-
-
-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";
-                }
-                else if (eventType == ix::CobraConnection_EventType_Pong)
-                {
-                    ss << "Received websocket pong";
-                }
-
-                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,
-                                                  const SocketTLSOptions& socketTLSOptions)
-    {
-        _channel = channel;
-
-        ix::IXCoreLogger::Log(socketTLSOptions.getDescription().c_str());
-
-        ix::WebSocketPerMessageDeflateOptions webSocketPerMessageDeflateOptions(enablePerMessageDeflate);
-        _cobra_connection.configure(appkey, endpoint,
-                                    rolename, rolesecret,
-                                    webSocketPerMessageDeflateOptions, socketTLSOptions);
-    }
-
-    void CobraMetricsThreadedPublisher::pushMessage(MessageKind messageKind)
-    {
-        {
-            std::unique_lock<std::mutex> lock(_queue_mutex);
-            _queue.push(messageKind);
-        }
-
-        // 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");
-
-        _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;
-                }
-
-                messageKind = _queue.front();
-                _queue.pop();
-            }
-
-            switch (messageKind)
-            {
-                case MessageKind::Suspend:
-                {
-                    _cobra_connection.suspend();
-                    continue;
-                }; break;
-
-                case MessageKind::Resume:
-                {
-                    _cobra_connection.resume();
-                    continue;
-                }; break;
-
-                case MessageKind::Message:
-                {
-                    if (_cobra_connection.getPublishMode() == CobraConnection_PublishMode_Immediate)
-                    {
-                        _cobra_connection.publishNext();
-                    }
-                }; break;
-            }
-        }
-    }
-
-    CobraConnection::MsgId CobraMetricsThreadedPublisher::push(const Json::Value& msg)
-    {
-        static const std::string messageIdKey("id");
-
-        //
-        // 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.
-        //
-        Json::Value channels;
-
-        channels.append(_channel);
-        if (msg.isMember(messageIdKey))
-        {
-            channels.append(msg[messageIdKey]);
-        }
-        auto res = _cobra_connection.prePublish(channels, msg, true);
-        auto msgId = res.first;
-
-        pushMessage(MessageKind::Message);
-
-        return msgId;
-    }
-
-    void CobraMetricsThreadedPublisher::suspend()
-    {
-        pushMessage(MessageKind::Suspend);
-    }
-
-    void CobraMetricsThreadedPublisher::resume()
-    {
-        pushMessage(MessageKind::Resume);
-    }
-
-    bool CobraMetricsThreadedPublisher::isConnected() const
-    {
-        return _cobra_connection.isConnected();
-    }
-
-    bool CobraMetricsThreadedPublisher::isAuthenticated() const
-    {
-        return _cobra_connection.isAuthenticated();
-    }
-
-} // namespace ix

ixcobra/ixcobra/IXCobraMetricsThreadedPublisher.h

@@ -1,107 +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 <json/json.h>
-#include <map>
-#include <mutex>
-#include <queue>
-#include <string>
-#include <thread>
-
-namespace ix
-{
-    struct SocketTLSOptions;
-
-    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,
-                       const SocketTLSOptions& socketTLSOptions);
-
-        /// 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
-        CobraConnection::MsgId 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);
-
-        /// 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<MessageKind> _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

ixsentry/CMakeLists.txt

@@ -1,30 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXSENTRY_SOURCES
-    ixsentry/IXSentryClient.cpp
-)
-
-set (IXSENTRY_HEADERS
-    ixsentry/IXSentryClient.h
-)
-
-add_library(ixsentry STATIC
-  ${IXSENTRY_SOURCES}
-  ${IXSENTRY_HEADERS}
-)
-
-find_package(JsonCpp)
-if (NOT JSONCPP_FOUND)
-  set(JSONCPP_INCLUDE_DIRS ../third_party/jsoncpp)
-endif()
-
-set(IXSENTRY_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ${JSONCPP_INCLUDE_DIRS})
-
-target_include_directories( ixsentry PUBLIC ${IXSENTRY_INCLUDE_DIRS} )

ixsentry/ixsentry/IXSentryClient.cpp

@@ -1,273 +0,0 @@
-/*
- *  IXSentryClient.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-#include "IXSentryClient.h"
-
-#include <chrono>
-#include <iostream>
-#include <fstream>
-#include <sstream>
-#include <ixwebsocket/IXWebSocketHttpHeaders.h>
-#include <ixwebsocket/IXWebSocketVersion.h>
-#include <ixcore/utils/IXCoreLogger.h>
-
-
-namespace ix
-{
-    SentryClient::SentryClient(const std::string& dsn)
-        : _dsn(dsn)
-        , _validDsn(false)
-        , _luaFrameRegex("\t([^/]+):([0-9]+): in function ['<]([^/]+)['>]")
-        , _httpClient(std::make_shared<HttpClient>(true))
-    {
-        const std::regex dsnRegex("(http[s]?)://([^:]+):([^@]+)@([^/]+)/([0-9]+)");
-        std::smatch group;
-
-        if (std::regex_match(dsn, group, dsnRegex) && group.size() == 6)
-        {
-            _validDsn = true;
-
-            const auto scheme = group.str(1);
-            const auto host = group.str(4);
-            const auto project_id = group.str(5);
-            _url = scheme + "://" + host + "/api/" + project_id + "/store/";
-
-            _publicKey = group.str(2);
-            _secretKey = group.str(3);
-        }
-    }
-
-    int64_t SentryClient::getTimestamp()
-    {
-        const auto tp = std::chrono::system_clock::now();
-        const auto dur = tp.time_since_epoch();
-        return std::chrono::duration_cast<std::chrono::seconds>(dur).count();
-    }
-
-    std::string SentryClient::getIso8601()
-    {
-        std::time_t now;
-        std::time(&now);
-        char buf[sizeof("2011-10-08T07:07:09Z")];
-        std::strftime(buf, sizeof(buf), "%Y-%m-%dT%H:%M:%SZ", std::gmtime(&now));
-        return buf;
-    }
-
-    std::string SentryClient::computeAuthHeader()
-    {
-        std::string securityHeader("Sentry sentry_version=5");
-        securityHeader += ",sentry_client=ws/1.0.0";
-        securityHeader += ",sentry_timestamp=" + std::to_string(SentryClient::getTimestamp());
-        securityHeader += ",sentry_key=" + _publicKey;
-        securityHeader += ",sentry_secret=" + _secretKey;
-
-        return securityHeader;
-    }
-
-    Json::Value SentryClient::parseLuaStackTrace(const std::string& stack)
-    {
-        Json::Value frames;
-
-        // Split by lines
-        std::string line;
-        std::stringstream tokenStream(stack);
-
-        std::smatch group;
-
-        while (std::getline(tokenStream, line))
-        {
-            //	MapScene.lua:2169: in function 'singleCB'
-            if (std::regex_match(line, group, _luaFrameRegex))
-            {
-                const auto fileName = group.str(1);
-                const auto linenoStr = group.str(2);
-                const auto function = group.str(3);
-
-                std::stringstream ss;
-                ss << linenoStr;
-                uint64_t lineno;
-                ss >> lineno;
-
-                Json::Value frame;
-                frame["lineno"] = Json::UInt64(lineno);
-                frame["filename"] = fileName;
-                frame["function"] = function;
-
-                frames.append(frame);
-            }
-        }
-
-        std::reverse(frames.begin(), frames.end());
-
-        return frames;
-    }
-
-    std::string parseExceptionName(const std::string& stack)
-    {
-        // Split by lines
-        std::string line;
-        std::stringstream tokenStream(stack);
-
-        // Extract the first line
-        std::getline(tokenStream, line);
-
-        return line;
-    }
-
-    std::string SentryClient::computePayload(const Json::Value& msg)
-    {
-        Json::Value payload;
-
-        //
-        // "tags": [
-        //   [
-        //     "a",
-        //     "b"
-        //   ],
-        //  ]
-        //
-        Json::Value tags(Json::arrayValue);
-
-        payload["platform"] = "python";
-        payload["sdk"]["name"] = "ws";
-        payload["sdk"]["version"] = IX_WEBSOCKET_VERSION;
-        payload["timestamp"] = SentryClient::getIso8601();
-
-        bool isNoisyTypes = msg["id"].asString() == "game_noisytypes_id";
-
-        std::string stackTraceFieldName = isNoisyTypes ? "traceback" : "stack";
-        std::string stack;
-        std::string message;
-
-        if (isNoisyTypes)
-        {
-            stack = msg["data"][stackTraceFieldName].asString();
-            message = parseExceptionName(stack);
-        }
-        else // logging
-        {
-            if (msg["data"].isMember("info"))
-            {
-                stack = msg["data"]["info"][stackTraceFieldName].asString();
-                message = msg["data"]["info"]["message"].asString();
-
-                if (msg["data"].isMember("tags"))
-                {
-                    auto members = msg["data"]["tags"].getMemberNames();
-
-                    for (auto member : members)
-                    {
-                        Json::Value tag;
-                        tag.append(member);
-                        tag.append(msg["data"]["tags"][member]);
-                        tags.append(tag);
-                    }
-                }
-            }
-            else
-            {
-                stack = msg["data"][stackTraceFieldName].asString();
-                message = msg["data"]["message"].asString();
-            }
-        }
-
-        Json::Value exception;
-        exception["stacktrace"]["frames"] = parseLuaStackTrace(stack);
-        exception["value"] = message;
-
-        payload["exception"].append(exception);
-
-        Json::Value extra;
-        extra["cobra_event"] = msg;
-
-        // Builtin tags
-        Json::Value gameTag;
-        gameTag.append("game");
-        gameTag.append(msg["device"]["game"]);
-        tags.append(gameTag);
-
-        Json::Value userIdTag;
-        userIdTag.append("userid");
-        userIdTag.append(msg["device"]["user_id"]);
-        tags.append(userIdTag);
-
-        Json::Value environmentTag;
-        environmentTag.append("environment");
-        environmentTag.append(msg["device"]["environment"]);
-        tags.append(environmentTag);
-
-        Json::Value clientVersionTag;
-        clientVersionTag.append("client_version");
-        clientVersionTag.append(msg["device"]["app_version"]);
-        tags.append(clientVersionTag);
-
-        payload["tags"] = tags;
-
-        return _jsonWriter.write(payload);
-    }
-
-    std::pair<HttpResponsePtr, std::string> SentryClient::send(const Json::Value& msg, bool verbose)
-    {
-        auto args = _httpClient->createRequest();
-        args->extraHeaders["X-Sentry-Auth"] = SentryClient::computeAuthHeader();
-        args->connectTimeout = 60;
-        args->transferTimeout = 5 * 60;
-        args->followRedirects = true;
-        args->verbose = verbose;
-        args->logger = [](const std::string& msg) { ix::IXCoreLogger::Log(msg.c_str()); };
-
-        std::string body = computePayload(msg);
-        HttpResponsePtr response = _httpClient->post(_url, body, args);
-
-        return std::make_pair(response, body);
-    }
-
-    // https://sentry.io/api/12345/minidump?sentry_key=abcdefgh");
-    std::string SentryClient::computeUrl(const std::string& project, const std::string& key)
-    {
-        std::stringstream ss;
-        ss << "https://sentry.io/api/"
-           << project
-           << "/minidump?sentry_key="
-           << key;
-
-        return ss.str();
-    }
-
-    //
-    // curl -v -X POST -F upload_file_minidump=@ws/crash.dmp 'https://sentry.io/api/123456/minidump?sentry_key=12344567890'
-    //
-    void SentryClient::uploadMinidump(
-        const std::string& sentryMetadata,
-        const std::string& minidumpBytes,
-        const std::string& project,
-        const std::string& key,
-        bool verbose,
-        const OnResponseCallback& onResponseCallback)
-    {
-        std::string multipartBoundary = _httpClient->generateMultipartBoundary();
-
-        auto args = _httpClient->createRequest();
-        args->verb = HttpClient::kPost;
-        args->connectTimeout = 60;
-        args->transferTimeout = 5 * 60;
-        args->followRedirects = true;
-        args->verbose = verbose;
-        args->multipartBoundary = multipartBoundary;
-        args->logger = [](const std::string& msg) { ix::IXCoreLogger::Log(msg.c_str()); };
-
-        HttpFormDataParameters httpFormDataParameters;
-        httpFormDataParameters["upload_file_minidump"] = minidumpBytes;
-
-        HttpParameters httpParameters;
-        httpParameters["sentry"] = sentryMetadata;
-
-        args->url = computeUrl(project, key);
-        args->body = _httpClient->serializeHttpFormDataParameters(multipartBoundary, httpFormDataParameters, httpParameters);
-
-        _httpClient->performRequest(args, onResponseCallback);
-    }
-} // namespace ix

ixsentry/ixsentry/IXSentryClient.h

@@ -1,60 +0,0 @@
-/*
- *  IXSentryClient.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone. All rights reserved.
- */
-
-#pragma once
-
-#include <algorithm>
-#include <ixwebsocket/IXHttpClient.h>
-#include <json/json.h>
-#include <regex>
-#include <memory>
-
-namespace ix
-{
-    class SentryClient
-    {
-    public:
-        SentryClient(const std::string& dsn);
-        ~SentryClient() = default;
-
-        std::pair<HttpResponsePtr, std::string> send(const Json::Value& msg, bool verbose);
-
-        Json::Value parseLuaStackTrace(const std::string& stack);
-
-        void uploadMinidump(
-            const std::string& sentryMetadata,
-            const std::string& minidumpBytes,
-            const std::string& project,
-            const std::string& key,
-            bool verbose,
-            const OnResponseCallback& onResponseCallback);
-
-    private:
-        int64_t getTimestamp();
-        std::string computeAuthHeader();
-        std::string getIso8601();
-        std::string computePayload(const Json::Value& msg);
-
-        std::string computeUrl(const std::string& project, const std::string& key);
-
-        void displayReponse(HttpResponsePtr response);
-
-        std::string _dsn;
-        bool _validDsn;
-        std::string _url;
-
-        // Used for authentication with a header
-        std::string _publicKey;
-        std::string _secretKey;
-
-        Json::FastWriter _jsonWriter;
-
-        std::regex _luaFrameRegex;
-
-        std::shared_ptr<HttpClient> _httpClient;
-    };
-
-} // namespace ix

ixsnake/CMakeLists.txt

@@ -1,35 +0,0 @@
-#
-# Author: Benjamin Sergeant
-# Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
-#
-
-set (IXSNAKE_SOURCES
-    ixsnake/IXSnakeServer.cpp
-    ixsnake/IXSnakeProtocol.cpp
-    ixsnake/IXAppConfig.cpp
-    ixsnake/IXRedisClient.cpp
-    ixsnake/IXRedisServer.cpp
-)
-
-set (IXSNAKE_HEADERS
-    ixsnake/IXSnakeServer.h
-    ixsnake/IXSnakeProtocol.h
-    ixsnake/IXAppConfig.h
-    ixsnake/IXRedisClient.h
-    ixsnake/IXRedisServer.h
-)
-
-add_library(ixsnake STATIC
-    ${IXSNAKE_SOURCES}
-    ${IXSNAKE_HEADERS}
-)
-
-set(IXSNAKE_INCLUDE_DIRS
-    .
-    ..
-    ../ixcore
-    ../ixcrypto
-    ../ixwebsocket
-    ../third_party)
-
-target_include_directories( ixsnake PUBLIC ${IXSNAKE_INCLUDE_DIRS} )

ixsnake/ixsnake/IXAppConfig.cpp

@@ -1,48 +0,0 @@
-/*
- *  IXSnakeProtocol.cpp
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#include "IXAppConfig.h"
-
-#include "IXSnakeProtocol.h"
-#include <iostream>
-#include <ixcrypto/IXUuid.h>
-
-namespace snake
-{
-    bool isAppKeyValid(const AppConfig& appConfig, std::string appkey)
-    {
-        return appConfig.apps.count(appkey) != 0;
-    }
-
-    std::string getRoleSecret(const AppConfig& appConfig, std::string appkey, std::string role)
-    {
-        if (!isAppKeyValid(appConfig, appkey))
-        {
-            std::cerr << "Missing appkey " << appkey << std::endl;
-            return std::string();
-        }
-
-        auto roles = appConfig.apps[appkey]["roles"];
-        auto channel = roles[role]["secret"];
-        return channel;
-    }
-
-    std::string generateNonce()
-    {
-        return ix::uuid4();
-    }
-
-    void dumpConfig(const AppConfig& appConfig)
-    {
-        for (auto&& host : appConfig.redisHosts)
-        {
-            std::cout << "redis host: " << host << std::endl;
-        }
-
-        std::cout << "redis password: " << appConfig.redisPassword << std::endl;
-        std::cout << "redis port: " << appConfig.redisPort << std::endl;
-    }
-} // namespace snake

ixsnake/ixsnake/IXAppConfig.h

@@ -1,44 +0,0 @@
-/*
- *  IXAppConfig.h
- *  Author: Benjamin Sergeant
- *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
- */
-
-#pragma once
-
-#include <nlohmann/json.hpp>
-#include <string>
-#include <vector>
-#include <ixwebsocket/IXSocketTLSOptions.h>
-
-namespace snake
-{
-    struct AppConfig
-    {
-        // Server
-        std::string hostname;
-        int port;
-
-        // Redis
-        std::vector<std::string> redisHosts;
-        int redisPort;
-        std::string redisPassword;
-
-        // AppKeys
-        nlohmann::json apps;
-
-        // TLS options
-        ix::SocketTLSOptions socketTLSOptions;
-
-        // Misc
-        bool verbose;
-    };
-
-    bool isAppKeyValid(const AppConfig& appConfig, std::string appkey);
-
-    std::string getRoleSecret(const AppConfig& appConfig, std::string appkey, std::string role);
-
-    std::string generateNonce();
-
-    void dumpConfig(const AppConfig& appConfig);
-} // namespace snake