remove unused _backgroundThreadRunning WebSocket member variable

* init Net system on Windows

* propagate DNS error

* Add zlib 1.2.11 sources

* link zlib statically for windows

* remove not implemented function declaration

* fix connect on Windows

.dockerignore

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

.gitignore

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

.travis.yml

@@ -2,8 +2,16 @@ language: cpp
 dist: xenial
 
 compiler:
+  - gcc
   - clang
-#   - gcc
+os:
+  - linux
+  - osx
 
-    # os: osx
-script: make test
+matrix:
+  exclude:
+    # GCC fails on recent Travis OSX images.
+    - compiler: gcc
+      os: osx
+
+script: python test/run.py

CMakeLists.txt

@@ -10,17 +10,23 @@ set (CMAKE_CXX_STANDARD 14)
 set (CXX_STANDARD_REQUIRED ON)
 set (CMAKE_CXX_EXTENSIONS OFF)
 
+# -Wshorten-64-to-32 does not work with clang
 if (NOT WIN32)
   set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -pedantic")
 endif()
 
+if ("${CMAKE_CXX_COMPILER_ID}" MATCHES "Clang")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wshorten-64-to-32")
+endif()
+
 set( IXWEBSOCKET_SOURCES
-    ixwebsocket/IXEventFd.cpp
     ixwebsocket/IXSocket.cpp
     ixwebsocket/IXSocketServer.cpp
     ixwebsocket/IXSocketConnect.cpp
+    ixwebsocket/IXSocketFactory.cpp
     ixwebsocket/IXDNSLookup.cpp
     ixwebsocket/IXCancellationRequest.cpp
+    ixwebsocket/IXNetSystem.cpp
     ixwebsocket/IXWebSocket.cpp
     ixwebsocket/IXWebSocketServer.cpp
     ixwebsocket/IXWebSocketTransport.cpp
@@ -28,16 +34,24 @@ set( IXWEBSOCKET_SOURCES
     ixwebsocket/IXWebSocketPerMessageDeflate.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp
+    ixwebsocket/IXWebSocketHttpHeaders.cpp
+    ixwebsocket/IXHttpClient.cpp
+    ixwebsocket/IXUrlParser.cpp
+    ixwebsocket/IXSelectInterrupt.cpp
+    ixwebsocket/IXSelectInterruptFactory.cpp
+    ixwebsocket/IXConnectionState.cpp
 )
 
 set( IXWEBSOCKET_HEADERS
-    ixwebsocket/IXEventFd.h
     ixwebsocket/IXSocket.h
     ixwebsocket/IXSocketServer.h
     ixwebsocket/IXSocketConnect.h
+    ixwebsocket/IXSocketFactory.h
     ixwebsocket/IXSetThreadName.h
     ixwebsocket/IXDNSLookup.h
     ixwebsocket/IXCancellationRequest.h
+    ixwebsocket/IXNetSystem.h
+    ixwebsocket/IXProgressCallback.h
     ixwebsocket/IXWebSocket.h
     ixwebsocket/IXWebSocketServer.h
     ixwebsocket/IXWebSocketTransport.h
@@ -49,8 +63,19 @@ set( IXWEBSOCKET_HEADERS
     ixwebsocket/IXWebSocketPerMessageDeflateOptions.h
     ixwebsocket/IXWebSocketHttpHeaders.h
     ixwebsocket/libwshandshake.hpp
+    ixwebsocket/IXHttpClient.h
+    ixwebsocket/IXUrlParser.h
+    ixwebsocket/IXSelectInterrupt.h
+    ixwebsocket/IXSelectInterruptFactory.h
+    ixwebsocket/IXConnectionState.h
 )
 
+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)
@@ -58,8 +83,11 @@ elseif (WIN32)
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/windows/IXSetThreadName_windows.cpp)
 else()
     list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/linux/IXSetThreadName_linux.cpp)
+    list( APPEND IXWEBSOCKET_SOURCES ixwebsocket/IXSelectInterruptEventFd.cpp)
+    list( APPEND IXWEBSOCKET_HEADERS ixwebsocket/IXSelectInterruptEventFd.h)
 endif()
 
+set(USE_OPEN_SSL FALSE)
 if (USE_TLS)
     add_definitions(-DIXWEBSOCKET_USE_TLS)
 
@@ -70,6 +98,7 @@ if (USE_TLS)
         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()
@@ -80,35 +109,50 @@ add_library( ixwebsocket STATIC
     ${IXWEBSOCKET_HEADERS}
 )
 
-# gcc/Linux needs -pthread
-find_package(Threads)
+if (APPLE AND USE_TLS)
+  target_link_libraries(ixwebsocket "-framework foundation" "-framework security")
+endif()
 
-if(UNIX AND NOT APPLE)
+if (USE_OPEN_SSL)
   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 (WIN32)
-  get_filename_component(libz_path
-    ${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/release_dynamic/x64/lib/zlib.lib
-    ABSOLUTE)
-  add_library(libz STATIC IMPORTED)
-  set_target_properties(libz PROPERTIES IMPORTED_LOCATION
-    ${libz_path})
-
-  include_directories(${PROJECT_SOURCE_DIR}/third_party/ZLIB-Windows/zlib-1.2.11_deploy_v140/include)
-
-  target_link_libraries(ixwebsocket libz wsock32 ws2_32)
+  add_subdirectory(third_party/zlib)
+  include_directories(third_party/zlib ${CMAKE_CURRENT_BINARY_DIR}/third_party/zlib)
+  target_link_libraries(ixwebsocket zlibstatic wsock32 ws2_32)
   add_definitions(-D_CRT_SECURE_NO_WARNINGS)
-  
+
 else()
+  # gcc/Linux needs -pthread
+  find_package(Threads)
+
   target_link_libraries(ixwebsocket 
-    z ${OPENSSL_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+    z ${CMAKE_THREAD_LIBS_INIT})
 endif()
 
 set( IXWEBSOCKET_INCLUDE_DIRS
     .
-    ../../shared/OpenSSL/include)
+)
+
+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 (NOT WIN32)
+    add_subdirectory(ws)
+endif()

DOCKER_VERSION

@@ -0,0 +1 @@
+1.4.3

Dockerfile

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

README.md

@@ -4,18 +4,18 @@
 
 ## Introduction
 
-[*WebSocket*](https://en.wikipedia.org/wiki/WebSocket) is a computer communications protocol, providing full-duplex
-communication channels over a single TCP connection. *IXWebSocket* is a C++ library for client and server Websocket communication. 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.
+[*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 HTTP communication. The code is derived from [easywsclient](https://github.com/dhbaird/easywsclient) and from the [Satori C SDK](https://github.com/satori-com/satori-rtm-sdk-c). It has been tested on the following platforms.
 
 * macOS
 * iOS
 * Linux
-* Android 
-* Windows (no TLS support yet)
+* Android
+
+The code was made to compile once on Windows but support is currently broken on this platform.
 
 ## Examples
 
-The examples folder countains a simple chat program, using a node.js broadcast server.
+The [*ws*](https://github.com/machinezone/IXWebSocket/tree/master/ws) folder countains many interactive programs for chat, [file transfers](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_send.cpp), [curl like](https://github.com/machinezone/IXWebSocket/blob/master/ws/ws_http_client.cpp) http clients, demonstrating client and server usage.
 
 Here is what the client API looks like.
 
@@ -25,7 +25,7 @@ ix::WebSocket webSocket;
 std::string url("ws://localhost:8080/");
 webSocket.setUrl(url);
 
-// Optional heart beat, sent every 45 seconds when there isn't any traffic
+// 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);
 
@@ -35,8 +35,8 @@ webSocket.setOnMessageCallback(
        const std::string& str,
        size_t wireSize,
        const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
+       const ix::WebSocketOpenInfo& openInfo,
+       const ix::WebSocketCloseInfo& closeInfo)
     {
         if (messageType == ix::WebSocket_MessageType_Message)
         {
@@ -47,9 +47,12 @@ webSocket.setOnMessageCallback(
 // Now that our callback is setup, we can start our background thread and receive messages
 webSocket.start();
 
-// Send a message to the server
+// Send a message to the server (default to BINARY mode)
 webSocket.send("hello world");
 
+// The message can be sent in TEXT mode
+webSocket.sendText("hello again");
+
 // ... finally ...
 
 // Stop the connection
@@ -64,10 +67,11 @@ Here is what the server API looks like. Note that server support is very recent
 ix::WebSocketServer server(port);
 
 server.setOnConnectionCallback(
-    [&server](std::shared_ptr<ix::WebSocket> webSocket)
+    [&server](std::shared_ptr<WebSocket> webSocket,
+              std::shared_ptr<ConnectionState> connectionState)
     {
         webSocket->setOnMessageCallback(
-            [webSocket, &server](ix::WebSocketMessageType messageType,
+            [webSocket, connectionState, &server](ix::WebSocketMessageType messageType,
                const std::string& str,
                size_t wireSize,
                const ix::WebSocketErrorInfo& error,
@@ -77,7 +81,16 @@ server.setOnConnectionCallback(
                 if (messageType == ix::WebSocket_MessageType_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: " << openInfo.uri << std::endl;
+
                     std::cerr << "Headers:" << std::endl;
                     for (auto it : openInfo.headers)
                     {
@@ -110,11 +123,103 @@ server.wait();
 
 ```
 
+Here is what the HTTP client API looks like. Note that HTTP client support is very recent and subject to changes.
+
+```
+//
+// Preparation
+//
+HttpClient httpClient;
+HttpRequestArgs args;
+
+// Custom headers can be set
+WebSocketHttpHeaders headers;
+headers["Foo"] = "bar";
+args.extraHeaders = 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;
+};
+
+//
+// Request
+//
+HttpResponse out;
+std::string url = "https://www.google.com";
+
+// HEAD request
+out = httpClient.head(url, args);
+
+// GET request
+out = httpClient.get(url, args);
+
+// POST request with parameters
+HttpParameters httpParameters;
+httpParameters["foo"] = "bar";
+out = httpClient.post(url, httpParameters, args);
+
+// POST request with a body
+out = httpClient.post(url, std::string("foo=bar"), args);
+
+//
+// Result
+//
+auto statusCode = std::get<0>(out);
+auto errorCode = std::get<1>(out);
+auto responseHeaders = std::get<2>(out);
+auto payload = std::get<3>(out);
+auto errorMsg = std::get<4>(out);
+auto uploadSize = std::get<5>(out);
+auto downloadSize = std::get<6>(out);
+```
+
 ## Build
 
-CMakefiles for the library and the examples are available. This library has few dependencies, so it is possible to just add the source files into your project.
+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.
 
-There is a Dockerfile for running some code on Linux, and a unittest which can be executed by typing `make test`.
+```
+mkdir build # make a build dir so that you can build out of tree.
+cd build
+cmake ..
+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`.
+
+There is a Dockerfile for running some code on Linux. 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
+...
+```
+
+Finally you can build and install the `ws command line tool` with Homebrew. The homebrew version might be slightly out of date.
+
+```
+brew tap bsergean/IXWebSocket
+brew install IXWebSocket
+```
 
 ## Implementation details
 
@@ -134,37 +239,31 @@ No manual polling to fetch data is required. Data is sent and received instantly
 
 If the remote end (server) breaks the connection, the code will try to perpetually reconnect, by using an exponential backoff strategy, capped at one retry every 10 seconds.
 
+### Large messages
+
+Large frames are broken up into smaller chunks or messages to avoid filling up the os tcp buffers, which is permitted thanks to WebSocket [fragmentation](https://tools.ietf.org/html/rfc6455#section-5.4). Messages up to 1G were sent and received succesfully.
+
 ## Limitations
 
-* There is no text support for sending data, only the binary protocol is supported. Sending json or text over the binary protocol works well.
+* No utf-8 validation is made when sending TEXT message with sendText()
 * 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.
+* 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's a simplistic diagram which explains how the code is structured in term of class/modules.
+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 
++-----------------------+ --- Private
 |                       |
 |  IXWebSocketTransport | Low level websocket code, framing, managing raw socket. Adapted from easywsclient.
 |                       |
@@ -204,7 +303,7 @@ If the connection was closed and sending failed, the return value will be set to
 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.
+4. WebSocket_MessageType_Close     - The connection is closed or could not be opened.
 
 ### Open and Close notifications
 
@@ -216,8 +315,8 @@ webSocket.setOnMessageCallback(
        const std::string& str,
        size_t wireSize,
        const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
+       const ix::WebSocketOpenInfo& openInfo,
+       const ix::WebSocketCloseInfo& closeInfo)
     {
         if (messageType == ix::WebSocket_MessageType_Open)
         {
@@ -253,8 +352,8 @@ webSocket.setOnMessageCallback(
        const std::string& str,
        size_t wireSize,
        const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
+       const ix::WebSocketOpenInfo& openInfo,
+       const ix::WebSocketCloseInfo& closeInfo)
     {
         if (messageType == ix::WebSocket_MessageType_Error)
         {
@@ -293,8 +392,8 @@ webSocket.setOnMessageCallback(
        const std::string& str,
        size_t wireSize,
        const ix::WebSocketErrorInfo& error,
-       const ix::WebSocketCloseInfo& closeInfo,
-       const ix::WebSocketHttpHeaders& headers)
+       const ix::WebSocketOpenInfo& openInfo,
+       const ix::WebSocketCloseInfo& closeInfo)
     {
         if (messageType == ix::WebSocket_MessageType_Ping ||
             messageType == ix::WebSocket_MessageType_Pong)
@@ -309,11 +408,12 @@ 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
+when there is no any traffic to make sure that load balancers do not kill an
 idle connection.
 
 ```

docker-compose.yml

@@ -0,0 +1,33 @@
+version: "3"
+services:
+  snake:
+    image: bsergean/ws:build
+    entrypoint: ws snake --port 8765 --host 0.0.0.0 --redis_hosts redis1
+    ports:
+      - "8765:8765"
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
+
+  ws:
+    security_opt:
+    - seccomp:unconfined
+    cap_add:
+    - SYS_PTRACE
+    stdin_open: true
+    tty: true
+    image: bsergean/ws:build
+    entrypoint: bash
+    networks:
+      - ws-net
+    depends_on:
+      - redis1
+
+  redis1:
+    image: redis:alpine
+    networks:
+      - ws-net
+
+networks:
+  ws-net:

docker/Dockerfile

@@ -1,16 +0,0 @@
-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,11 +0,0 @@
-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.centos

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

docker/Dockerfile.fedora

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

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

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

examples/broadcast_server/.gitignore

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

examples/broadcast_server/CMakeLists.txt

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

@@ -1,74 +0,0 @@
-/*
- *  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,3 +0,0 @@
-build
-venv
-node_modules

examples/chat/CMakeLists.txt

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

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

@@ -1,15 +0,0 @@
-#!/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

@@ -1,17 +0,0 @@
-#!/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/package-lock.json

@@ -1,31 +0,0 @@
-{
-  "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

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

examples/cobra_publisher/.gitignore

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

examples/cobra_publisher/CMakeLists.txt

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

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

examples/cobra_publisher/cobra_publisher.cpp

@@ -1,123 +0,0 @@
-/*
- *  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

@@ -1,11 +0,0 @@
-#!/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

@@ -1,45 +0,0 @@
-/*
- *  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

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

@@ -1,3 +0,0 @@
-{"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/echo_server/CMakeLists.txt

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

@@ -1,68 +0,0 @@
-/*
- *  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/CMakeLists.txt

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

@@ -1,15 +0,0 @@
-#!/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

@@ -1,17 +0,0 @@
-#!/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/server.py

@@ -1,21 +0,0 @@
-#!/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

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

examples/ws_connect/CMakeLists.txt

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

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

@@ -1,25 +0,0 @@
-#!/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

ixwebsocket/IXCancellationRequest.cpp

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

ixwebsocket/IXCancellationRequest.h

@@ -9,7 +9,7 @@
 #include <functional>
 #include <atomic>
 
-namespace ix 
+namespace ix
 {
     using CancellationRequest = std::function<bool()>;
 

ixwebsocket/IXConnectionState.cpp

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

ixwebsocket/IXConnectionState.h

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

ixwebsocket/IXDNSLookup.cpp

@@ -10,7 +10,7 @@
 #include <string.h>
 #include <chrono>
 
-namespace ix 
+namespace ix
 {
     const int64_t DNSLookup::kDefaultWait = 10; // ms
 
@@ -19,24 +19,24 @@ namespace ix
     std::mutex DNSLookup::_activeJobsMutex;
 
     DNSLookup::DNSLookup(const std::string& hostname, int port, int64_t wait) :
-        _hostname(hostname),
         _port(port),
         _wait(wait),
         _res(nullptr),
         _done(false),
         _id(_nextId++)
     {
-        
+        setHostname(hostname);
     }
 
     DNSLookup::~DNSLookup()
     {
         // Remove this job from the active jobs list
-        std::unique_lock<std::mutex> lock(_activeJobsMutex);
+        std::lock_guard<std::mutex> lock(_activeJobsMutex);
         _activeJobs.erase(_id);
     }
 
-    struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname, 
+    // we want hostname to be copied, not passed as a const reference
+    struct addrinfo* DNSLookup::getAddrInfo(const std::string& hostname,
                                             int port,
                                             std::string& errMsg)
     {
@@ -49,7 +49,7 @@ namespace ix
         std::string sport = std::to_string(port);
 
         struct addrinfo* res;
-        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(), 
+        int getaddrinfo_result = getaddrinfo(hostname.c_str(), sport.c_str(),
                                              &hints, &res);
         if (getaddrinfo_result)
         {
@@ -73,13 +73,13 @@ namespace ix
         errMsg = "no error";
 
         // Maybe a cancellation request got in before the background thread terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
         }
 
-        return getAddrInfo(_hostname, _port, errMsg);
+        return getAddrInfo(getHostname(), _port, errMsg);
     }
 
     struct addrinfo* DNSLookup::resolveAsync(std::string& errMsg,
@@ -97,15 +97,15 @@ namespace ix
 
         // Record job in the active Job set
         {
-            std::unique_lock<std::mutex> lock(_activeJobsMutex);
+            std::lock_guard<std::mutex> lock(_activeJobsMutex);
             _activeJobs.insert(_id);
         }
 
-        // 
+        //
         // Good resource on thread forced termination
         // https://www.bo-yang.net/2017/11/19/cpp-kill-detached-thread
         //
-        _thread = std::thread(&DNSLookup::run, this, _id, _hostname, _port);
+        _thread = std::thread(&DNSLookup::run, this, _id, getHostname(), _port);
         _thread.detach();
 
         std::unique_lock<std::mutex> lock(_conditionVariableMutex);
@@ -121,7 +121,7 @@ namespace ix
             }
 
             // Were we cancelled ?
-            if (isCancellationRequested())
+            if (isCancellationRequested && isCancellationRequested())
             {
                 errMsg = "cancellation requested";
                 return nullptr;
@@ -129,36 +129,74 @@ namespace ix
         }
 
         // Maybe a cancellation request got in before the bg terminated ?
-        if (isCancellationRequested())
+        if (isCancellationRequested && isCancellationRequested())
         {
             errMsg = "cancellation requested";
             return nullptr;
         }
 
-        return _res;
+        errMsg = getErrMsg();
+        return getRes();
     }
 
     void DNSLookup::run(uint64_t id, const std::string& hostname, int port) // thread runner
     {
         // We don't want to read or write into members variables of an object that could be
-        // gone, so we use temporary variables (res) or we pass in by copy everything that 
+        // gone, so we use temporary variables (res) or we pass in by copy everything that
         // getAddrInfo needs to work.
         std::string errMsg;
         struct addrinfo* res = getAddrInfo(hostname, port, errMsg);
 
         // if this isn't an active job, and the control thread is gone
-        // there is not thing to do, and we don't want to touch the defunct
+        // there is nothing to do, and we don't want to touch the defunct
         // object data structure such as _errMsg or _condition
-        std::unique_lock<std::mutex> lock(_activeJobsMutex);
+        std::lock_guard<std::mutex> lock(_activeJobsMutex);
         if (_activeJobs.count(id) == 0)
         {
             return;
         }
 
         // Copy result into the member variables
-        _res = res;
-        _errMsg = errMsg;
+        setRes(res);
+        setErrMsg(errMsg);
+
         _condition.notify_one();
         _done = true;
     }
+
+    void DNSLookup::setHostname(const std::string& hostname)
+    {
+        std::lock_guard<std::mutex> lock(_hostnameMutex);
+        _hostname = hostname;
+    }
+
+    const std::string& DNSLookup::getHostname()
+    {
+        std::lock_guard<std::mutex> lock(_hostnameMutex);
+        return _hostname;
+    }
+
+    void DNSLookup::setErrMsg(const std::string& errMsg)
+    {
+        std::lock_guard<std::mutex> lock(_errMsgMutex);
+        _errMsg = errMsg;
+    }
+
+    const std::string& DNSLookup::getErrMsg()
+    {
+        std::lock_guard<std::mutex> lock(_errMsgMutex);
+        return _errMsg;
+    }
+
+    void DNSLookup::setRes(struct addrinfo* addr)
+    {
+        std::lock_guard<std::mutex> lock(_resMutex);
+        _res = addr;
+    }
+
+    struct addrinfo* DNSLookup::getRes()
+    {
+        std::lock_guard<std::mutex> lock(_resMutex);
+        return _res;
+    }
 }

ixwebsocket/IXDNSLookup.h

@@ -3,7 +3,7 @@
  *  Author: Benjamin Sergeant
  *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
  *
- *  Resolve a hostname+port to a struct addrinfo obtained with getaddrinfo 
+ *  Resolve a hostname+port to a struct addrinfo obtained with getaddrinfo
  *  Does this in a background thread so that it can be cancelled, since
  *  getaddrinfo is a blocking call, and we don't want to block the main thread on Mobile.
  */
@@ -20,7 +20,7 @@
 
 struct addrinfo;
 
-namespace ix 
+namespace ix
 {
     class DNSLookup {
     public:
@@ -39,17 +39,32 @@ namespace ix
         struct addrinfo* resolveBlocking(std::string& errMsg,
                                          const CancellationRequest& isCancellationRequested);
 
-        static struct addrinfo* getAddrInfo(const std::string& hostname, 
+        static struct addrinfo* getAddrInfo(const std::string& hostname,
                                             int port,
                                             std::string& errMsg);
 
         void run(uint64_t id, const std::string& hostname, int port); // thread runner
 
+        void setHostname(const std::string& hostname);
+        const std::string& getHostname();
+
+        void setErrMsg(const std::string& errMsg);
+        const std::string& getErrMsg();
+
+        void setRes(struct addrinfo* addr);
+        struct addrinfo* getRes();
+
         std::string _hostname;
+        std::mutex _hostnameMutex;
         int _port;
+
         int64_t _wait;
-        std::string _errMsg;
+
         struct addrinfo* _res;
+        std::mutex _resMutex;
+
+        std::string _errMsg;
+        std::mutex _errMsgMutex;
 
         std::atomic<bool> _done;
         std::thread _thread;

ixwebsocket/IXEventFd.cpp

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

ixwebsocket/IXEventFd.h

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

ixwebsocket/IXHttpClient.cpp

@@ -0,0 +1,467 @@
+/*
+ *  IXHttpClient.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXHttpClient.h"
+#include "IXUrlParser.h"
+#include "IXWebSocketHttpHeaders.h"
+#include "IXSocketFactory.h"
+
+#include <sstream>
+#include <iomanip>
+#include <vector>
+#include <cstring>
+
+#include <zlib.h>
+
+namespace ix
+{
+    const std::string HttpClient::kPost = "POST";
+    const std::string HttpClient::kGet = "GET";
+    const std::string HttpClient::kHead = "HEAD";
+
+    HttpClient::HttpClient()
+    {
+
+    }
+
+    HttpClient::~HttpClient()
+    {
+
+    }
+
+    HttpResponse HttpClient::request(
+        const std::string& url,
+        const std::string& verb,
+        const std::string& body,
+        const HttpRequestArgs& args,
+        int redirects)
+    {
+        uint64_t uploadSize = 0;
+        uint64_t downloadSize = 0;
+        int code = 0;
+        WebSocketHttpHeaders headers;
+        std::string payload;
+
+        std::string protocol, host, path, query;
+        int port;
+        bool websocket = false;
+
+        if (!UrlParser::parse(url, protocol, host, path, query, port, websocket))
+        {
+            std::stringstream ss;
+            ss << "Cannot parse url: " << url;
+            return std::make_tuple(code, HttpErrorCode_UrlMalformed,
+                                   headers, payload, ss.str(),
+                                   uploadSize, downloadSize);
+        }
+
+        bool tls = protocol == "https";
+        std::string errorMsg;
+        _socket = createSocket(tls, errorMsg);
+
+        if (!_socket)
+        {
+            return std::make_tuple(code, HttpErrorCode_CannotCreateSocket,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        // Build request string
+        std::stringstream ss;
+        ss << verb << " " << path << " HTTP/1.1\r\n";
+        ss << "Host: " << host << "\r\n";
+        ss << "User-Agent: ixwebsocket/1.0.0" << "\r\n";
+        ss << "Accept: */*" << "\r\n";
+
+        if (args.compress)
+        {
+            ss << "Accept-Encoding: gzip" << "\r\n";
+        }
+
+        // Append extra headers
+        for (auto&& it : args.extraHeaders)
+        {
+            ss << it.first << ": " << it.second << "\r\n";
+        }
+
+        if (verb == kPost)
+        {
+            ss << "Content-Length: " << body.size() << "\r\n";
+
+            // Set default Content-Type if unspecified
+            if (args.extraHeaders.find("Content-Type") == args.extraHeaders.end())
+            {
+                ss << "Content-Type: application/x-www-form-urlencoded" << "\r\n";
+            }
+            ss << "\r\n";
+            ss << body;
+        }
+        else
+        {
+            ss << "\r\n";
+        }
+
+        std::string req(ss.str());
+        std::string errMsg;
+        std::atomic<bool> requestInitCancellation(false);
+
+        // Make a cancellation object dealing with connection timeout
+        auto isCancellationRequested =
+            makeCancellationRequestWithTimeout(args.connectTimeout, requestInitCancellation);
+
+        bool success = _socket->connect(host, port, errMsg, isCancellationRequested);
+        if (!success)
+        {
+            std::stringstream ss;
+            ss << "Cannot connect to url: " << url;
+            return std::make_tuple(code, HttpErrorCode_CannotConnect,
+                                   headers, payload, ss.str(),
+                                   uploadSize, downloadSize);
+        }
+
+        // Make a new cancellation object dealing with transfer timeout
+        isCancellationRequested =
+            makeCancellationRequestWithTimeout(args.transferTimeout, requestInitCancellation);
+
+        if (args.verbose)
+        {
+            std::stringstream ss;
+            ss << "Sending " << verb << " request "
+               << "to " << host << ":" << port << std::endl
+               << "request size: " << req.size() << " bytes" << std::endl
+               << "=============" << std::endl
+               << req
+               << "=============" << std::endl
+               << std::endl;
+
+            log(ss.str(), args);
+        }
+
+        if (!_socket->writeBytes(req, isCancellationRequested))
+        {
+            std::string errorMsg("Cannot send request");
+            return std::make_tuple(code, HttpErrorCode_SendError,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        uploadSize = req.size();
+
+        auto lineResult = _socket->readLine(isCancellationRequested);
+        auto lineValid = lineResult.first;
+        auto line = lineResult.second;
+
+        if (!lineValid)
+        {
+            std::string errorMsg("Cannot retrieve status line");
+            return std::make_tuple(code, HttpErrorCode_CannotReadStatusLine,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        if (args.verbose)
+        {
+            std::stringstream ss;
+            ss << "Status line " << line;
+            log(ss.str(), args);
+        }
+
+        if (sscanf(line.c_str(), "HTTP/1.1 %d", &code) != 1)
+        {
+            std::string errorMsg("Cannot parse response code from status line");
+            return std::make_tuple(code, HttpErrorCode_MissingStatus,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        auto result = parseHttpHeaders(_socket, isCancellationRequested);
+        auto headersValid = result.first;
+        headers = result.second;
+
+        if (!headersValid)
+        {
+            std::string errorMsg("Cannot parse http headers");
+            return std::make_tuple(code, HttpErrorCode_HeaderParsingError,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        // Redirect ?
+        if ((code >= 301 && code <= 308) && args.followRedirects)
+        {
+            if (headers.find("Location") == headers.end())
+            {
+                std::string errorMsg("Missing location header for redirect");
+                return std::make_tuple(code, HttpErrorCode_MissingLocation,
+                                       headers, payload, errorMsg,
+                                       uploadSize, downloadSize);
+            }
+
+            if (redirects >= args.maxRedirects)
+            {
+                std::stringstream ss;
+                ss << "Too many redirects: " << redirects;
+                return std::make_tuple(code, HttpErrorCode_TooManyRedirects,
+                                       headers, payload, ss.str(),
+                                       uploadSize, downloadSize);
+            }
+
+            // Recurse
+            std::string location = headers["Location"];
+            return request(location, verb, body, args, redirects+1);
+        }
+
+        if (verb == "HEAD")
+        {
+            return std::make_tuple(code, HttpErrorCode_Ok,
+                                   headers, payload, std::string(),
+                                   uploadSize, downloadSize);
+        }
+
+        // Parse response:
+        if (headers.find("Content-Length") != headers.end())
+        {
+            ssize_t contentLength = -1;
+            ss.str("");
+            ss << headers["Content-Length"];
+            ss >> contentLength;
+
+            payload.reserve(contentLength);
+
+            auto chunkResult = _socket->readBytes(contentLength,
+                                                  args.onProgressCallback,
+                                                  isCancellationRequested);
+            if (!chunkResult.first)
+            {
+                errorMsg = "Cannot read chunk";
+                return std::make_tuple(code, HttpErrorCode_ChunkReadError,
+                                       headers, payload, errorMsg,
+                                       uploadSize, downloadSize);
+            }
+            payload += chunkResult.second;
+        }
+        else if (headers.find("Transfer-Encoding") != headers.end() &&
+                 headers["Transfer-Encoding"] == "chunked")
+        {
+            std::stringstream ss;
+
+            while (true)
+            {
+                lineResult = _socket->readLine(isCancellationRequested);
+                line = lineResult.second;
+
+                if (!lineResult.first)
+                {
+                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
+                                           headers, payload, errorMsg,
+                                           uploadSize, downloadSize);
+                }
+
+                uint64_t chunkSize;
+                ss.str("");
+                ss << std::hex << line;
+                ss >> chunkSize;
+
+                if (args.verbose)
+                {
+                    std::stringstream oss;
+                    oss << "Reading " << chunkSize << " bytes"
+                        << std::endl;
+                    log(oss.str(), args);
+                }
+
+                payload.reserve(payload.size() + chunkSize);
+
+                // Read a chunk
+                auto chunkResult = _socket->readBytes(chunkSize,
+                                                      args.onProgressCallback,
+                                                      isCancellationRequested);
+                if (!chunkResult.first)
+                {
+                    errorMsg = "Cannot read chunk";
+                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
+                                           headers, payload, errorMsg,
+                                           uploadSize, downloadSize);
+                }
+                payload += chunkResult.second;
+
+                // Read the line that terminates the chunk (\r\n)
+                lineResult = _socket->readLine(isCancellationRequested);
+
+                if (!lineResult.first)
+                {
+                    return std::make_tuple(code, HttpErrorCode_ChunkReadError,
+                                           headers, payload, errorMsg,
+                                           uploadSize, downloadSize);
+                }
+
+                if (chunkSize == 0) break;
+            }
+        }
+        else if (code == 204)
+        {
+            ; // 204 is NoContent response code
+        }
+        else
+        {
+            std::string errorMsg("Cannot read http body");
+            return std::make_tuple(code, HttpErrorCode_CannotReadBody,
+                                   headers, payload, errorMsg,
+                                   uploadSize, downloadSize);
+        }
+
+        downloadSize = payload.size();
+
+        // If the content was compressed with gzip, decode it
+        if (headers["Content-Encoding"] == "gzip")
+        {
+            std::string decompressedPayload;
+            if (!gzipInflate(payload, decompressedPayload))
+            {
+                std::string errorMsg("Error decompressing payload");
+                return std::make_tuple(code, HttpErrorCode_Gzip,
+                                       headers, payload, errorMsg,
+                                       uploadSize, downloadSize);
+            }
+            payload = decompressedPayload;
+        }
+
+        return std::make_tuple(code, HttpErrorCode_Ok,
+                               headers, payload, std::string(),
+                               uploadSize, downloadSize);
+    }
+
+    HttpResponse HttpClient::get(const std::string& url,
+                                 const HttpRequestArgs& args)
+    {
+        return request(url, kGet, std::string(), args);
+    }
+
+    HttpResponse HttpClient::head(const std::string& url,
+                                  const HttpRequestArgs& args)
+    {
+        return request(url, kHead, std::string(), args);
+    }
+
+    HttpResponse HttpClient::post(const std::string& url,
+                                  const HttpParameters& httpParameters,
+                                  const HttpRequestArgs& args)
+    {
+        return request(url, kPost, serializeHttpParameters(httpParameters), args);
+    }
+
+    HttpResponse HttpClient::post(const std::string& url,
+                                  const std::string& body,
+                                  const HttpRequestArgs& args)
+    {
+        return request(url, kPost, body, args);
+    }
+
+    std::string HttpClient::urlEncode(const std::string& value)
+    {
+        std::ostringstream escaped;
+        escaped.fill('0');
+        escaped << std::hex;
+
+        for (std::string::const_iterator i = value.begin(), n = value.end();
+             i != n; ++i)
+        {
+            std::string::value_type c = (*i);
+
+            // Keep alphanumeric and other accepted characters intact
+            if (isalnum(c) || c == '-' || c == '_' || c == '.' || c == '~')
+            {
+                escaped << c;
+                continue;
+            }
+
+            // Any other characters are percent-encoded
+            escaped << std::uppercase;
+            escaped << '%' << std::setw(2) << int((unsigned char) c);
+            escaped << std::nouppercase;
+        }
+
+        return escaped.str();
+    }
+
+    std::string HttpClient::serializeHttpParameters(const HttpParameters& httpParameters)
+    {
+        std::stringstream ss;
+        size_t count = httpParameters.size();
+        size_t i = 0;
+
+        for (auto&& it : httpParameters)
+        {
+            ss << urlEncode(it.first)
+               << "="
+               << urlEncode(it.second);
+
+            if (i++ < (count-1))
+            {
+               ss << "&";
+            }
+        }
+        return ss.str();
+    }
+
+    bool HttpClient::gzipInflate(
+        const std::string& in,
+        std::string& out)
+    {
+        z_stream inflateState;
+        std::memset(&inflateState, 0, sizeof(inflateState));
+
+        inflateState.zalloc = Z_NULL;
+        inflateState.zfree = Z_NULL;
+        inflateState.opaque = Z_NULL;
+        inflateState.avail_in = 0;
+        inflateState.next_in = Z_NULL;
+
+        if (inflateInit2(&inflateState, 16+MAX_WBITS) != Z_OK)
+        {
+            return false;
+        }
+
+        inflateState.avail_in = (uInt) in.size();
+        inflateState.next_in = (unsigned char *)(const_cast<char *>(in.data()));
+
+        const int kBufferSize = 1 << 14;
+
+        std::unique_ptr<unsigned char[]> compressBuffer =
+            std::make_unique<unsigned char[]>(kBufferSize);
+
+        do
+        {
+            inflateState.avail_out = (uInt) kBufferSize;
+            inflateState.next_out = compressBuffer.get();
+
+            int ret = inflate(&inflateState, Z_SYNC_FLUSH);
+
+            if (ret == Z_NEED_DICT || ret == Z_DATA_ERROR || ret == Z_MEM_ERROR)
+            {
+                inflateEnd(&inflateState);
+                return false;
+            }
+
+            out.append(
+                reinterpret_cast<char *>(compressBuffer.get()),
+                kBufferSize - inflateState.avail_out
+            );
+        } while (inflateState.avail_out == 0);
+
+        inflateEnd(&inflateState);
+        return true;
+    }
+
+    void HttpClient::log(const std::string& msg,
+                         const HttpRequestArgs& args)
+    {
+        if (args.logger)
+        {
+            args.logger(msg);
+        }
+    }
+}

ixwebsocket/IXHttpClient.h

@@ -0,0 +1,107 @@
+/*
+ *  IXHttpClient.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <algorithm>
+#include <functional>
+#include <mutex>
+#include <atomic>
+#include <tuple>
+#include <memory>
+#include <map>
+
+#include "IXSocket.h"
+#include "IXWebSocketHttpHeaders.h"
+
+namespace ix
+{
+    enum HttpErrorCode
+    {
+        HttpErrorCode_Ok = 0,
+        HttpErrorCode_CannotConnect = 1,
+        HttpErrorCode_Timeout = 2,
+        HttpErrorCode_Gzip = 3,
+        HttpErrorCode_UrlMalformed = 4,
+        HttpErrorCode_CannotCreateSocket = 5,
+        HttpErrorCode_SendError = 6,
+        HttpErrorCode_ReadError = 7,
+        HttpErrorCode_CannotReadStatusLine = 8,
+        HttpErrorCode_MissingStatus = 9,
+        HttpErrorCode_HeaderParsingError = 10,
+        HttpErrorCode_MissingLocation = 11,
+        HttpErrorCode_TooManyRedirects = 12,
+        HttpErrorCode_ChunkReadError = 13,
+        HttpErrorCode_CannotReadBody = 14
+    };
+
+    using HttpResponse = std::tuple<int, // status
+                                    HttpErrorCode, // error code
+                                    WebSocketHttpHeaders,
+                                    std::string, // payload
+                                    std::string, // error msg
+                                    uint64_t,    // upload size
+                                    uint64_t>;   // download size
+
+    using HttpParameters = std::map<std::string, std::string>;
+    using Logger = std::function<void(const std::string&)>;
+
+    struct HttpRequestArgs
+    {
+        std::string url;
+        WebSocketHttpHeaders extraHeaders;
+        std::string body;
+        int connectTimeout;
+        int transferTimeout;
+        bool followRedirects;
+        int maxRedirects;
+        bool verbose;
+        bool compress;
+        Logger logger;
+        OnProgressCallback onProgressCallback;
+    };
+
+    class HttpClient {
+    public:
+        HttpClient();
+        ~HttpClient();
+
+        HttpResponse get(const std::string& url,
+                         const HttpRequestArgs& args);
+        HttpResponse head(const std::string& url,
+                          const HttpRequestArgs& args);
+
+        HttpResponse post(const std::string& url,
+                          const HttpParameters& httpParameters,
+                          const HttpRequestArgs& args);
+        HttpResponse post(const std::string& url,
+                          const std::string& body,
+                          const HttpRequestArgs& args);
+
+    private:
+        HttpResponse request(const std::string& url,
+                             const std::string& verb,
+                             const std::string& body,
+                             const HttpRequestArgs& args,
+                             int redirects = 0);
+
+        std::string serializeHttpParameters(const HttpParameters& httpParameters);
+
+        std::string urlEncode(const std::string& value);
+
+        void log(const std::string& msg, const HttpRequestArgs& args);
+
+        bool gzipInflate(
+            const std::string& in,
+            std::string& out);
+
+        std::shared_ptr<Socket> _socket;
+
+        const static std::string kPost;
+        const static std::string kGet;
+        const static std::string kHead;
+    };
+}

ixwebsocket/IXNetSystem.cpp

@@ -0,0 +1,39 @@
+/*
+ *  IXNetSystem.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone. All rights reserved.
+ */
+
+#include "IXNetSystem.h"
+
+namespace ix
+{
+    bool initNetSystem()
+    {
+#ifdef _WIN32
+        WORD wVersionRequested;
+        WSADATA wsaData;
+        int err;
+
+        /* Use the MAKEWORD(lowbyte, highbyte) macro declared in Windef.h */
+        wVersionRequested = MAKEWORD(2, 2);
+
+        err = WSAStartup(wVersionRequested, &wsaData);
+
+        return err == 0;
+#else
+        return true;
+#endif
+    }
+
+    bool uninitNetSystem()
+    {
+#ifdef _WIN32
+        int err = WSACleanup();
+
+        return err == 0;
+#else
+        return true;
+#endif
+    }
+}

ixwebsocket/IXNetSystem.h

@@ -23,3 +23,9 @@
 # include <sys/time.h>
 # include <unistd.h>
 #endif
+
+namespace ix
+{
+    bool initNetSystem();
+    bool uninitNetSystem();
+}

ixwebsocket/IXProgressCallback.h

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

ixwebsocket/IXSelectInterrupt.cpp

@@ -0,0 +1,46 @@
+/*
+ *  IXSelectInterrupt.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXSelectInterrupt.h"
+
+namespace ix
+{
+    SelectInterrupt::SelectInterrupt()
+    {
+        ;
+    }
+
+    SelectInterrupt::~SelectInterrupt()
+    {
+        ;
+    }
+
+    bool SelectInterrupt::init(std::string& /*errorMsg*/)
+    {
+        return true;
+    }
+
+    bool SelectInterrupt::notify(uint64_t /*value*/)
+    {
+        return true;
+    }
+
+    uint64_t SelectInterrupt::read()
+    {
+        return 0;
+    }
+
+    bool SelectInterrupt::clear()
+    {
+        return true;
+    }
+
+    int SelectInterrupt::getFd() const
+    {
+        return -1;
+    }
+}
+

ixwebsocket/IXSelectInterrupt.h

@@ -0,0 +1,28 @@
+/*
+ *  IXSelectInterrupt.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterrupt {
+    public:
+        SelectInterrupt();
+        virtual ~SelectInterrupt();
+
+        virtual bool init(std::string& errorMsg);
+
+        virtual bool notify(uint64_t value);
+        virtual bool clear();
+        virtual uint64_t read();
+        virtual int getFd() const;
+    };
+}
+
+

ixwebsocket/IXSelectInterruptEventFd.cpp

@@ -0,0 +1,116 @@
+/*
+ *  IXSelectInterruptEventFd.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// On Linux we use eventd to wake up select.
+//
+
+//
+// Linux/Android has a special type of virtual files. select(2) will react
+// when reading/writing to those files, unlike closing sockets.
+//
+// https://linux.die.net/man/2/eventfd
+// http://www.sourcexr.com/articles/2013/10/26/lightweight-inter-process-signaling-with-eventfd
+//
+// eventfd was added in Linux kernel 2.x, and our oldest Android (Kitkat 4.4)
+// is on Kernel 3.x
+//
+// cf Android/Kernel table here
+// https://android.stackexchange.com/questions/51651/which-android-runs-which-linux-kernel
+//
+// On macOS we use UNIX pipes to wake up select.
+//
+
+#include "IXSelectInterruptEventFd.h"
+
+#include <sys/eventfd.h>
+
+#include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
+
+namespace ix
+{
+    SelectInterruptEventFd::SelectInterruptEventFd()
+    {
+        _eventfd = -1;
+    }
+
+    SelectInterruptEventFd::~SelectInterruptEventFd()
+    {
+        ::close(_eventfd);
+    }
+
+    bool SelectInterruptEventFd::init(std::string& errorMsg)
+    {
+        // calling init twice is a programming error
+        assert(_eventfd == -1);
+
+        _eventfd = eventfd(0, 0);
+        if (_eventfd < 0)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in eventfd()"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        if (fcntl(_eventfd, F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptEventFd::init() failed in fcntl() call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _eventfd = -1;
+            return false;
+        }
+
+        return true;
+    }
+
+    bool SelectInterruptEventFd::notify(uint64_t value)
+    {
+        int fd = _eventfd;
+
+        if (fd == -1) return false;
+
+        // we should write 8 bytes for an uint64_t
+        return write(fd, &value, sizeof(value)) == 8;
+    }
+
+    // TODO: return max uint64_t for errors ?
+    uint64_t SelectInterruptEventFd::read()
+    {
+        int fd = _eventfd;
+
+        uint64_t value = 0;
+        ::read(fd, &value, sizeof(value));
+        return value;
+    }
+
+    bool SelectInterruptEventFd::clear()
+    {
+        if (_eventfd == -1) return false;
+
+        // 0 is a special value ; select will not wake up
+        uint64_t value = 0;
+
+        // we should write 8 bytes for an uint64_t
+        return write(_eventfd, &value, sizeof(value)) == 8;
+    }
+
+    int SelectInterruptEventFd::getFd() const
+    {
+        return _eventfd;
+    }
+}

ixwebsocket/IXSelectInterruptEventFd.h

@@ -0,0 +1,32 @@
+/*
+ *  IXSelectInterruptEventFd.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSelectInterrupt.h"
+
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterruptEventFd : public SelectInterrupt {
+    public:
+        SelectInterruptEventFd();
+        virtual ~SelectInterruptEventFd();
+
+        bool init(std::string& errorMsg) final;
+
+        bool notify(uint64_t value) final;
+        bool clear() final;
+        uint64_t read() final;
+        int getFd() const final;
+
+    private:
+        int _eventfd;
+    };
+}
+

ixwebsocket/IXSelectInterruptFactory.cpp

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

ixwebsocket/IXSelectInterruptFactory.h

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

ixwebsocket/IXSelectInterruptPipe.cpp

@@ -0,0 +1,138 @@
+/*
+ *  IXSelectInterruptPipe.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+//
+// On macOS we use UNIX pipes to wake up select.
+//
+
+#include "IXSelectInterruptPipe.h"
+
+#include <unistd.h> // for write
+#include <string.h> // for strerror
+#include <fcntl.h>
+#include <errno.h>
+#include <assert.h>
+#include <sstream>
+
+namespace ix
+{
+    // File descriptor at index 0 in _fildes is the read end of the pipe
+    // File descriptor at index 1 in _fildes is the write end of the pipe
+    const int SelectInterruptPipe::kPipeReadIndex = 0;
+    const int SelectInterruptPipe::kPipeWriteIndex = 1;
+
+    SelectInterruptPipe::SelectInterruptPipe()
+    {
+        _fildes[kPipeReadIndex] = -1;
+        _fildes[kPipeWriteIndex] = -1;
+    }
+
+    SelectInterruptPipe::~SelectInterruptPipe()
+    {
+        ::close(_fildes[kPipeReadIndex]);
+        ::close(_fildes[kPipeWriteIndex]);
+        _fildes[kPipeReadIndex] = -1;
+        _fildes[kPipeWriteIndex] = -1;
+    }
+
+    bool SelectInterruptPipe::init(std::string& errorMsg)
+    {
+        // calling init twice is a programming error
+        assert(_fildes[kPipeReadIndex] == -1);
+        assert(_fildes[kPipeWriteIndex] == -1);
+
+        if (pipe(_fildes) < 0)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in pipe() call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeReadIndex], F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., O_NONBLOCK) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETFL, O_NONBLOCK) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., O_NONBLOCK) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+#ifdef F_SETNOSIGPIPE
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETNOSIGPIPE, 1) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(.... F_SETNOSIGPIPE) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+
+        if (fcntl(_fildes[kPipeWriteIndex], F_SETNOSIGPIPE, 1) == -1)
+        {
+            std::stringstream ss;
+            ss << "SelectInterruptPipe::init() failed in fcntl(..., F_SETNOSIGPIPE) call"
+               << " : " << strerror(errno);
+            errorMsg = ss.str();
+
+            _fildes[kPipeReadIndex] = -1;
+            _fildes[kPipeWriteIndex] = -1;
+            return false;
+        }
+#endif
+
+        return true;
+    }
+
+    bool SelectInterruptPipe::notify(uint64_t value)
+    {
+        int fd = _fildes[kPipeWriteIndex];
+        if (fd == -1) return false;
+
+        // we should write 8 bytes for an uint64_t
+        return write(fd, &value, sizeof(value)) == 8;
+    }
+
+    // TODO: return max uint64_t for errors ?
+    uint64_t SelectInterruptPipe::read()
+    {
+        int fd = _fildes[kPipeReadIndex];
+
+        uint64_t value = 0;
+        ::read(fd, &value, sizeof(value));
+
+        return value;
+    }
+
+    bool SelectInterruptPipe::clear()
+    {
+        return true;
+    }
+
+    int SelectInterruptPipe::getFd() const
+    {
+        return _fildes[kPipeReadIndex];
+    }
+}

ixwebsocket/IXSelectInterruptPipe.h

@@ -0,0 +1,39 @@
+/*
+ *  IXSelectInterruptPipe.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018-2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include "IXSelectInterrupt.h"
+
+#include <stdint.h>
+#include <string>
+
+namespace ix
+{
+    class SelectInterruptPipe : public SelectInterrupt {
+    public:
+        SelectInterruptPipe();
+        virtual ~SelectInterruptPipe();
+
+        bool init(std::string& errorMsg) final;
+
+        bool notify(uint64_t value) final;
+        bool clear() final;
+        uint64_t read() final;
+        int getFd() const final;
+
+    private:
+        // Store file descriptors used by the communication pipe. Communication
+        // happens between a control thread and a background thread, which is
+        // blocked on select.
+        int _fildes[2];
+
+        // Used to identify the read/write idx
+        static const int kPipeReadIndex;
+        static const int kPipeWriteIndex;
+    };
+}
+

ixwebsocket/IXSocket.cpp

@@ -7,6 +7,8 @@
 #include "IXSocket.h"
 #include "IXSocketConnect.h"
 #include "IXNetSystem.h"
+#include "IXSelectInterrupt.h"
+#include "IXSelectInterruptFactory.h"
 
 #include <stdio.h>
 #include <stdlib.h>
@@ -15,20 +17,27 @@
 #include <stdint.h>
 #include <fcntl.h>
 #include <sys/types.h>
-#include <poll.h>
 
 #include <algorithm>
 #include <iostream>
 
-namespace ix 
+#ifdef min
+#undef min
+#endif
+
+namespace ix
 {
     const int Socket::kDefaultPollNoTimeout = -1; // No poll timeout by default
     const int Socket::kDefaultPollTimeout = kDefaultPollNoTimeout;
+    const uint64_t Socket::kSendRequest = 1;
+    const uint64_t Socket::kCloseRequest = 2;
+    constexpr size_t Socket::kChunkSize;
 
-    Socket::Socket(int fd) : 
-        _sockfd(fd)
+    Socket::Socket(int fd) :
+        _sockfd(fd),
+        _selectInterrupt(createSelectInterrupt())
     {
-
+        ;
     }
 
     Socket::~Socket()
@@ -36,48 +45,94 @@ namespace ix
         close();
     }
 
-    void Socket::poll(const OnPollCallback& onPollCallback, int timeoutSecs)
+    PollResultType Socket::poll(int timeoutSecs)
     {
         if (_sockfd == -1)
         {
-            onPollCallback(PollResultType_Error);
-            return;
+            return PollResultType::Error;
         }
 
-#ifdef __linux__
-        constexpr int nfds = 2;
-#else
-        constexpr int nfds = 1;
-#endif
+        return isReadyToRead(1000 * timeoutSecs);
+    }
 
-        struct pollfd fds[nfds];
-        fds[0].fd = _sockfd;
-        fds[0].events = POLLIN;
+    PollResultType Socket::select(bool readyToRead, int timeoutMs)
+    {
+        fd_set rfds;
+        fd_set wfds;
+        FD_ZERO(&rfds);
+        FD_ZERO(&wfds);
 
-#ifdef __linux__
-        fds[1].fd = _eventfd.getFd();
-        fds[1].events = POLLIN;
-#endif
-        int ret = ::poll(fds, nfds, timeoutSecs * 1000);
+        fd_set* fds = (readyToRead) ? &rfds : & wfds;
+        FD_SET(_sockfd, fds);
 
-        PollResultType pollResult = PollResultType_ReadyForRead;
+        // File descriptor used to interrupt select when needed
+        int interruptFd = _selectInterrupt->getFd();
+        if (interruptFd != -1)
+        {
+            FD_SET(interruptFd, fds);
+        }
+
+        struct timeval timeout;
+        timeout.tv_sec = timeoutMs / 1000;
+        timeout.tv_usec = (timeoutMs < 1000) ? 0 : 1000 * (timeoutMs % 1000);
+
+        // Compute the highest fd.
+        int sockfd = _sockfd;
+        int nfds = (std::max)(sockfd, interruptFd);
+
+        int ret = ::select(nfds + 1, &rfds, &wfds, nullptr,
+                           (timeoutMs < 0) ? nullptr : &timeout);
+
+        PollResultType pollResult = PollResultType::ReadyForRead;
         if (ret < 0)
         {
-            pollResult = PollResultType_Error;
+            pollResult = PollResultType::Error;
         }
         else if (ret == 0)
         {
-            pollResult = PollResultType_Timeout;
+            pollResult = PollResultType::Timeout;
+        }
+        else if (interruptFd != -1 && FD_ISSET(interruptFd, &rfds))
+        {
+            uint64_t value = _selectInterrupt->read();
+
+            if (value == kSendRequest)
+            {
+                pollResult = PollResultType::SendRequest;
+            }
+            else if (value == kCloseRequest)
+            {
+                pollResult = PollResultType::CloseRequest;
+            }
+        }
+        else if (sockfd != -1 && readyToRead && FD_ISSET(sockfd, &rfds))
+        {
+            pollResult = PollResultType::ReadyForRead;
+        }
+        else if (sockfd != -1 && !readyToRead && FD_ISSET(sockfd, &wfds))
+        {
+            pollResult = PollResultType::ReadyForWrite;
         }
 
-        onPollCallback(pollResult);
-
+        return pollResult;
     }
 
-    void Socket::wakeUpFromPoll()
+    PollResultType Socket::isReadyToRead(int timeoutMs)
     {
-        // this will wake up the thread blocked on select, only needed on Linux
-        _eventfd.notify();
+        bool readyToRead = true;
+        return select(readyToRead, timeoutMs);
+    }
+
+    PollResultType Socket::isReadyToWrite(int timeoutMs)
+    {
+        bool readyToRead = false;
+        return select(readyToRead, timeoutMs);
+    }
+
+    // Wake up from poll/select by writing to the pipe which is watched by select
+    bool Socket::wakeUpFromPoll(uint8_t wakeUpCode)
+    {
+        return _selectInterrupt->notify(wakeUpCode);
     }
 
     bool Socket::connect(const std::string& host,
@@ -87,7 +142,7 @@ namespace ix
     {
         std::lock_guard<std::mutex> lock(_socketMutex);
 
-        if (!_eventfd.clear()) return false;
+        if (!_selectInterrupt->clear()) return false;
 
         _sockfd = SocketConnect::connect(host, port, errMsg, isCancellationRequested);
         return _sockfd != -1;
@@ -105,6 +160,8 @@ namespace ix
 
     ssize_t Socket::send(char* buffer, size_t length)
     {
+        std::lock_guard<std::mutex> lock(_socketMutex);
+
         int flags = 0;
 #ifdef MSG_NOSIGNAL
         flags = MSG_NOSIGNAL;
@@ -120,6 +177,8 @@ namespace ix
 
     ssize_t Socket::recv(void* buffer, size_t length)
     {
+        std::lock_guard<std::mutex> lock(_socketMutex);
+
         int flags = 0;
 #ifdef MSG_NOSIGNAL
         flags = MSG_NOSIGNAL;
@@ -146,69 +205,9 @@ namespace ix
 #endif
     }
 
-    bool Socket::init()
+    bool Socket::init(std::string& errorMsg)
     {
-#ifdef _WIN32
-        INT rc;
-        WSADATA wsaData;
-        
-        rc = WSAStartup(MAKEWORD(2, 2), &wsaData);
-        return rc != 0;
-#else
-        return true;
-#endif
-    }
-
-    void Socket::cleanup()
-    {
-#ifdef _WIN32
-        WSACleanup();
-#endif
-    }
-
-    bool Socket::readByte(void* buffer,
-                          const CancellationRequest& isCancellationRequested)
-    {
-        while (true)
-        {
-            if (isCancellationRequested()) return false;
-
-            ssize_t ret;
-            ret = recv(buffer, 1);
-
-            // We read one byte, as needed, all good.
-            if (ret == 1)
-            {
-                return true;
-            }
-            // There is possibly something to be read, try again
-            else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
-                                 getErrno() == EAGAIN))
-            {
-                // Wait with a timeout until something is written.
-                // This way we are not busy looping
-                fd_set rfds;
-                struct timeval timeout;
-                timeout.tv_sec = 0;
-                timeout.tv_usec = 1 * 1000; // 1ms timeout
-
-                FD_ZERO(&rfds);
-                FD_SET(_sockfd, &rfds);
-
-                if (select(_sockfd + 1, &rfds, nullptr, nullptr, &timeout) < 0 &&
-                    (errno == EBADF || errno == EINVAL))
-                {
-                    return false;
-                }
-
-                continue;
-            }
-            // There was an error during the read, abort
-            else
-            {
-                return false;
-            }
-        }
+        return _selectInterrupt->init(errorMsg);
     }
 
     bool Socket::writeBytes(const std::string& str,
@@ -216,7 +215,7 @@ namespace ix
     {
         while (true)
         {
-            if (isCancellationRequested()) return false;
+            if (isCancellationRequested && isCancellationRequested()) return false;
 
             char* buffer = const_cast<char*>(str.c_str());
             int len = (int) str.size();
@@ -228,7 +227,7 @@ namespace ix
             {
                 return ret == len;
             }
-            // There is possibly something to be write, try again
+            // There is possibly something to be writen, try again
             else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
                                  getErrno() == EAGAIN))
             {
@@ -242,7 +241,42 @@ namespace ix
         }
     }
 
-    std::pair<bool, std::string> Socket::readLine(const CancellationRequest& isCancellationRequested)
+    bool Socket::readByte(void* buffer,
+                          const CancellationRequest& isCancellationRequested)
+    {
+        while (true)
+        {
+            if (isCancellationRequested && isCancellationRequested()) return false;
+
+            ssize_t ret;
+            ret = recv(buffer, 1);
+
+            // We read one byte, as needed, all good.
+            if (ret == 1)
+            {
+                return true;
+            }
+            // There is possibly something to be read, try again
+            else if (ret < 0 && (getErrno() == EWOULDBLOCK ||
+                                 getErrno() == EAGAIN))
+            {
+                // Wait with a 1ms timeout until the socket is ready to read.
+                // This way we are not busy looping
+                if (isReadyToRead(1) == PollResultType::Error)
+                {
+                    return false;
+                }
+            }
+            // There was an error during the read, abort
+            else
+            {
+                return false;
+            }
+        }
+    }
+
+    std::pair<bool, std::string> Socket::readLine(
+        const CancellationRequest& isCancellationRequested)
     {
         char c;
         std::string line;
@@ -252,7 +286,8 @@ namespace ix
         {
             if (!readByte(&c, isCancellationRequested))
             {
-                return std::make_pair(false, std::string());
+                // Return what we were able to read
+                return std::make_pair(false, line);
             }
 
             line += c;
@@ -260,4 +295,52 @@ namespace ix
 
         return std::make_pair(true, line);
     }
+
+    std::pair<bool, std::string> Socket::readBytes(
+        size_t length,
+        const OnProgressCallback& onProgressCallback,
+        const CancellationRequest& isCancellationRequested)
+    {
+        if (_readBuffer.empty())
+        {
+            _readBuffer.resize(kChunkSize);
+        }
+
+        std::vector<uint8_t> output;
+        while (output.size() != length)
+        {
+            if (isCancellationRequested && isCancellationRequested())
+            {
+                return std::make_pair(false, std::string());
+            }
+
+            size_t size = std::min(kChunkSize, length - output.size());
+            ssize_t ret = recv((char*)&_readBuffer[0], size);
+
+            if (ret <= 0 && (getErrno() != EWOULDBLOCK &&
+                             getErrno() != EAGAIN))
+            {
+                // Error
+                return std::make_pair(false, std::string());
+            }
+            else if (ret > 0)
+            {
+                output.insert(output.end(),
+                              _readBuffer.begin(),
+                              _readBuffer.begin() + ret);
+            }
+
+            if (onProgressCallback) onProgressCallback((int) output.size(), (int) length);
+
+            // Wait with a 1ms timeout until the socket is ready to read.
+            // This way we are not busy looping
+            if (isReadyToRead(1) == PollResultType::Error)
+            {
+                return std::make_pair(false, std::string());
+            }
+        }
+
+        return std::make_pair(true, std::string(output.begin(),
+                                                output.end()));
+    }
 }

ixwebsocket/IXSocket.h

@@ -10,39 +10,48 @@
 #include <functional>
 #include <mutex>
 #include <atomic>
+#include <vector>
+#include <memory>
 
 #ifdef _WIN32
 #include <BaseTsd.h>
 typedef SSIZE_T ssize_t;
 #endif
 
-#include "IXEventFd.h"
 #include "IXCancellationRequest.h"
+#include "IXProgressCallback.h"
 
-namespace ix 
+namespace ix
 {
-    enum PollResultType
+    class SelectInterrupt;
+
+    enum class PollResultType
     {
-        PollResultType_ReadyForRead = 0,
-        PollResultType_Timeout = 1,
-        PollResultType_Error = 2
+        ReadyForRead = 0,
+        ReadyForWrite = 1,
+        Timeout = 2,
+        Error = 3,
+        SendRequest = 4,
+        CloseRequest = 5
     };
 
     class Socket {
     public:
-        using OnPollCallback = std::function<void(PollResultType)>;
-
         Socket(int fd = -1);
         virtual ~Socket();
+        bool init(std::string& errorMsg);
 
         void configure();
 
-        virtual void poll(const OnPollCallback& onPollCallback,
-                          int timeoutSecs = kDefaultPollTimeout);
-        virtual void wakeUpFromPoll();
+        // Functions to check whether there is activity on the socket
+        PollResultType poll(int timeoutSecs = kDefaultPollTimeout);
+        bool wakeUpFromPoll(uint8_t wakeUpCode);
+
+        PollResultType isReadyToWrite(int timeoutMs);
+        PollResultType isReadyToRead(int timeoutMs);
 
         // Virtual methods
-        virtual bool connect(const std::string& url, 
+        virtual bool connect(const std::string& url,
                              int port,
                              std::string& errMsg,
                              const CancellationRequest& isCancellationRequested);
@@ -58,21 +67,36 @@ namespace ix
                       const CancellationRequest& isCancellationRequested);
         bool writeBytes(const std::string& str,
                         const CancellationRequest& isCancellationRequested);
-        std::pair<bool, std::string> readLine(const CancellationRequest& isCancellationRequested);
+
+        std::pair<bool, std::string> readLine(
+            const CancellationRequest& isCancellationRequested);
+        std::pair<bool, std::string> readBytes(
+            size_t length,
+            const OnProgressCallback& onProgressCallback,
+            const CancellationRequest& isCancellationRequested);
 
         static int getErrno();
-        static bool init(); // Required on Windows to initialize WinSocket
-        static void cleanup(); // Required on Windows to cleanup WinSocket
+
+        // Used as special codes for pipe communication
+        static const uint64_t kSendRequest;
+        static const uint64_t kCloseRequest;
 
     protected:
         void closeSocket(int fd);
 
         std::atomic<int> _sockfd;
         std::mutex _socketMutex;
-        EventFd _eventfd;
 
     private:
+        PollResultType select(bool readyToRead, int timeoutMs);
+
         static const int kDefaultPollTimeout;
         static const int kDefaultPollNoTimeout;
+
+        // Buffer for reading from our socket. That buffer is never resized.
+        std::vector<uint8_t> _readBuffer;
+        static constexpr size_t kChunkSize = 1 << 15;
+
+        std::shared_ptr<SelectInterrupt> _selectInterrupt;
     };
 }

ixwebsocket/IXSocketAppleSSL.cpp

@@ -50,7 +50,7 @@ OSStatus read_from_socket(SSLConnectionRef connection, void *data, size_t *len)
         else
             return noErr;
     }
-    else if (0 == status) 
+    else if (0 == status)
     {
         *len = 0;
         return errSSLClosedGraceful;
@@ -102,7 +102,7 @@ OSStatus write_to_socket(SSLConnectionRef connection, const void *data, size_t *
     else
     {
         *len = 0;
-        if (EAGAIN == errno) 
+        if (EAGAIN == errno)
         {
             return errSSLWouldBlock;
         }
@@ -141,7 +141,7 @@ std::string getSSLErrorDescription(OSStatus status)
 
 } // anonymous namespace
 
-namespace ix 
+namespace ix
 {
     SocketAppleSSL::SocketAppleSSL(int fd) : Socket(fd),
         _sslContext(nullptr)
@@ -176,11 +176,11 @@ namespace ix
 
             do {
                 status = SSLHandshake(_sslContext);
-            } while (errSSLWouldBlock == status || 
+            } while (errSSLWouldBlock == status ||
                      errSSLServerAuthCompleted == status);
         }
 
-        if (noErr != status) 
+        if (noErr != status)
         {
             errMsg = getSSLErrorDescription(status);
             close();
@@ -230,7 +230,7 @@ namespace ix
     ssize_t SocketAppleSSL::recv(void* buf, size_t nbyte)
     {
         OSStatus status = errSSLWouldBlock;
-        while (errSSLWouldBlock == status) 
+        while (errSSLWouldBlock == status)
         {
             size_t processed = 0;
             std::lock_guard<std::mutex> lock(_mutex);
@@ -239,7 +239,7 @@ namespace ix
             if (processed > 0)
                 return (ssize_t) processed;
 
-            // The connection was reset, inform the caller that this 
+            // The connection was reset, inform the caller that this
             // Socket should close
             if (status == errSSLClosedGraceful ||
                 status == errSSLClosedNoNotify ||

ixwebsocket/IXSocketAppleSSL.h

@@ -14,15 +14,15 @@
 
 #include <mutex>
 
-namespace ix 
+namespace ix
 {
-    class SocketAppleSSL : public Socket 
+    class SocketAppleSSL : public Socket
     {
     public:
         SocketAppleSSL(int fd = -1);
         ~SocketAppleSSL();
 
-        virtual bool connect(const std::string& host, 
+        virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg,
                              const CancellationRequest& isCancellationRequested) final;

ixwebsocket/IXSocketConnect.cpp

@@ -30,7 +30,7 @@ namespace
     }
 }
 
-namespace ix 
+namespace ix
 {
     //
     // This function can be cancelled every 50 ms
@@ -42,7 +42,7 @@ namespace ix
                                         const CancellationRequest& isCancellationRequested)
     {
         errMsg = "no error";
-        
+
         int fd = socket(address->ai_family,
                         address->ai_socktype,
                         address->ai_protocol);
@@ -57,22 +57,22 @@ namespace ix
         SocketConnect::configure(fd);
 
         if (::connect(fd, address->ai_addr, address->ai_addrlen) == -1
-            && errno != EINPROGRESS)
+            && errno != EINPROGRESS && errno != 0)
         {
-            closeSocket(fd);
             errMsg = strerror(errno);
+            closeSocket(fd);
             return -1;
         }
 
         for (;;)
         {
-            if (isCancellationRequested()) // Must handle timeout as well
+            if (isCancellationRequested && isCancellationRequested()) // Must handle timeout as well
             {
                 closeSocket(fd);
                 errMsg = "Cancelled";
                 return -1;
             }
-            
+
             // Use select to check the status of the new connection
             struct timeval timeout;
             timeout.tv_sec = 0;
@@ -179,7 +179,7 @@ namespace ix
         // 3. (apple) prevent SIGPIPE from being emitted when the remote end disconnect
 #ifdef SO_NOSIGPIPE
         int value = 1;
-        setsockopt(sockfd, SOL_SOCKET, SO_NOSIGPIPE, 
+        setsockopt(sockfd, SOL_SOCKET, SO_NOSIGPIPE,
                    (void *)&value, sizeof(value));
 #endif
     }

ixwebsocket/IXSocketConnect.h

@@ -12,7 +12,7 @@
 
 struct addrinfo;
 
-namespace ix 
+namespace ix
 {
     class SocketConnect {
     public:

ixwebsocket/IXSocketFactory.cpp

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

ixwebsocket/IXSocketFactory.h

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

ixwebsocket/IXSocketOpenSSL.cpp

@@ -18,12 +18,13 @@
 #include <errno.h>
 #define socketerrno errno
 
-namespace ix 
+namespace ix
 {
     std::atomic<bool> SocketOpenSSL::_openSSLInitializationSuccessful(false);
+    std::once_flag SocketOpenSSL::_openSSLInitFlag;
 
     SocketOpenSSL::SocketOpenSSL(int fd) : Socket(fd),
-        _ssl_connection(nullptr), 
+        _ssl_connection(nullptr),
         _ssl_context(nullptr)
     {
         std::call_once(_openSSLInitFlag, &SocketOpenSSL::openSSLInitialize, this);
@@ -80,7 +81,7 @@ namespace ix
                 return "OpenSSL failed - underlying BIO reported an I/O error";
             }
         }
-        else if (err == SSL_ERROR_SSL) 
+        else if (err == SSL_ERROR_SSL)
         {
             e = ERR_get_error();
             std::string errMsg("OpenSSL failed - ");
@@ -149,7 +150,7 @@ namespace ix
 #if OPENSSL_VERSION_NUMBER < 0x10100000L
         // Check server name
         bool hostname_verifies_ok = false;
-        STACK_OF(GENERAL_NAME) *san_names = 
+        STACK_OF(GENERAL_NAME) *san_names =
             (STACK_OF(GENERAL_NAME)*) X509_get_ext_d2i((X509 *)server_cert,
                                                        NID_subject_alt_name, NULL, NULL);
         if (san_names)
@@ -160,8 +161,8 @@ namespace ix
                 if (sk_name->type == GEN_DNS)
                 {
                     char *name = (char *)ASN1_STRING_data(sk_name->d.dNSName);
-                    if ((size_t)ASN1_STRING_length(sk_name->d.dNSName) == strlen(name) && 
-                        checkHost(hostname, name)) 
+                    if ((size_t)ASN1_STRING_length(sk_name->d.dNSName) == strlen(name) &&
+                        checkHost(hostname, name))
                     {
                         hostname_verifies_ok = true;
                         break;
@@ -185,8 +186,8 @@ namespace ix
                     ASN1_STRING *cn_asn1 = X509_NAME_ENTRY_get_data(cn_entry);
                     char *cn = (char *)ASN1_STRING_data(cn_asn1);
 
-                    if ((size_t)ASN1_STRING_length(cn_asn1) == strlen(cn) && 
-                       checkHost(hostname, cn)) 
+                    if ((size_t)ASN1_STRING_length(cn_asn1) == strlen(cn) &&
+                       checkHost(hostname, cn))
                     {
                         hostname_verifies_ok = true;
                     }
@@ -205,7 +206,7 @@ namespace ix
         return true;
     }
 
-    bool SocketOpenSSL::openSSLHandshake(const std::string& host, std::string& errMsg) 
+    bool SocketOpenSSL::openSSLHandshake(const std::string& host, std::string& errMsg)
     {
         while (true)
         {
@@ -341,7 +342,7 @@ namespace ix
 
             ERR_clear_error();
             ssize_t write_result = SSL_write(_ssl_connection, buf + sent, (int) nbyte);
-            int reason = SSL_get_error(_ssl_connection, write_result);
+            int reason = SSL_get_error(_ssl_connection, (int) write_result);
 
             if (reason == SSL_ERROR_NONE) {
                 nbyte -= write_result;
@@ -381,7 +382,7 @@ namespace ix
                 return read_result;
             }
 
-            int reason = SSL_get_error(_ssl_connection, read_result);
+            int reason = SSL_get_error(_ssl_connection, (int) read_result);
 
             if (reason == SSL_ERROR_WANT_READ || reason == SSL_ERROR_WANT_WRITE)
             {

ixwebsocket/IXSocketOpenSSL.h

@@ -17,15 +17,15 @@
 
 #include <mutex>
 
-namespace ix 
+namespace ix
 {
-    class SocketOpenSSL : public Socket 
+    class SocketOpenSSL : public Socket
     {
     public:
         SocketOpenSSL(int fd = -1);
         ~SocketOpenSSL();
 
-        virtual bool connect(const std::string& host, 
+        virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg,
                              const CancellationRequest& isCancellationRequested) final;
@@ -50,7 +50,7 @@ namespace ix
         const SSL_METHOD* _ssl_method;
         mutable std::mutex _mutex;  // OpenSSL routines are not thread-safe
 
-        std::once_flag _openSSLInitFlag;
+        static std::once_flag _openSSLInitFlag;
         static std::atomic<bool> _openSSLInitializationSuccessful;
     };
 

ixwebsocket/IXSocketSChannel.cpp

@@ -18,7 +18,6 @@
 # include <ws2def.h>
 # include <WS2tcpip.h>
 # include <schannel.h>
-# include <sslsock.h>
 # include <io.h>
 
 #define WIN32_LEAN_AND_MEAN
@@ -47,7 +46,7 @@
 // link with ntdsapi.lib for DsMakeSpn function
 #pragma comment(lib, "ntdsapi.lib")
 
-// The following function assumes that Winsock 
+// The following function assumes that Winsock
 // has already been initialized
 
 
@@ -59,7 +58,7 @@
 # error("This file should only be built on Windows")
 #endif
 
-namespace ix 
+namespace ix
 {
     SocketSChannel::SocketSChannel()
     {
@@ -68,17 +67,17 @@ namespace ix
 
     SocketSChannel::~SocketSChannel()
     {
-        
+
     }
 
     bool SocketSChannel::connect(const std::string& host,
                                  int port,
                                  std::string& errMsg)
     {
-        return Socket::connect(host, port, errMsg);
+        return Socket::connect(host, port, errMsg, nullptr);
     }
 
-    
+
     void SocketSChannel::secureSocket()
     {
         // there will be a lot to do here ...
@@ -89,17 +88,17 @@ namespace ix
         Socket::close();
     }
 
-    int SocketSChannel::send(char* buf, size_t nbyte)
+    ssize_t SocketSChannel::send(char* buf, size_t nbyte)
     {
         return Socket::send(buf, nbyte);
     }
 
-    int SocketSChannel::send(const std::string& buffer)
+    ssize_t SocketSChannel::send(const std::string& buffer)
     {
         return Socket::send(buffer);
     }
 
-    int SocketSChannel::recv(void* buf, size_t nbyte)
+    ssize_t SocketSChannel::recv(void* buf, size_t nbyte)
     {
         return Socket::recv(buf, nbyte);
     }

ixwebsocket/IXSocketSChannel.h

@@ -8,15 +8,15 @@
 
 #include "IXSocket.h"
 
-namespace ix 
+namespace ix
 {
-    class SocketSChannel : public Socket 
+    class SocketSChannel : public Socket
     {
     public:
         SocketSChannel();
         ~SocketSChannel();
 
-        virtual bool connect(const std::string& host, 
+        virtual bool connect(const std::string& host,
                              int port,
                              std::string& errMsg) final;
         virtual void close() final;
@@ -24,9 +24,9 @@ namespace ix
         // The important override
         virtual void secureSocket() final;
 
-        virtual int send(char* buffer, size_t length) final;
-        virtual int send(const std::string& buffer) final;
-        virtual int recv(void* buffer, size_t length) final;
+        virtual ssize_t send(char* buffer, size_t length) final;
+        virtual ssize_t send(const std::string& buffer) final;
+        virtual ssize_t recv(void* buffer, size_t length) final;
 
     private:
     };

ixwebsocket/IXSocketServer.cpp

@@ -13,8 +13,9 @@
 #include <sstream>
 #include <future>
 #include <string.h>
+#include <assert.h>
 
-namespace ix 
+namespace ix
 {
     const int SocketServer::kDefaultPort(8080);
     const std::string SocketServer::kDefaultHost("127.0.0.1");
@@ -29,7 +30,8 @@ namespace ix
         _host(host),
         _backlog(backlog),
         _maxConnections(maxConnections),
-        _stop(false)
+        _stop(false),
+        _connectionStateFactory(&ConnectionState::createConnectionState)
     {
 
     }
@@ -83,7 +85,7 @@ namespace ix
         server.sin_family = AF_INET;
         server.sin_port   = htons(_port);
 
-        // Using INADDR_ANY trigger a pop-up box as binding to any address is detected 
+        // Using INADDR_ANY trigger a pop-up box as binding to any address is detected
         // by the osx firewall. We need to codesign the binary with a self-signed cert
         // to allow that, but this is a bit of a pain. (this is what node or python would do).
         //
@@ -133,8 +135,23 @@ namespace ix
         _conditionVariable.wait(lock);
     }
 
+    void SocketServer::stopAcceptingConnections()
+    {
+        _stop = true;
+    }
+
     void SocketServer::stop()
     {
+        while (true)
+        {
+            if (closeTerminatedThreads()) break;
+
+            // wait 10ms and try again later.
+            // we could have a timeout, but if we exit of here
+            // we leaked threads, it is quite bad.
+            std::this_thread::sleep_for(std::chrono::milliseconds(10));
+        }
+
         if (!_thread.joinable()) return; // nothing to do
 
         _stop = true;
@@ -145,18 +162,58 @@ namespace ix
         ::close(_serverFd);
     }
 
+    void SocketServer::setConnectionStateFactory(
+        const ConnectionStateFactory& connectionStateFactory)
+    {
+        _connectionStateFactory = connectionStateFactory;
+    }
+
+    //
+    // join the threads for connections that have been closed
+    //
+    // When a connection is closed by a client, the connection state terminated
+    // field becomes true, and we can use that to know that we can join that thread
+    // and remove it from our _connectionsThreads data structure (a list).
+    //
+    bool SocketServer::closeTerminatedThreads()
+    {
+        std::lock_guard<std::mutex> lock(_connectionsThreadsMutex);
+        auto it = _connectionsThreads.begin();
+        auto itEnd  = _connectionsThreads.end();
+
+        while (it != itEnd)
+        {
+            auto& connectionState = it->first;
+            auto& thread = it->second;
+
+            if (!connectionState->isTerminated())
+            {
+                ++it;
+                continue;
+            }
+
+            if (thread.joinable()) thread.join();
+            it = _connectionsThreads.erase(it);
+        }
+
+        return _connectionsThreads.empty();
+    }
+
     void SocketServer::run()
     {
         // Set the socket to non blocking mode, so that accept calls are not blocking
         SocketConnect::configure(_serverFd);
 
-        // Return value of std::async, ignored
-        std::future<void> f;
-
         for (;;)
         {
             if (_stop) return;
 
+            // Garbage collection to shutdown/join threads for closed connections.
+            // We could run this in its own thread, so that we dont need to accept
+            // a new connection to close a thread.
+            // We could also use a condition variable to be notify when we need to do this
+            closeTerminatedThreads();
+
             // Use select to check whether a new connection is in progress
             fd_set rfds;
             struct timeval timeout;
@@ -214,14 +271,22 @@ namespace ix
                 continue;
             }
 
+            std::shared_ptr<ConnectionState> connectionState;
+            if (_connectionStateFactory)
+            {
+                connectionState = _connectionStateFactory();
+            }
+
+            if (_stop) return;
+
             // Launch the handleConnection work asynchronously in its own thread.
-            //
-            // the destructor of a future returned by std::async blocks, 
-            // so we need to declare it outside of this loop
-            f = std::async(std::launch::async,
-                           &SocketServer::handleConnection,
-                           this,
-                           clientFd);
+            std::lock_guard<std::mutex> lock(_conditionVariableMutex);
+            _connectionsThreads.push_back(std::make_pair(
+                    connectionState,
+                    std::thread(&SocketServer::handleConnection,
+                                this,
+                                clientFd,
+                                connectionState)));
         }
     }
 }

ixwebsocket/IXSocketServer.h

@@ -6,20 +6,30 @@
 
 #pragma once
 
+#include "IXConnectionState.h"
+
 #include <utility> // pair
 #include <string>
 #include <set>
 #include <thread>
+#include <list>
 #include <mutex>
 #include <functional>
 #include <memory>
 #include <atomic>
 #include <condition_variable>
 
-namespace ix 
+namespace ix
 {
     class SocketServer {
     public:
+        using ConnectionStateFactory = std::function<std::shared_ptr<ConnectionState>()>;
+
+        // Each connection is handled by its own worker thread.
+        // We use a list as we only care about remove and append operations.
+        using ConnectionThreads = std::list<std::pair<std::shared_ptr<ConnectionState>,
+                                                      std::thread>>;
+
         SocketServer(int port = SocketServer::kDefaultPort,
                      const std::string& host = SocketServer::kDefaultHost,
                      int backlog = SocketServer::kDefaultTcpBacklog,
@@ -27,6 +37,11 @@ namespace ix
         virtual ~SocketServer();
         virtual void stop();
 
+        // It is possible to override ConnectionState through inheritance
+        // this method allows user to change the factory by returning an object
+        // that inherits from ConnectionState but has its own methods.
+        void setConnectionStateFactory(const ConnectionStateFactory& connectionStateFactory);
+
         const static int kDefaultPort;
         const static std::string kDefaultHost;
         const static int kDefaultTcpBacklog;
@@ -42,6 +57,8 @@ namespace ix
         void logError(const std::string& str);
         void logInfo(const std::string& str);
 
+        void stopAcceptingConnections();
+
     private:
         // Member variables
         int _port;
@@ -54,15 +71,29 @@ namespace ix
 
         std::mutex _logMutex;
 
+        // background thread to wait for incoming connections
         std::atomic<bool> _stop;
         std::thread _thread;
 
+        // the list of (connectionState, threads) for each connections
+        ConnectionThreads _connectionsThreads;
+        std::mutex _connectionsThreadsMutex;
+
+        // used to have the main control thread for a server
+        // wait for a 'terminate' notification without busy polling
         std::condition_variable _conditionVariable;
         std::mutex _conditionVariableMutex;
 
+        // the factory to create ConnectionState objects
+        ConnectionStateFactory _connectionStateFactory;
+
         // Methods
         void run();
-        virtual void handleConnection(int fd) = 0;
+        virtual void handleConnection(int fd,
+                                      std::shared_ptr<ConnectionState> connectionState) = 0;
         virtual size_t getConnectedClientsCount() = 0;
+
+        // Returns true if all connection threads are joined
+        bool closeTerminatedThreads();
     };
 }

ixwebsocket/IXUrlParser.cpp

@@ -0,0 +1,104 @@
+/*
+ *  IXUrlParser.cpp
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXUrlParser.h"
+
+#include <iostream>
+#include <sstream>
+
+
+namespace ix
+{
+    //
+    // The only difference between those 2 regex is the protocol
+    //
+    std::regex UrlParser::_httpRegex("(http|https)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
+    std::regex UrlParser::_webSocketRegex("(ws|wss)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
+
+    bool UrlParser::parse(const std::string& url,
+                          std::string& protocol,
+                          std::string& host,
+                          std::string& path,
+                          std::string& query,
+                          int& port,
+                          bool websocket)
+    {
+        std::cmatch what;
+        if (!regex_match(url.c_str(), what,
+                         websocket ? _webSocketRegex : _httpRegex))
+        {
+            return false;
+        }
+
+        std::string portStr;
+
+        protocol = std::string(what[1].first, what[1].second);
+        host     = std::string(what[2].first, what[2].second);
+        portStr  = std::string(what[3].first, what[3].second);
+        path     = std::string(what[4].first, what[4].second);
+        query    = std::string(what[5].first, what[5].second);
+
+        if (portStr.empty())
+        {
+            if (protocol == "ws" || protocol == "http")
+            {
+                port = 80;
+            }
+            else if (protocol == "wss" || protocol == "https")
+            {
+                port = 443;
+            }
+            else
+            {
+                // Invalid protocol. Should be caught by regex check
+                // but this missing branch trigger cpplint linter.
+                return false;
+            }
+        }
+        else
+        {
+            std::stringstream ss;
+            ss << portStr;
+            ss >> port;
+        }
+
+        if (path.empty())
+        {
+            path = "/";
+        }
+        else if (path[0] != '/')
+        {
+            path = '/' + path;
+        }
+
+        if (!query.empty())
+        {
+            path += "?";
+            path += query;
+        }
+
+        return true;
+    }
+
+    void UrlParser::printUrl(const std::string& url, bool websocket)
+    {
+        std::string protocol, host, path, query;
+        int port {0};
+
+        if (!parse(url, protocol, host, path, query, port, websocket))
+        {
+            return;
+        }
+
+        std::cout << "[" << url << "]" << std::endl;
+        std::cout << protocol << std::endl;
+        std::cout << host << std::endl;
+        std::cout << port << std::endl;
+        std::cout << path << std::endl;
+        std::cout << query << std::endl;
+        std::cout << "-------------------------------" << std::endl;
+    }
+}

ixwebsocket/IXUrlParser.h

@@ -0,0 +1,31 @@
+/*
+ *  IXUrlParser.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2019 Machine Zone, Inc. All rights reserved.
+ */
+
+#pragma once
+
+#include <string>
+#include <regex>
+
+namespace ix
+{
+    class UrlParser
+    {
+    public:
+        static bool parse(const std::string& url,
+                          std::string& protocol,
+                          std::string& host,
+                          std::string& path,
+                          std::string& query,
+                          int& port,
+                          bool websocket);
+
+        static void printUrl(const std::string& url, bool websocket);
+
+    private:
+        static std::regex _httpRegex;
+        static std::regex _webSocketRegex;
+    };
+}

ixwebsocket/IXWebSocket.cpp

@@ -31,26 +31,30 @@ namespace ix
 {
     OnTrafficTrackerCallback WebSocket::_onTrafficTrackerCallback = nullptr;
     const int WebSocket::kDefaultHandShakeTimeoutSecs(60);
-    const int WebSocket::kDefaultHeartBeatPeriod(-1);
+    const int WebSocket::kDefaultPingIntervalSecs(-1);
+    const int WebSocket::kDefaultPingTimeoutSecs(-1);
+    const bool WebSocket::kDefaultEnablePong(true);
 
     WebSocket::WebSocket() :
         _onMessageCallback(OnMessageCallback()),
         _stop(false),
         _automaticReconnection(true),
         _handshakeTimeoutSecs(kDefaultHandShakeTimeoutSecs),
-        _heartBeatPeriod(kDefaultHeartBeatPeriod)
+        _enablePong(kDefaultEnablePong),
+        _pingIntervalSecs(kDefaultPingIntervalSecs),
+        _pingTimeoutSecs(kDefaultPingTimeoutSecs)
     {
         _ws.setOnCloseCallback(
-            [this](uint16_t code, const std::string& reason, size_t wireSize)
+            [this](uint16_t code, const std::string& reason, size_t wireSize, bool remote)
             {
                 _onMessageCallback(WebSocket_MessageType_Close, "", wireSize,
                                    WebSocketErrorInfo(), WebSocketOpenInfo(),
-                                   WebSocketCloseInfo(code, reason));
+                                   WebSocketCloseInfo(code, reason, remote));
             }
         );
     }
 
-    WebSocket::~WebSocket() 
+    WebSocket::~WebSocket()
     {
         stop();
     }
@@ -79,16 +83,52 @@ namespace ix
         return _perMessageDeflateOptions;
     }
 
-    void WebSocket::setHeartBeatPeriod(int hearBeatPeriod)
+    void WebSocket::setHeartBeatPeriod(int heartBeatPeriodSecs)
     {
         std::lock_guard<std::mutex> lock(_configMutex);
-        _heartBeatPeriod = hearBeatPeriod;
+        _pingIntervalSecs = heartBeatPeriodSecs;
     }
 
     int WebSocket::getHeartBeatPeriod() const
     {
         std::lock_guard<std::mutex> lock(_configMutex);
-        return _heartBeatPeriod;
+        return _pingIntervalSecs;
+    }
+
+    void WebSocket::setPingInterval(int pingIntervalSecs)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _pingIntervalSecs = pingIntervalSecs;
+    }
+
+    int WebSocket::getPingInterval() const
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        return _pingIntervalSecs;
+    }
+
+    void WebSocket::setPingTimeout(int pingTimeoutSecs)
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _pingTimeoutSecs = pingTimeoutSecs;
+    }
+
+    int WebSocket::getPingTimeout() const
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        return _pingTimeoutSecs;
+    }
+
+    void WebSocket::enablePong()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _enablePong = true;
+    }
+
+    void WebSocket::disablePong()
+    {
+        std::lock_guard<std::mutex> lock(_configMutex);
+        _enablePong = false;
     }
 
     void WebSocket::start()
@@ -125,7 +165,9 @@ namespace ix
         {
             std::lock_guard<std::mutex> lock(_configMutex);
             _ws.configure(_perMessageDeflateOptions,
-                          _heartBeatPeriod);
+                          _enablePong,
+                          _pingIntervalSecs,
+                          _pingTimeoutSecs);
         }
 
         WebSocketInitResult status = _ws.connectToUrl(_url, timeoutSecs);
@@ -135,7 +177,7 @@ namespace ix
         }
 
         _onMessageCallback(WebSocket_MessageType_Open, "", 0,
-                           WebSocketErrorInfo(), 
+                           WebSocketErrorInfo(),
                            WebSocketOpenInfo(status.uri, status.headers),
                            WebSocketCloseInfo());
         return status;
@@ -145,7 +187,10 @@ namespace ix
     {
         {
             std::lock_guard<std::mutex> lock(_configMutex);
-            _ws.configure(_perMessageDeflateOptions, _heartBeatPeriod);
+            _ws.configure(_perMessageDeflateOptions,
+                          _enablePong,
+                          _pingIntervalSecs,
+                          _pingTimeoutSecs);
         }
 
         WebSocketInitResult status = _ws.connectToSocket(fd, timeoutSecs);
@@ -155,7 +200,7 @@ namespace ix
         }
 
         _onMessageCallback(WebSocket_MessageType_Open, "", 0,
-                           WebSocketErrorInfo(), 
+                           WebSocketErrorInfo(),
                            WebSocketOpenInfo(status.uri, status.headers),
                            WebSocketCloseInfo());
         return status;
@@ -184,16 +229,12 @@ namespace ix
         using millis = std::chrono::duration<double, std::milli>;
         millis duration;
 
-        while (true) 
+        // Try to connect only once when we don't have automaticReconnection setup
+        if (!isConnected() && !isClosing() && !_stop && !_automaticReconnection)
         {
-            if (isConnected() || isClosing() || _stop || !_automaticReconnection)
-            {
-                break;
-            }
-
             status = connect(_handshakeTimeoutSecs);
 
-            if (!status.success && !_stop)
+            if (!status.success)
             {
                 duration = millis(calculateRetryWaitMilliseconds(retries++));
 
@@ -204,17 +245,47 @@ namespace ix
                 _onMessageCallback(WebSocket_MessageType_Error, "", 0,
                                    connectErr, WebSocketOpenInfo(),
                                    WebSocketCloseInfo());
+            }
+        }
+        else
+        {
+            // Otherwise try to reconnect perpertually
+            while (true)
+            {
+                if (isConnected() || isClosing() || _stop || !_automaticReconnection)
+                {
+                    break;
+                }
 
-                std::this_thread::sleep_for(duration);
+                status = connect(_handshakeTimeoutSecs);
+
+                if (!status.success)
+                {
+                    duration = millis(calculateRetryWaitMilliseconds(retries++));
+
+                    connectErr.retries = retries;
+                    connectErr.wait_time = duration.count();
+                    connectErr.reason = status.errorStr;
+                    connectErr.http_status = status.http_status;
+                    _onMessageCallback(WebSocket_MessageType_Error, "", 0,
+                                       connectErr, WebSocketOpenInfo(),
+                                       WebSocketCloseInfo());
+                    
+                    // Only sleep if we aren't in the middle of stopping
+                    if (!_stop)
+                    {
+                        std::this_thread::sleep_for(duration);
+                    }
+                }
             }
         }
     }
 
     void WebSocket::run()
     {
-        setThreadName(_url);
+        setThreadName(getUrl());
 
-        while (true) 
+        while (true)
         {
             if (_stop) return;
 
@@ -223,7 +294,7 @@ namespace ix
 
             if (_stop) return;
 
-            // 2. Poll to see if there's any new data available 
+            // 2. Poll to see if there's any new data available
             _ws.poll();
 
             if (_stop) return;
@@ -252,6 +323,11 @@ namespace ix
                         {
                             webSocketMessageType = WebSocket_MessageType_Pong;
                         } break;
+
+                        case WebSocketTransport::FRAGMENT:
+                        {
+                            webSocketMessageType = WebSocket_MessageType_Fragment;
+                        } break;
                     }
 
                     WebSocketErrorInfo webSocketErrorInfo;
@@ -267,13 +343,13 @@ namespace ix
             // 4. In blocking mode, getting out of this function is triggered by
             //    an explicit disconnection from the callback, or by the remote end
             //    closing the connection, ie isConnected() == false.
-            if (!_thread.joinable() && !isConnected() && !_automaticReconnection) return;
+            if (!isConnected() && !_automaticReconnection) return;
         }
     }
 
     void WebSocket::setOnMessageCallback(const OnMessageCallback& callback)
     {
-        _onMessageCallback = callback; 
+        _onMessageCallback = callback;
     }
 
     void WebSocket::setTrafficTrackerCallback(const OnTrafficTrackerCallback& callback)
@@ -294,9 +370,16 @@ namespace ix
         }
     }
 
-    WebSocketSendInfo WebSocket::send(const std::string& text)
+    WebSocketSendInfo WebSocket::send(const std::string& text,
+                                      const OnProgressCallback& onProgressCallback)
     {
-        return sendMessage(text, false);
+        return sendMessage(text, SendMessageKind::Binary, onProgressCallback);
+    }
+
+    WebSocketSendInfo WebSocket::sendText(const std::string& text,
+                                          const OnProgressCallback& onProgressCallback)
+    {
+        return sendMessage(text, SendMessageKind::Text, onProgressCallback);
     }
 
     WebSocketSendInfo WebSocket::ping(const std::string& text)
@@ -305,10 +388,12 @@ namespace ix
         constexpr size_t pingMaxPayloadSize = 125;
         if (text.size() > pingMaxPayloadSize) return WebSocketSendInfo(false);
 
-        return sendMessage(text, true);
+        return sendMessage(text, SendMessageKind::Ping);
     }
 
-    WebSocketSendInfo WebSocket::sendMessage(const std::string& text, bool ping)
+    WebSocketSendInfo WebSocket::sendMessage(const std::string& text,
+                                             SendMessageKind sendMessageKind,
+                                             const OnProgressCallback& onProgressCallback)
     {
         if (!isConnected()) return WebSocketSendInfo(false);
 
@@ -324,13 +409,22 @@ namespace ix
         std::lock_guard<std::mutex> lock(_writeMutex);
         WebSocketSendInfo webSocketSendInfo;
 
-        if (ping)
+        switch (sendMessageKind)
         {
-            webSocketSendInfo = _ws.sendPing(text);
-        }
-        else
-        {
-            webSocketSendInfo = _ws.sendBinary(text);
+            case SendMessageKind::Text:
+            {
+                webSocketSendInfo = _ws.sendText(text, onProgressCallback);
+            } break;
+
+            case SendMessageKind::Binary:
+            {
+                webSocketSendInfo = _ws.sendBinary(text, onProgressCallback);
+            } break;
+
+            case SendMessageKind::Ping:
+            {
+                webSocketSendInfo = _ws.sendPing(text);
+            } break;
         }
 
         WebSocket::invokeTrafficTrackerCallback(webSocketSendInfo.wireSize, false);
@@ -340,7 +434,7 @@ namespace ix
 
     ReadyState WebSocket::getReadyState() const
     {
-        switch (_ws.getReadyState()) 
+        switch (_ws.getReadyState())
         {
             case ix::WebSocketTransport::OPEN: return WebSocket_ReadyState_Open;
             case ix::WebSocketTransport::CONNECTING: return WebSocket_ReadyState_Connecting;
@@ -371,4 +465,9 @@ namespace ix
     {
         _automaticReconnection = false;
     }
+
+    size_t WebSocket::bufferedAmount() const
+    {
+        return _ws.bufferedAmount();
+    }
 }

ixwebsocket/IXWebSocket.h

@@ -19,11 +19,12 @@
 #include "IXWebSocketSendInfo.h"
 #include "IXWebSocketPerMessageDeflateOptions.h"
 #include "IXWebSocketHttpHeaders.h"
+#include "IXProgressCallback.h"
 
 namespace ix
 {
     // https://developer.mozilla.org/en-US/docs/Web/API/WebSocket#Ready_state_constants
-    enum ReadyState 
+    enum ReadyState
     {
         WebSocket_ReadyState_Connecting = 0,
         WebSocket_ReadyState_Open = 1,
@@ -38,7 +39,8 @@ namespace ix
         WebSocket_MessageType_Close = 2,
         WebSocket_MessageType_Error = 3,
         WebSocket_MessageType_Ping = 4,
-        WebSocket_MessageType_Pong = 5
+        WebSocket_MessageType_Pong = 5,
+        WebSocket_MessageType_Fragment = 6
     };
 
     struct WebSocketOpenInfo
@@ -59,11 +61,14 @@ namespace ix
     {
         uint16_t code;
         std::string reason;
+        bool remote;
 
         WebSocketCloseInfo(uint16_t c = 0,
-                           const std::string& r = std::string())
+                           const std::string& r = std::string(),
+                           bool rem = false)
             : code(c)
             , reason(r)
+            , remote(rem)
         {
             ;
         }
@@ -78,7 +83,7 @@ namespace ix
 
     using OnTrafficTrackerCallback = std::function<void(size_t size, bool incoming)>;
 
-    class WebSocket 
+    class WebSocket
     {
     public:
         WebSocket();
@@ -87,7 +92,11 @@ namespace ix
         void setUrl(const std::string& url);
         void setPerMessageDeflateOptions(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions);
         void setHandshakeTimeout(int handshakeTimeoutSecs);
-        void setHeartBeatPeriod(int hearBeatPeriod);
+        void setHeartBeatPeriod(int heartBeatPeriodSecs);
+        void setPingInterval(int pingIntervalSecs); // alias of setHeartBeatPeriod
+        void setPingTimeout(int pingTimeoutSecs);
+        void enablePong();
+        void disablePong();
 
         // Run asynchronously, by calling start and stop.
         void start();
@@ -97,7 +106,10 @@ namespace ix
         WebSocketInitResult connect(int timeoutSecs);
         void run();
 
-        WebSocketSendInfo send(const std::string& text);
+        WebSocketSendInfo send(const std::string& text,
+                               const OnProgressCallback& onProgressCallback = nullptr);
+        WebSocketSendInfo sendText(const std::string& text,
+                                   const OnProgressCallback& onProgressCallback = nullptr);
         WebSocketSendInfo ping(const std::string& text);
         void close();
 
@@ -109,13 +121,18 @@ namespace ix
         const std::string& getUrl() const;
         const WebSocketPerMessageDeflateOptions& getPerMessageDeflateOptions() const;
         int getHeartBeatPeriod() const;
+        int getPingInterval() const;
+        int getPingTimeout() const;
+        size_t bufferedAmount() const;
 
         void enableAutomaticReconnection();
         void disableAutomaticReconnection();
 
     private:
 
-        WebSocketSendInfo sendMessage(const std::string& text, bool ping);
+        WebSocketSendInfo sendMessage(const std::string& text,
+                                      SendMessageKind sendMessageKind,
+                                      const OnProgressCallback& callback = nullptr);
 
         bool isConnected() const;
         bool isClosing() const;
@@ -137,6 +154,7 @@ namespace ix
         static OnTrafficTrackerCallback _onTrafficTrackerCallback;
 
         std::atomic<bool> _stop;
+        std::atomic<bool> _backgroundThreadRunning;
         std::atomic<bool> _automaticReconnection;
         std::thread _thread;
         std::mutex _writeMutex;
@@ -144,9 +162,15 @@ namespace ix
         std::atomic<int> _handshakeTimeoutSecs;
         static const int kDefaultHandShakeTimeoutSecs;
 
-        // Optional Heartbeat
-        int _heartBeatPeriod;
-        static const int kDefaultHeartBeatPeriod;
+        // enable or disable PONG frame response to received PING frame
+        bool _enablePong;
+        static const bool kDefaultEnablePong;
+
+        // Optional ping and ping timeout
+        int _pingIntervalSecs;
+        int _pingTimeoutSecs;
+        static const int kDefaultPingIntervalSecs;
+        static const int kDefaultPingTimeoutSecs;
 
         friend class WebSocketServer;
     };

ixwebsocket/IXWebSocketErrorInfo.h

@@ -8,7 +8,7 @@
 
 #include <string>
 
-namespace ix 
+namespace ix
 {
     struct WebSocketErrorInfo
     {

ixwebsocket/IXWebSocketHandshake.cpp

@@ -6,6 +6,7 @@
 
 #include "IXWebSocketHandshake.h"
 #include "IXSocketConnect.h"
+#include "IXUrlParser.h"
 
 #include "libwshandshake.hpp"
 
@@ -16,7 +17,7 @@
 #include <algorithm>
 
 
-namespace ix 
+namespace ix
 {
     WebSocketHandshake::WebSocketHandshake(std::atomic<bool>& requestInitCancellation,
                                            std::shared_ptr<Socket> socket,
@@ -32,90 +33,6 @@ namespace ix
 
     }
 
-    bool WebSocketHandshake::parseUrl(const std::string& url,
-                                      std::string& protocol,
-                                      std::string& host,
-                                      std::string& path,
-                                      std::string& query,
-                                      int& port)
-    {
-        std::regex ex("(ws|wss)://([^/ :]+):?([^/ ]*)(/?[^ #?]*)\\x3f?([^ #]*)#?([^ ]*)");
-        std::cmatch what;
-        if (!regex_match(url.c_str(), what, ex))
-        {
-            return false;
-        }
-
-        std::string portStr;
-
-        protocol = std::string(what[1].first, what[1].second);
-        host     = std::string(what[2].first, what[2].second);
-        portStr  = std::string(what[3].first, what[3].second);
-        path     = std::string(what[4].first, what[4].second);
-        query    = std::string(what[5].first, what[5].second);
-
-        if (portStr.empty())
-        {
-            if (protocol == "ws")
-            {
-                port = 80;
-            }
-            else if (protocol == "wss")
-            {
-                port = 443;
-            }
-            else
-            {
-                // Invalid protocol. Should be caught by regex check
-                // but this missing branch trigger cpplint linter.
-                return false;
-            }
-        }
-        else
-        {
-            std::stringstream ss;
-            ss << portStr;
-            ss >> port;
-        }
-
-        if (path.empty())
-        {
-            path = "/";
-        }
-        else if (path[0] != '/')
-        {
-            path = '/' + path;
-        }
-
-        if (!query.empty())
-        {
-            path += "?";
-            path += query;
-        }
-
-        return true;
-    }
-
-    void WebSocketHandshake::printUrl(const std::string& url)
-    {
-        std::string protocol, host, path, query;
-        int port {0};
-
-        if (!WebSocketHandshake::parseUrl(url, protocol, host,
-                                          path, query, port))
-        {
-            return;
-        }
-
-        std::cout << "[" << url << "]" << std::endl;
-        std::cout << protocol << std::endl;
-        std::cout << host << std::endl;
-        std::cout << port << std::endl;
-        std::cout << path << std::endl;
-        std::cout << query << std::endl;
-        std::cout << "-------------------------------" << std::endl;
-    }
-
     std::string WebSocketHandshake::trim(const std::string& str)
     {
         std::string out(str);
@@ -171,7 +88,7 @@ namespace ix
 
     std::string WebSocketHandshake::genRandomString(const int len)
     {
-        std::string alphanum = 
+        std::string alphanum =
             "0123456789"
             "ABCDEFGH"
             "abcdefgh";
@@ -192,67 +109,12 @@ namespace ix
         return s;
     }
 
-
-    std::pair<bool, WebSocketHttpHeaders> WebSocketHandshake::parseHttpHeaders(
-        const CancellationRequest& isCancellationRequested)
-    {
-        WebSocketHttpHeaders headers;
-
-        char line[256];
-        int i;
-
-        while (true) 
-        {
-            int colon = 0;
-
-            for (i = 0;
-                 i < 2 || (i < 255 && line[i-2] != '\r' && line[i-1] != '\n');
-                 ++i)
-            {
-                if (!_socket->readByte(line+i, isCancellationRequested))
-                {
-                    return std::make_pair(false, headers);
-                }
-
-                if (line[i] == ':' && colon == 0)
-                {
-                    colon = i;
-                }
-            }
-            if (line[0] == '\r' && line[1] == '\n')
-            {
-                break;
-            }
-
-            // line is a single header entry. split by ':', and add it to our
-            // header map. ignore lines with no colon.
-            if (colon > 0)
-            {
-                line[i] = '\0';
-                std::string lineStr(line);
-                // colon is ':', colon+1 is ' ', colon+2 is the start of the value.
-                // i is end of string (\0), i-colon is length of string minus key;
-                // subtract 1 for '\0', 1 for '\n', 1 for '\r',
-                // 1 for the ' ' after the ':', and total is -4
-                std::string name(lineStr.substr(0, colon));
-                std::string value(lineStr.substr(colon + 2, i - colon - 4));
-
-                // Make the name lower case.
-                std::transform(name.begin(), name.end(), name.begin(), ::tolower);
-
-                headers[name] = value;
-            }
-        }
-
-        return std::make_pair(true, headers);
-    }
-
     WebSocketInitResult WebSocketHandshake::sendErrorResponse(int code, const std::string& reason)
     {
         std::stringstream ss;
         ss << "HTTP/1.1 ";
         ss << code;
-        ss << "\r\n";
+        ss << " ";
         ss << reason;
         ss << "\r\n";
 
@@ -277,7 +139,7 @@ namespace ix
     {
         _requestInitCancellation = false;
 
-        auto isCancellationRequested = 
+        auto isCancellationRequested =
             makeCancellationRequestWithTimeout(timeoutSecs, _requestInitCancellation);
 
         std::string errMsg;
@@ -355,7 +217,7 @@ namespace ix
             return WebSocketInitResult(false, status, ss.str());
         }
 
-        auto result = parseHttpHeaders(isCancellationRequested);
+        auto result = parseHttpHeaders(_socket, isCancellationRequested);
         auto headersValid = result.first;
         auto headers = result.second;
 
@@ -372,7 +234,7 @@ namespace ix
         }
 
         // Check the value of the connection field
-        // Some websocket servers (Go/Gorilla?) send lowercase values for the 
+        // Some websocket servers (Go/Gorilla?) send lowercase values for the
         // connection header, so do a case insensitive comparison
         if (!insensitiveStringCompare(headers["connection"], "Upgrade"))
         {
@@ -418,7 +280,7 @@ namespace ix
         // Set the socket to non blocking mode + other tweaks
         SocketConnect::configure(fd);
 
-        auto isCancellationRequested = 
+        auto isCancellationRequested =
             makeCancellationRequestWithTimeout(timeoutSecs, _requestInitCancellation);
 
         std::string remote = std::string("remote fd ") + std::to_string(fd);
@@ -432,7 +294,7 @@ namespace ix
         {
             return sendErrorResponse(400, "Error reading HTTP request line");
         }
-        
+
         // Validate request line (GET /foo HTTP/1.1\r\n)
         auto requestLine = parseRequestLine(line);
         auto method      = std::get<0>(requestLine);
@@ -450,7 +312,7 @@ namespace ix
         }
 
         // Retrieve and validate HTTP headers
-        auto result = parseHttpHeaders(isCancellationRequested);
+        auto result = parseHttpHeaders(_socket, isCancellationRequested);
         auto headersValid = result.first;
         auto headers = result.second;
 
@@ -491,7 +353,7 @@ namespace ix
         WebSocketHandshakeKeyGen::generate(headers["sec-websocket-key"].c_str(), output);
 
         std::stringstream ss;
-        ss << "HTTP/1.1 101\r\n";
+        ss << "HTTP/1.1 101 Switching Protocols\r\n";
         ss << "Sec-WebSocket-Accept: " << std::string(output) << "\r\n";
         ss << "Upgrade: websocket\r\n";
         ss << "Connection: Upgrade\r\n";

ixwebsocket/IXWebSocketHandshake.h

@@ -18,7 +18,7 @@
 #include <memory>
 #include <tuple>
 
-namespace ix 
+namespace ix
 {
     struct WebSocketInitResult
     {
@@ -59,19 +59,10 @@ namespace ix
         WebSocketInitResult serverHandshake(int fd,
                                             int timeoutSecs);
 
-        static bool parseUrl(const std::string& url,
-                             std::string& protocol,
-                             std::string& host,
-                             std::string& path,
-                             std::string& query,
-                             int& port);
-
     private:
-        static void printUrl(const std::string& url);
         std::string genRandomString(const int len);
 
         // Parse HTTP headers
-        std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(const CancellationRequest& isCancellationRequested);
         WebSocketInitResult sendErrorResponse(int code, const std::string& reason);
 
         std::tuple<std::string, std::string, std::string> parseRequestLine(const std::string& line);

ixwebsocket/IXWebSocketHttpHeaders.cpp

@@ -0,0 +1,82 @@
+/*
+ *  IXWebSocketHttpHeaders.h
+ *  Author: Benjamin Sergeant
+ *  Copyright (c) 2018 Machine Zone, Inc. All rights reserved.
+ */
+
+#include "IXWebSocketHttpHeaders.h"
+#include "IXSocket.h"
+#include <algorithm>
+#include <locale>
+
+namespace ix
+{
+    bool CaseInsensitiveLess::NocaseCompare::operator()(const unsigned char & c1, const unsigned char & c2) const
+    {
+#ifdef _WIN32
+        return std::tolower(c1, std::locale()) < std::tolower(c2, std::locale());
+#else
+        return std::tolower(c1) < std::tolower(c2);
+#endif
+    }
+
+    bool CaseInsensitiveLess::operator()(const std::string & s1, const std::string & s2) const
+    {
+        return std::lexicographical_compare
+                (s1.begin(), s1.end(),   // source range
+                 s2.begin(), s2.end(),   // dest range
+                 NocaseCompare());       // comparison
+    }
+
+    std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
+        std::shared_ptr<Socket> socket,
+        const CancellationRequest& isCancellationRequested)
+    {
+        WebSocketHttpHeaders headers;
+
+        char line[1024];
+        int i;
+
+        while (true)
+        {
+            int colon = 0;
+
+            for (i = 0;
+                 i < 2 || (i < 1023 && line[i-2] != '\r' && line[i-1] != '\n');
+                 ++i)
+            {
+                if (!socket->readByte(line+i, isCancellationRequested))
+                {
+                    return std::make_pair(false, headers);
+                }
+
+                if (line[i] == ':' && colon == 0)
+                {
+                    colon = i;
+                }
+            }
+            if (line[0] == '\r' && line[1] == '\n')
+            {
+                break;
+            }
+
+            // line is a single header entry. split by ':', and add it to our
+            // header map. ignore lines with no colon.
+            if (colon > 0)
+            {
+                line[i] = '\0';
+                std::string lineStr(line);
+                // colon is ':', colon+1 is ' ', colon+2 is the start of the value.
+                // i is end of string (\0), i-colon is length of string minus key;
+                // subtract 1 for '\0', 1 for '\n', 1 for '\r',
+                // 1 for the ' ' after the ':', and total is -4
+                std::string name(lineStr.substr(0, colon));
+                std::string value(lineStr.substr(colon + 2, i - colon - 4));
+
+                headers[name] = value;
+            }
+        }
+
+        return std::make_pair(true, headers);
+    }
+}

ixwebsocket/IXWebSocketHttpHeaders.h

@@ -6,10 +6,30 @@
 
 #pragma once
 
-#include <string>
-#include <unordered_map>
+#include "IXCancellationRequest.h"
 
-namespace ix 
+#include <string>
+#include <map>
+#include <memory>
+
+namespace ix
 {
-    using WebSocketHttpHeaders = std::unordered_map<std::string, std::string>;
+    class Socket;
+
+    struct CaseInsensitiveLess
+    {
+        // Case Insensitive compare_less binary function
+        struct NocaseCompare
+        {
+            bool operator() (const unsigned char& c1, const unsigned char& c2) const;
+        };
+
+        bool operator() (const std::string & s1, const std::string & s2) const;
+    };
+
+    using WebSocketHttpHeaders = std::map<std::string, std::string, CaseInsensitiveLess>;
+
+    std::pair<bool, WebSocketHttpHeaders> parseHttpHeaders(
+        std::shared_ptr<Socket> socket,
+        const CancellationRequest& isCancellationRequested);
 }

ixwebsocket/IXWebSocketPerMessageDeflate.cpp

@@ -34,7 +34,7 @@
  *  - Reused zlib compression + decompression bits.
  *  - Refactored to have 2 class for compression and decompression, to allow multi-threading
  *    and make sure that _compressBuffer is not shared between threads.
- *  - Original code wasn't working for some reason, I had to add checks 
+ *  - Original code wasn't working for some reason, I had to add checks
  *    for the presence of the kEmptyUncompressedBlock at the end of buffer so that servers
  *    would start accepting receiving/decoding compressed messages. Original code was probably
  *    modifying the passed in buffers before processing in enabled.hpp ?
@@ -65,13 +65,13 @@ namespace ix
 
     bool WebSocketPerMessageDeflate::init(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions)
     {
-        bool clientNoContextTakeover = 
+        bool clientNoContextTakeover =
             perMessageDeflateOptions.getClientNoContextTakeover();
 
         uint8_t deflateBits = perMessageDeflateOptions.getClientMaxWindowBits();
         uint8_t inflateBits = perMessageDeflateOptions.getServerMaxWindowBits();
 
-        return _compressor->init(deflateBits, clientNoContextTakeover) && 
+        return _compressor->init(deflateBits, clientNoContextTakeover) &&
                _decompressor->init(inflateBits, clientNoContextTakeover);
     }
 

ixwebsocket/IXWebSocketPerMessageDeflate.h

@@ -37,7 +37,7 @@
 #include <string>
 #include <memory>
 
-namespace ix 
+namespace ix
 {
     class WebSocketPerMessageDeflateOptions;
     class WebSocketPerMessageDeflateCompressor;

ixwebsocket/IXWebSocketPerMessageDeflateCodec.cpp

@@ -14,7 +14,7 @@
 namespace
 {
     // The passed in size (4) is important, without it the string litteral
-    // is treated as a char* and the null termination (\x00) makes it 
+    // is treated as a char* and the null termination (\x00) makes it
     // look like an empty string.
     const std::string kEmptyUncompressedBlock = std::string("\x00\x00\xff\xff", 4);
 
@@ -76,16 +76,16 @@ namespace ix
     {
         //
         // 7.2.1.  Compression
-        // 
+        //
         //    An endpoint uses the following algorithm to compress a message.
-        // 
+        //
         //    1.  Compress all the octets of the payload of the message using
         //        DEFLATE.
-        // 
+        //
         //    2.  If the resulting data does not end with an empty DEFLATE block
         //        with no compression (the "BTYPE" bits are set to 00), append an
         //        empty DEFLATE block with no compression to the tail end.
-        // 
+        //
         //    3.  Remove 4 octets (that are 0x00 0x00 0xff 0xff) from the tail end.
         //        After this step, the last octet of the compressed data contains
         //        (possibly part of) the DEFLATE header bits with the "BTYPE" bits
@@ -168,14 +168,14 @@ namespace ix
     {
         //
         // 7.2.2.  Decompression
-        // 
+        //
         //    An endpoint uses the following algorithm to decompress a message.
-        // 
+        //
         //    1.  Append 4 octets of 0x00 0x00 0xff 0xff to the tail end of the
         //        payload of the message.
-        // 
+        //
         //    2.  Decompress the resulting data using DEFLATE.
-        // 
+        //
         std::string inFixed(in);
         inFixed += kEmptyUncompressedBlock;
 

ixwebsocket/IXWebSocketPerMessageDeflateCodec.h

@@ -10,7 +10,7 @@
 #include <string>
 #include <memory>
 
-namespace ix 
+namespace ix
 {
     class WebSocketPerMessageDeflateCompressor
     {

ixwebsocket/IXWebSocketPerMessageDeflateOptions.cpp

@@ -36,7 +36,7 @@ namespace ix
         _serverMaxWindowBits = serverMaxWindowBits;
     }
 
-    // 
+    //
     // Four extension parameters are defined for "permessage-deflate" to
     // help endpoints manage per-connection resource usage.
     //
@@ -88,9 +88,9 @@ namespace ix
                 int x;
                 ss >> x;
 
-                // Sanitize values to be in the proper range [8, 15] in 
+                // Sanitize values to be in the proper range [8, 15] in
                 // case a server would give us bogus values
-                _serverMaxWindowBits = 
+                _serverMaxWindowBits =
                     std::min(maxServerMaxWindowBits,
                         std::max(x, minServerMaxWindowBits));
             }
@@ -103,9 +103,9 @@ namespace ix
                 int x;
                 ss >> x;
 
-                // Sanitize values to be in the proper range [8, 15] in 
+                // Sanitize values to be in the proper range [8, 15] in
                 // case a server would give us bogus values
-                _clientMaxWindowBits = 
+                _clientMaxWindowBits =
                     std::min(maxClientMaxWindowBits,
                         std::max(x, minClientMaxWindowBits));
             }
@@ -162,7 +162,7 @@ namespace ix
     std::string WebSocketPerMessageDeflateOptions::removeSpaces(const std::string& str)
     {
         std::string out(str);
-        out.erase(std::remove_if(out.begin(), 
+        out.erase(std::remove_if(out.begin(),
                                  out.end(),
                                  [](unsigned char x){ return std::isspace(x); }),
                   out.end());

ixwebsocket/IXWebSocketPerMessageDeflateOptions.h

@@ -8,7 +8,7 @@
 
 #include <string>
 
-namespace ix 
+namespace ix
 {
     class WebSocketPerMessageDeflateOptions
     {

ixwebsocket/IXWebSocketSendInfo.h

@@ -9,7 +9,7 @@
 #include <string>
 #include <iostream>
 
-namespace ix 
+namespace ix
 {
     struct WebSocketSendInfo
     {

ixwebsocket/IXWebSocketServer.cpp

@@ -14,16 +14,18 @@
 #include <future>
 #include <string.h>
 
-namespace ix 
+namespace ix
 {
     const int WebSocketServer::kDefaultHandShakeTimeoutSecs(3); // 3 seconds
+    const bool WebSocketServer::kDefaultEnablePong(true);
 
     WebSocketServer::WebSocketServer(int port,
                                      const std::string& host,
                                      int backlog,
                                      size_t maxConnections,
                                      int handshakeTimeoutSecs) : SocketServer(port, host, backlog, maxConnections),
-        _handshakeTimeoutSecs(handshakeTimeoutSecs)
+        _handshakeTimeoutSecs(handshakeTimeoutSecs),
+        _enablePong(kDefaultEnablePong)
     {
 
     }
@@ -35,6 +37,8 @@ namespace ix
 
     void WebSocketServer::stop()
     {
+        stopAcceptingConnections();
+
         auto clients = getClients();
         for (auto client : clients)
         {
@@ -44,18 +48,35 @@ namespace ix
         SocketServer::stop();
     }
 
+    void WebSocketServer::enablePong()
+    {
+        _enablePong = true;
+    }
+
+    void WebSocketServer::disablePong()
+    {
+        _enablePong = false;
+    }
+
     void WebSocketServer::setOnConnectionCallback(const OnConnectionCallback& callback)
     {
         _onConnectionCallback = callback;
     }
 
-    void WebSocketServer::handleConnection(int fd)
+    void WebSocketServer::handleConnection(
+        int fd,
+        std::shared_ptr<ConnectionState> connectionState)
     {
         auto webSocket = std::make_shared<WebSocket>();
-        _onConnectionCallback(webSocket);
+        _onConnectionCallback(webSocket, connectionState);
 
         webSocket->disableAutomaticReconnection();
 
+        if (_enablePong)
+            webSocket->enablePong();
+        else
+            webSocket->disablePong();
+
         // Add this client to our client set
         {
             std::lock_guard<std::mutex> lock(_clientsMutex);
@@ -65,7 +86,7 @@ namespace ix
         auto status = webSocket->connectToSocket(fd, _handshakeTimeoutSecs);
         if (status.success)
         {
-            // Process incoming messages and execute callbacks 
+            // Process incoming messages and execute callbacks
             // until the connection is closed
             webSocket->run();
         }
@@ -89,6 +110,7 @@ namespace ix
         }
 
         logInfo("WebSocketServer::handleConnection() done");
+        connectionState->setTerminated();
     }
 
     std::set<std::shared_ptr<WebSocket>> WebSocketServer::getClients()

ixwebsocket/IXWebSocketServer.h

@@ -18,9 +18,10 @@
 #include "IXWebSocket.h"
 #include "IXSocketServer.h"
 
-namespace ix 
+namespace ix
 {
-    using OnConnectionCallback = std::function<void(std::shared_ptr<WebSocket>)>;
+    using OnConnectionCallback = std::function<void(std::shared_ptr<WebSocket>,
+                                                    std::shared_ptr<ConnectionState>)>;
 
     class WebSocketServer : public SocketServer {
     public:
@@ -32,6 +33,9 @@ namespace ix
         virtual ~WebSocketServer();
         virtual void stop() final;
 
+        void enablePong();
+        void disablePong();
+
         void setOnConnectionCallback(const OnConnectionCallback& callback);
 
         // Get all the connected clients
@@ -40,6 +44,7 @@ namespace ix
     private:
         // Member variables
         int _handshakeTimeoutSecs;
+        bool _enablePong;
 
         OnConnectionCallback _onConnectionCallback;
 
@@ -47,9 +52,11 @@ namespace ix
         std::set<std::shared_ptr<WebSocket>> _clients;
 
         const static int kDefaultHandShakeTimeoutSecs;
+        const static bool kDefaultEnablePong;
 
         // Methods
-        virtual void handleConnection(int fd) final;
+        virtual void handleConnection(int fd,
+                                      std::shared_ptr<ConnectionState> connectionState) final;
         virtual size_t getConnectedClientsCount() final;
     };
 }

ixwebsocket/IXWebSocketTransport.cpp

@@ -1,7 +1,31 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2012, 2013 <dhbaird@gmail.com>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 /*
  *  IXWebSocketTransport.cpp
  *  Author: Benjamin Sergeant
- *  Copyright (c) 2017-2018 Machine Zone, Inc. All rights reserved.
+ *  Copyright (c) 2017-2019 Machine Zone, Inc. All rights reserved.
  */
 
 //
@@ -11,14 +35,8 @@
 #include "IXWebSocketTransport.h"
 #include "IXWebSocketHandshake.h"
 #include "IXWebSocketHttpHeaders.h"
-
-#ifdef IXWEBSOCKET_USE_TLS
-# ifdef __APPLE__
-#  include "IXSocketAppleSSL.h"
-# else
-#  include "IXSocketOpenSSL.h"
-# endif
-#endif
+#include "IXUrlParser.h"
+#include "IXSocketFactory.h"
 
 #include <string.h>
 #include <stdlib.h>
@@ -29,23 +47,57 @@
 #include <cstdarg>
 #include <iostream>
 #include <sstream>
+#include <chrono>
+#include <thread>
 
 
+namespace
+{
+    int greatestCommonDivisor(int a, int b)
+    {
+        while (b != 0)
+        {
+            int t = b;
+            b = a % b;
+            a = t;
+        }
+
+        return a;
+    }
+}
+
 namespace ix
 {
-    const std::string WebSocketTransport::kHeartBeatPingMessage("ixwebsocket::hearbeat");
-    const int WebSocketTransport::kDefaultHeartBeatPeriod(-1);
+    const std::string WebSocketTransport::kPingMessage("ixwebsocket::heartbeat");
+    const int WebSocketTransport::kDefaultPingIntervalSecs(-1);
+    const int WebSocketTransport::kDefaultPingTimeoutSecs(-1);
+    const bool WebSocketTransport::kDefaultEnablePong(true);
+    constexpr size_t WebSocketTransport::kChunkSize;
+    const uint16_t WebSocketTransport::kInternalErrorCode(1011);
+    const uint16_t WebSocketTransport::kAbnormalCloseCode(1006);
+    const uint16_t WebSocketTransport::kProtocolErrorCode(1002);
+    const std::string WebSocketTransport::kInternalErrorMessage("Internal error");
+    const std::string WebSocketTransport::kAbnormalCloseMessage("Abnormal closure");
+    const std::string WebSocketTransport::kPingTimeoutMessage("Ping timeout");
+    const std::string WebSocketTransport::kProtocolErrorMessage("Protocol error");
 
     WebSocketTransport::WebSocketTransport() :
+        _useMask(true),
         _readyState(CLOSED),
-        _closeCode(0),
+        _closeCode(kInternalErrorCode),
+        _closeReason(kInternalErrorMessage),
         _closeWireSize(0),
+        _closeRemote(false),
         _enablePerMessageDeflate(false),
         _requestInitCancellation(false),
-        _heartBeatPeriod(kDefaultHeartBeatPeriod),
-        _lastSendTimePoint(std::chrono::steady_clock::now())
+        _enablePong(kDefaultEnablePong),
+        _pingIntervalSecs(kDefaultPingIntervalSecs),
+        _pingTimeoutSecs(kDefaultPingTimeoutSecs),
+        _pingIntervalOrTimeoutGCDSecs(-1),
+        _lastSendPingTimePoint(std::chrono::steady_clock::now()),
+        _lastReceivePongTimePoint(std::chrono::steady_clock::now())
     {
-
+        _readbuf.resize(kChunkSize);
     }
 
     WebSocketTransport::~WebSocketTransport()
@@ -54,11 +106,29 @@ namespace ix
     }
 
     void WebSocketTransport::configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
-                                       int hearBeatPeriod)
+                                       bool enablePong,
+                                       int pingIntervalSecs,
+                                       int pingTimeoutSecs)
     {
         _perMessageDeflateOptions = perMessageDeflateOptions;
         _enablePerMessageDeflate = _perMessageDeflateOptions.enabled();
-        _heartBeatPeriod = hearBeatPeriod;
+        _enablePong = enablePong;
+        _pingIntervalSecs = pingIntervalSecs;
+        _pingTimeoutSecs = pingTimeoutSecs;
+
+        if (pingIntervalSecs > 0 && pingTimeoutSecs > 0)
+        {
+            _pingIntervalOrTimeoutGCDSecs = greatestCommonDivisor(pingIntervalSecs,
+                                                                  pingTimeoutSecs);
+        }
+        else if (_pingTimeoutSecs > 0)
+        {
+            _pingIntervalOrTimeoutGCDSecs = pingTimeoutSecs;
+        }
+        else
+        {
+            _pingIntervalOrTimeoutGCDSecs = pingIntervalSecs;
+        }
     }
 
     // Client
@@ -67,31 +137,21 @@ namespace ix
     {
         std::string protocol, host, path, query;
         int port;
+        bool websocket = true;
 
-        if (!WebSocketHandshake::parseUrl(url, protocol, host,
-                                          path, query, port))
+        if (!UrlParser::parse(url, protocol, host, path, query, port, websocket))
         {
             return WebSocketInitResult(false, 0,
                                        std::string("Could not parse URL ") + url);
         }
 
-        if (protocol == "wss")
+        bool tls = protocol == "wss";
+        std::string errorMsg;
+        _socket = createSocket(tls, errorMsg);
+
+        if (!_socket)
         {
-            _socket.reset();
-#ifdef IXWEBSOCKET_USE_TLS
-# ifdef __APPLE__
-             _socket = std::make_shared<SocketAppleSSL>();
-# else
-             _socket = std::make_shared<SocketOpenSSL>();
-# endif
-#else
-            return WebSocketInitResult(false, 0, "TLS is not supported.");
-#endif
-        }
-        else
-        {
-            _socket.reset();
-            _socket = std::make_shared<Socket>();
+            return WebSocketInitResult(false, 0, errorMsg);
         }
 
         WebSocketHandshake webSocketHandshake(_requestInitCancellation,
@@ -112,8 +172,16 @@ namespace ix
     // Server
     WebSocketInitResult WebSocketTransport::connectToSocket(int fd, int timeoutSecs)
     {
-        _socket.reset();
-        _socket = std::make_shared<Socket>(fd);
+        // Server should not mask the data it sends to the client
+        _useMask = false;
+
+        std::string errorMsg;
+        _socket = createSocket(fd, errorMsg);
+
+        if (!_socket)
+        {
+            return WebSocketInitResult(false, 0, errorMsg);
+        }
 
         WebSocketHandshake webSocketHandshake(_requestInitCancellation,
                                               _socket,
@@ -129,7 +197,7 @@ namespace ix
         return result;
     }
 
-    WebSocketTransport::ReadyStateValues WebSocketTransport::getReadyState() const 
+    WebSocketTransport::ReadyStateValues WebSocketTransport::getReadyState() const
     {
         return _readyState;
     }
@@ -142,10 +210,11 @@ namespace ix
         if (readyStateValue == CLOSED)
         {
             std::lock_guard<std::mutex> lock(_closeDataMutex);
-            _onCloseCallback(_closeCode, _closeReason, _closeWireSize);
-            _closeCode = 0;
-            _closeReason = std::string();
+            _onCloseCallback(_closeCode, _closeReason, _closeWireSize, _closeRemote);
+            _closeCode = kInternalErrorCode;
+            _closeReason = kInternalErrorMessage;
             _closeWireSize = 0;
+            _closeRemote = false;
         }
 
         _readyState = readyStateValue;
@@ -153,66 +222,122 @@ namespace ix
 
     void WebSocketTransport::setOnCloseCallback(const OnCloseCallback& onCloseCallback)
     {
-        _onCloseCallback = onCloseCallback; 
+        _onCloseCallback = onCloseCallback;
     }
 
-    bool WebSocketTransport::exceedSendHeartBeatTimeOut()
+    // Only consider send PING time points for that computation.
+    bool WebSocketTransport::pingIntervalExceeded()
     {
-        std::lock_guard<std::mutex> lock(_lastSendTimePointMutex);
+        if (_pingIntervalSecs <= 0)
+            return false;
+
+        std::lock_guard<std::mutex> lock(_lastSendPingTimePointMutex);
         auto now = std::chrono::steady_clock::now();
-        return now - _lastSendTimePoint > std::chrono::seconds(_heartBeatPeriod);
+        return now - _lastSendPingTimePoint > std::chrono::seconds(_pingIntervalSecs);
+    }
+
+    bool WebSocketTransport::pingTimeoutExceeded()
+    {
+        if (_pingTimeoutSecs <= 0)
+            return false;
+
+        std::lock_guard<std::mutex> lock(_lastReceivePongTimePointMutex);
+        auto now = std::chrono::steady_clock::now();
+        return now - _lastReceivePongTimePoint > std::chrono::seconds(_pingTimeoutSecs);
     }
 
     void WebSocketTransport::poll()
     {
-        _socket->poll(
-            [this](PollResultType pollResult)
+        PollResultType pollResult = _socket->poll(_pingIntervalOrTimeoutGCDSecs);
+
+        if (_readyState == OPEN)
+        {
+            // if (1) ping timeout is enabled and (2) duration since last received
+            // ping response (PONG) exceeds the maximum delay, then close the connection
+            if (pingTimeoutExceeded())
             {
-                // If (1) heartbeat is enabled, and (2) no data was received or
-                // send for a duration exceeding our heart-beat period, send a
-                // ping to the server.
-                if (pollResult == PollResultType_Timeout && 
-                    exceedSendHeartBeatTimeOut())
-                {
-                    std::stringstream ss;
-                    ss << kHeartBeatPingMessage << "::" << _heartBeatPeriod << "s";
-                    sendPing(ss.str());
-                    return;
-                }
+                close(kInternalErrorCode, kPingTimeoutMessage);
+            }
+            // If ping is enabled and no ping has been sent for a duration
+            // exceeding our ping interval, send a ping to the server.
+            else if (pingIntervalExceeded())
+            {
+                std::stringstream ss;
+                ss << kPingMessage << "::" << _pingIntervalSecs << "s";
+                sendPing(ss.str());
+            }
+        }
 
-                while (true) 
-                {
-                    int N = (int) _rxbuf.size();
+        // Make sure we send all the buffered data
+        // there can be a lot of it for large messages.
+        if (pollResult == PollResultType::SendRequest)
+        {
+            while (!isSendBufferEmpty() && !_requestInitCancellation)
+            {
+                // Wait with a 10ms timeout until the socket is ready to write.
+                // This way we are not busy looping
+                PollResultType result = _socket->isReadyToWrite(10);
 
-                    _rxbuf.resize(N + 1500);
-                    ssize_t ret = _socket->recv((char*)&_rxbuf[0] + N, 1500);
-
-                    if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK || 
-                                    _socket->getErrno() == EAGAIN)) {
-                        _rxbuf.resize(N);
-                        break;
-                    }
-                    else if (ret <= 0) 
-                    {
-                        _rxbuf.resize(N);
-
-                        _socket->close();
-                        setReadyState(CLOSED);
-                        break;
-                    }
-                    else 
-                    {
-                        _rxbuf.resize(N + ret);
-                    }
-                }
-
-                if (isSendBufferEmpty() && _readyState == CLOSING) 
+                if (result == PollResultType::Error)
                 {
                     _socket->close();
                     setReadyState(CLOSED);
+                    break;
                 }
-            },
-            _heartBeatPeriod);
+                else if (result == PollResultType::ReadyForWrite)
+                {
+                    sendOnSocket();
+                }
+            }
+        }
+        else if (pollResult == PollResultType::ReadyForRead)
+        {
+            while (true)
+            {
+                ssize_t ret = _socket->recv((char*)&_readbuf[0], _readbuf.size());
+
+                if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK ||
+                                _socket->getErrno() == EAGAIN))
+                {
+                    break;
+                }
+                else if (ret <= 0)
+                {
+                    _rxbuf.clear();
+                    _socket->close();
+                    {
+                        std::lock_guard<std::mutex> lock(_closeDataMutex);
+                        _closeCode = kAbnormalCloseCode;
+                        _closeReason = kAbnormalCloseMessage;
+                        _closeWireSize = 0;
+                        _closeRemote = true;
+                    }
+                    setReadyState(CLOSED);
+                    break;
+                }
+                else
+                {
+                    _rxbuf.insert(_rxbuf.end(),
+                                  _readbuf.begin(),
+                                  _readbuf.begin() + ret);
+                }
+            }
+        }
+        else if (pollResult == PollResultType::Error)
+        {
+            _socket->close();
+        }
+        else if (pollResult == PollResultType::CloseRequest)
+        {
+            _socket->close();
+        }
+
+        // Avoid a race condition where we get stuck in select
+        // while closing.
+        if (_readyState == CLOSING)
+        {
+            _socket->close();
+        }
     }
 
     bool WebSocketTransport::isSendBufferEmpty() const
@@ -232,19 +357,15 @@ namespace ix
         _txbuf.insert(_txbuf.end(), header.begin(), header.end());
         _txbuf.insert(_txbuf.end(), begin, end);
 
-        // Masking
-        for (size_t i = 0; i != (size_t) message_size; ++i)
+        if (_useMask)
         {
-            *(_txbuf.end() - (size_t) message_size + i) ^= masking_key[i&0x3];
+            for (size_t i = 0; i != (size_t) message_size; ++i)
+            {
+                *(_txbuf.end() - (size_t) message_size + i) ^= masking_key[i&0x3];
+            }
         }
     }
 
-    void WebSocketTransport::appendToSendBuffer(const std::vector<uint8_t>& buffer)
-    {
-        std::lock_guard<std::mutex> lock(_txbufMutex);
-        _txbuf.insert(_txbuf.end(), buffer.begin(), buffer.end());
-    }
-
     void WebSocketTransport::unmaskReceiveBuffer(const wsheader_type& ws)
     {
         if (ws.mask)
@@ -280,7 +401,7 @@ namespace ix
     //
     void WebSocketTransport::dispatch(const OnMessageCallback& onMessageCallback)
     {
-        while (true) 
+        while (true)
         {
             wsheader_type ws;
             if (_rxbuf.size() < 2) return; /* Need at least 2 */
@@ -292,7 +413,7 @@ namespace ix
             ws.N0 = (data[1] & 0x7f);
             ws.header_size = 2 + (ws.N0 == 126? 2 : 0) + (ws.N0 == 127? 8 : 0) + (ws.mask? 4 : 0);
             if (_rxbuf.size() < ws.header_size) return; /* Need: ws.header_size - _rxbuf.size() */
-            
+
             //
             // Calculate payload length:
             // 0-125 mean the payload is that long.
@@ -330,7 +451,7 @@ namespace ix
                 // invalid payload length according to the spec. bail out
                 return;
             }
-            
+
             if (ws.mask)
             {
                 ws.masking_key[0] = ((uint8_t) data[i+0]) << 0;
@@ -353,33 +474,59 @@ namespace ix
 
             // We got a whole message, now do something with it:
             if (
-                   ws.opcode == wsheader_type::TEXT_FRAME 
+                   ws.opcode == wsheader_type::TEXT_FRAME
                 || ws.opcode == wsheader_type::BINARY_FRAME
                 || ws.opcode == wsheader_type::CONTINUATION
             ) {
                 unmaskReceiveBuffer(ws);
-                _receivedData.insert(_receivedData.end(),
-                                     _rxbuf.begin()+ws.header_size,
-                                     _rxbuf.begin()+ws.header_size+(size_t)ws.N);// just feed
-                if (ws.fin)
-                {
-                    // fire callback with a string message
-                    std::string stringMessage(_receivedData.begin(),
-                                              _receivedData.end());
 
-                    emitMessage(MSG, stringMessage, ws, onMessageCallback);
-                    _receivedData.clear();
+                //
+                // Usual case. Small unfragmented messages
+                //
+                if (ws.fin && _chunks.empty())
+                {
+                    emitMessage(MSG,
+                                std::string(_rxbuf.begin()+ws.header_size,
+                                            _rxbuf.begin()+ws.header_size+(size_t) ws.N),
+                                ws,
+                                onMessageCallback);
+                }
+                else
+                {
+                    //
+                    // Add intermediary message to our chunk list.
+                    // We use a chunk list instead of a big buffer because resizing
+                    // large buffer can be very costly when we need to re-allocate
+                    // the internal buffer which is slow and can let the internal OS
+                    // receive buffer fill out.
+                    //
+                    _chunks.emplace_back(
+                        std::vector<uint8_t>(_rxbuf.begin()+ws.header_size,
+                                             _rxbuf.begin()+ws.header_size+(size_t)ws.N));
+                    if (ws.fin)
+                    {
+                        emitMessage(MSG, getMergedChunks(), ws, onMessageCallback);
+                        _chunks.clear();
+                    }
+                    else
+                    {
+                        emitMessage(FRAGMENT, std::string(), ws, onMessageCallback);
+                    }
                 }
             }
             else if (ws.opcode == wsheader_type::PING)
             {
                 unmaskReceiveBuffer(ws);
+
                 std::string pingData(_rxbuf.begin()+ws.header_size,
                                      _rxbuf.begin()+ws.header_size + (size_t) ws.N);
 
-                // Reply back right away
-                bool compress = false;
-                sendData(wsheader_type::PONG, pingData, compress);
+                if (_enablePong)
+                {
+                    // Reply back right away
+                    bool compress = false;
+                    sendData(wsheader_type::PONG, pingData, compress);
+                }
 
                 emitMessage(PING, pingData, ws, onMessageCallback);
             }
@@ -389,6 +536,9 @@ namespace ix
                 std::string pongData(_rxbuf.begin()+ws.header_size,
                                      _rxbuf.begin()+ws.header_size + (size_t) ws.N);
 
+                std::lock_guard<std::mutex> lck(_lastReceivePongTimePointMutex);
+                _lastReceivePongTimePoint = std::chrono::steady_clock::now();
+
                 emitMessage(PONG, pongData, ws, onMessageCallback);
             }
             else if (ws.opcode == wsheader_type::CLOSE)
@@ -402,28 +552,46 @@ namespace ix
 
                 // Get the reason.
                 std::string reason(_rxbuf.begin()+ws.header_size + 2,
-                                   _rxbuf.begin()+ws.header_size + 2 + (size_t) ws.N);
+                                   _rxbuf.begin()+ws.header_size + (size_t) ws.N);
+                
+                bool remote = true;
 
-                {
-                    std::lock_guard<std::mutex> lock(_closeDataMutex);
-                    _closeCode = code;
-                    _closeReason = reason;
-                    _closeWireSize = _rxbuf.size();
-                }
-
-                close();
+                close(code, reason, _rxbuf.size(), remote);
             }
             else
             {
-                close();
+                // Unexpected frame type
+
+                close(kProtocolErrorCode, kProtocolErrorMessage, _rxbuf.size());
             }
 
+            // Erase the message that has been processed from the input/read buffer
             _rxbuf.erase(_rxbuf.begin(),
                          _rxbuf.begin() + ws.header_size + (size_t) ws.N);
         }
     }
 
-    void WebSocketTransport::emitMessage(MessageKind messageKind, 
+    std::string WebSocketTransport::getMergedChunks() const
+    {
+        size_t length = 0;
+        for (auto&& chunk : _chunks)
+        {
+            length += chunk.size();
+        }
+
+        std::string msg;
+        msg.reserve(length);
+
+        for (auto&& chunk : _chunks)
+        {
+            std::string str(chunk.begin(), chunk.end());
+            msg += str;
+        }
+
+        return msg;
+    }
+
+    void WebSocketTransport::emitMessage(MessageKind messageKind,
                                          const std::string& message,
                                          const wsheader_type& ws,
                                          const OnMessageCallback& onMessageCallback)
@@ -431,7 +599,7 @@ namespace ix
         size_t wireSize = message.size();
 
         // When the RSV1 bit is 1 it means the message is compressed
-        if (_enablePerMessageDeflate && ws.rsv1)
+        if (_enablePerMessageDeflate && ws.rsv1 && messageKind != FRAGMENT)
         {
             std::string decompressedMessage;
             bool success = _perMessageDeflate.decompress(message, decompressedMessage);
@@ -446,15 +614,17 @@ namespace ix
     unsigned WebSocketTransport::getRandomUnsigned()
     {
         auto now = std::chrono::system_clock::now();
-        auto seconds = 
+        auto seconds =
             std::chrono::duration_cast<std::chrono::seconds>(
                 now.time_since_epoch()).count();
         return static_cast<unsigned>(seconds);
     }
 
-    WebSocketSendInfo WebSocketTransport::sendData(wsheader_type::opcode_type type, 
-                                                   const std::string& message,
-                                                   bool compress)
+    WebSocketSendInfo WebSocketTransport::sendData(
+        wsheader_type::opcode_type type,
+        const std::string& message,
+        bool compress,
+        const OnProgressCallback& onProgressCallback)
     {
         if (_readyState == CLOSING || _readyState == CLOSED)
         {
@@ -471,15 +641,87 @@ namespace ix
 
         if (compress)
         {
-            bool success = _perMessageDeflate.compress(message, compressedMessage);
-            compressionError = !success;
+            if (!_perMessageDeflate.compress(message, compressedMessage))
+            {
+                bool success = false;
+                compressionError = true;
+                payloadSize = 0;
+                wireSize = 0;
+                return WebSocketSendInfo(success, compressionError, payloadSize, wireSize);
+            }
+            compressionError = false;
             wireSize = compressedMessage.size();
 
             message_begin = compressedMessage.begin();
             message_end = compressedMessage.end();
         }
 
-        uint64_t message_size = wireSize;
+        // Common case for most message. No fragmentation required.
+        if (wireSize < kChunkSize)
+        {
+            sendFragment(type, true, message_begin, message_end, compress);
+        }
+        else
+        {
+            //
+            // Large messages need to be fragmented
+            //
+            // Rules:
+            // First message needs to specify a proper type (BINARY or TEXT)
+            // Intermediary and last messages need to be of type CONTINUATION
+            // Last message must set the fin byte.
+            //
+            auto steps = wireSize / kChunkSize;
+
+            std::string::const_iterator begin = message_begin;
+            std::string::const_iterator end = message_end;
+
+            for (uint64_t i = 0 ; i < steps; ++i)
+            {
+                bool firstStep = i == 0;
+                bool lastStep = (i+1) == steps;
+                bool fin = lastStep;
+
+                end = begin + kChunkSize;
+                if (lastStep)
+                {
+                    end = message_end;
+                }
+
+                auto opcodeType = type;
+                if (!firstStep)
+                {
+                    opcodeType = wsheader_type::CONTINUATION;
+                }
+
+                // Send message
+                sendFragment(opcodeType, fin, begin, end, compress);
+
+                if (onProgressCallback && !onProgressCallback((int)i, (int) steps))
+                {
+                    break;
+                }
+
+                begin += kChunkSize;
+            }
+        }
+
+        // Request to flush the send buffer on the background thread if it isn't empty
+        if (!isSendBufferEmpty())
+        {
+            _socket->wakeUpFromPoll(Socket::kSendRequest);
+        }
+
+        return WebSocketSendInfo(true, compressionError, payloadSize, wireSize);
+    }
+
+    void WebSocketTransport::sendFragment(wsheader_type::opcode_type type,
+                                          bool fin,
+                                          std::string::const_iterator message_begin,
+                                          std::string::const_iterator message_end,
+                                          bool compress)
+    {
+        uint64_t message_size = static_cast<uint64_t>(message_end - message_begin);
 
         unsigned x = getRandomUnsigned();
         uint8_t masking_key[4] = {};
@@ -491,8 +733,15 @@ namespace ix
         std::vector<uint8_t> header;
         header.assign(2 +
                       (message_size >= 126 ? 2 : 0) +
-                      (message_size >= 65536 ? 6 : 0) + 4, 0);
-        header[0] = 0x80 | type;
+                      (message_size >= 65536 ? 6 : 0) +
+                      (_useMask ? 4 : 0), 0);
+        header[0] = type;
+
+        // The fin bit indicate that this is the last fragment. Fin is French for end.
+        if (fin)
+        {
+            header[0] |= 0x80;
+        }
 
         // This bit indicate that the frame is compressed
         if (compress)
@@ -502,27 +751,33 @@ namespace ix
 
         if (message_size < 126)
         {
-            header[1] = (message_size & 0xff) | 0x80;
+            header[1] = (message_size & 0xff) | (_useMask ? 0x80 : 0);
 
-            header[2] = masking_key[0];
-            header[3] = masking_key[1];
-            header[4] = masking_key[2];
-            header[5] = masking_key[3];
+            if (_useMask)
+            {
+                header[2] = masking_key[0];
+                header[3] = masking_key[1];
+                header[4] = masking_key[2];
+                header[5] = masking_key[3];
+            }
         }
-        else if (message_size < 65536) 
+        else if (message_size < 65536)
         {
-            header[1] = 126 | 0x80;
+            header[1] = 126 | (_useMask ? 0x80 : 0);
             header[2] = (message_size >> 8) & 0xff;
             header[3] = (message_size >> 0) & 0xff;
 
-            header[4] = masking_key[0];
-            header[5] = masking_key[1];
-            header[6] = masking_key[2];
-            header[7] = masking_key[3];
+            if (_useMask)
+            {
+                header[4] = masking_key[0];
+                header[5] = masking_key[1];
+                header[6] = masking_key[2];
+                header[7] = masking_key[3];
+            }
         }
         else
         { // TODO: run coverage testing here
-            header[1] = 127 | 0x80;
+            header[1] = 127 | (_useMask ? 0x80 : 0);
             header[2] = (message_size >> 56) & 0xff;
             header[3] = (message_size >> 48) & 0xff;
             header[4] = (message_size >> 40) & 0xff;
@@ -532,10 +787,13 @@ namespace ix
             header[8] = (message_size >>  8) & 0xff;
             header[9] = (message_size >>  0) & 0xff;
 
-            header[10] = masking_key[0];
-            header[11] = masking_key[1];
-            header[12] = masking_key[2];
-            header[13] = masking_key[3];
+            if (_useMask)
+            {
+                header[10] = masking_key[0];
+                header[11] = masking_key[1];
+                header[12] = masking_key[2];
+                header[13] = masking_key[3];
+            }
         }
 
         // _txbuf will keep growing until it can be transmitted over the socket:
@@ -544,19 +802,38 @@ namespace ix
 
         // Now actually send this data
         sendOnSocket();
-
-        return WebSocketSendInfo(true, compressionError, payloadSize, wireSize);
     }
 
     WebSocketSendInfo WebSocketTransport::sendPing(const std::string& message)
     {
         bool compress = false;
-        return sendData(wsheader_type::PING, message, compress);
+        WebSocketSendInfo info = sendData(wsheader_type::PING, message, compress);
+
+        if (info.success)
+        {
+            std::lock_guard<std::mutex> lck(_lastSendPingTimePointMutex);
+            _lastSendPingTimePoint = std::chrono::steady_clock::now();
+        }
+
+        return info;
     }
 
-    WebSocketSendInfo WebSocketTransport::sendBinary(const std::string& message) 
+    WebSocketSendInfo WebSocketTransport::sendBinary(
+        const std::string& message,
+        const OnProgressCallback& onProgressCallback)
+
     {
-        return sendData(wsheader_type::BINARY_FRAME, message, _enablePerMessageDeflate);
+        return sendData(wsheader_type::BINARY_FRAME, message,
+                        _enablePerMessageDeflate, onProgressCallback);
+    }
+
+    WebSocketSendInfo WebSocketTransport::sendText(
+        const std::string& message,
+        const OnProgressCallback& onProgressCallback)
+
+    {
+        return sendData(wsheader_type::TEXT_FRAME, message,
+                        _enablePerMessageDeflate, onProgressCallback);
     }
 
     void WebSocketTransport::sendOnSocket()
@@ -567,7 +844,7 @@ namespace ix
         {
             ssize_t ret = _socket->send((char*)&_txbuf[0], _txbuf.size());
 
-            if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK || 
+            if (ret < 0 && (_socket->getErrno() == EWOULDBLOCK ||
                             _socket->getErrno() == EAGAIN))
             {
                 break;
@@ -584,12 +861,9 @@ namespace ix
                 _txbuf.erase(_txbuf.begin(), _txbuf.begin() + ret);
             }
         }
-
-        std::lock_guard<std::mutex> lck(_lastSendTimePointMutex);
-        _lastSendTimePoint = std::chrono::steady_clock::now();
     }
 
-    void WebSocketTransport::close()
+    void WebSocketTransport::close(uint16_t code, const std::string& reason, size_t closeWireSize, bool remote)
     {
         _requestInitCancellation = true;
 
@@ -597,18 +871,36 @@ namespace ix
 
         // See list of close events here:
         // https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
-        // We use 1000: normal closure.
-        //
-        // >>> struct.pack('!H', 1000)
-        // b'\x03\xe8'
-        //
-        const std::string normalClosure = std::string("\x03\xe8");
+
+        int codeLength = 2;
+        std::string closure{(char)(code >> 8), (char)(code & 0xff)};
+        closure.resize(codeLength + reason.size());
+
+        // copy reason after code
+        closure.replace(codeLength, reason.size(), reason);
+
         bool compress = false;
-        sendData(wsheader_type::CLOSE, normalClosure, compress);
+        sendData(wsheader_type::CLOSE, closure, compress);
         setReadyState(CLOSING);
 
-        _socket->wakeUpFromPoll();
+        _socket->wakeUpFromPoll(Socket::kCloseRequest);
         _socket->close();
+
+        {
+            std::lock_guard<std::mutex> lock(_closeDataMutex);
+            _closeCode = code;
+            _closeReason = reason;
+            _closeWireSize = closeWireSize;
+            _closeRemote = remote;
+        }
+
+        setReadyState(CLOSED);
+    }
+
+    size_t WebSocketTransport::bufferedAmount() const
+    {
+        std::lock_guard<std::mutex> lock(_txbufMutex);
+        return _txbuf.size();
     }
 
 } // namespace ix

ixwebsocket/IXWebSocketTransport.h

@@ -16,6 +16,7 @@
 #include <memory>
 #include <mutex>
 #include <atomic>
+#include <list>
 
 #include "IXWebSocketSendInfo.h"
 #include "IXWebSocketPerMessageDeflate.h"
@@ -23,11 +24,19 @@
 #include "IXWebSocketHttpHeaders.h"
 #include "IXCancellationRequest.h"
 #include "IXWebSocketHandshake.h"
+#include "IXProgressCallback.h"
 
-namespace ix 
+namespace ix
 {
     class Socket;
 
+    enum class SendMessageKind
+    {
+        Text,
+        Binary,
+        Ping
+    };
+
     class WebSocketTransport
     {
     public:
@@ -43,7 +52,8 @@ namespace ix
         {
             MSG,
             PING,
-            PONG
+            PONG,
+            FRAGMENT
         };
 
         using OnMessageCallback = std::function<void(const std::string&,
@@ -52,13 +62,16 @@ namespace ix
                                                      MessageKind)>;
         using OnCloseCallback = std::function<void(uint16_t,
                                                    const std::string&,
-                                                   size_t)>;
+                                                   size_t,
+                                                   bool)>;
 
         WebSocketTransport();
         ~WebSocketTransport();
 
         void configure(const WebSocketPerMessageDeflateOptions& perMessageDeflateOptions,
-                       int hearBeatPeriod);
+                       bool enablePong,
+                       int pingIntervalSecs,
+                       int pingTimeoutSecs);
 
         WebSocketInitResult connectToUrl(const std::string& url, // Client
                                          int timeoutSecs);
@@ -66,17 +79,25 @@ namespace ix
                                             int timeoutSecs);
 
         void poll();
-        WebSocketSendInfo sendBinary(const std::string& message);
+        WebSocketSendInfo sendBinary(const std::string& message,
+                                     const OnProgressCallback& onProgressCallback);
+        WebSocketSendInfo sendText(const std::string& message,
+                                   const OnProgressCallback& onProgressCallback);
         WebSocketSendInfo sendPing(const std::string& message);
-        void close();
+
+        void close(uint16_t code = 1000,
+                   const std::string& reason = "Normal closure",
+                   size_t closeWireSize = 0,
+                   bool remote = false);
+
         ReadyStateValues getReadyState() const;
         void setReadyState(ReadyStateValues readyStateValue);
         void setOnCloseCallback(const OnCloseCallback& onCloseCallback);
         void dispatch(const OnMessageCallback& onMessageCallback);
+        size_t bufferedAmount() const;
 
     private:
         std::string _url;
-        std::string _origin;
 
         struct wsheader_type {
             unsigned header_size;
@@ -96,44 +117,103 @@ namespace ix
             uint8_t masking_key[4];
         };
 
+        // Tells whether we should mask the data we send.
+        // client should mask but server should not
+        std::atomic<bool> _useMask;
+
+        // Buffer for reading from our socket. That buffer is never resized.
+        std::vector<uint8_t> _readbuf;
+
+        // Contains all messages that were fetched in the last socket read.
+        // This could be a mix of control messages (Close, Ping, etc...) and
+        // data messages. That buffer
         std::vector<uint8_t> _rxbuf;
+
+        // Contains all messages that are waiting to be sent
         std::vector<uint8_t> _txbuf;
         mutable std::mutex _txbufMutex;
-        std::vector<uint8_t> _receivedData;
 
+        // Hold fragments for multi-fragments messages in a list. We support receiving very large
+        // messages (tested messages up to 700M) and we cannot put them in a single
+        // buffer that is resized, as this operation can be slow when a buffer has its
+        // size increased 2 fold, while appending to a list has a fixed cost.
+        std::list<std::vector<uint8_t>> _chunks;
+
+        // Fragments are 32K long
+        static constexpr size_t kChunkSize = 1 << 15;
+
+        // Underlying TCP socket
         std::shared_ptr<Socket> _socket;
 
+        // Hold the state of the connection (OPEN, CLOSED, etc...)
         std::atomic<ReadyStateValues> _readyState;
 
         OnCloseCallback _onCloseCallback;
         uint16_t _closeCode;
         std::string _closeReason;
         size_t _closeWireSize;
+        bool _closeRemote;
         mutable std::mutex _closeDataMutex;
 
+        // Data used for Per Message Deflate compression (with zlib)
         WebSocketPerMessageDeflate _perMessageDeflate;
         WebSocketPerMessageDeflateOptions _perMessageDeflateOptions;
         std::atomic<bool> _enablePerMessageDeflate;
 
         // Used to cancel dns lookup + socket connect + http upgrade
         std::atomic<bool> _requestInitCancellation;
-        
-        // Optional Heartbeat
-        int _heartBeatPeriod;
-        static const int kDefaultHeartBeatPeriod;
-        const static std::string kHeartBeatPingMessage;
-        mutable std::mutex _lastSendTimePointMutex;
-        std::chrono::time_point<std::chrono::steady_clock> _lastSendTimePoint;
 
-        // No data was send through the socket for longer that the hearbeat period
-        bool exceedSendHeartBeatTimeOut();
+        // Constants for dealing with closing conneections
+        static const uint16_t kInternalErrorCode;
+        static const uint16_t kAbnormalCloseCode;
+        static const uint16_t kProtocolErrorCode;
+        static const std::string kInternalErrorMessage;
+        static const std::string kAbnormalCloseMessage;
+        static const std::string kPingTimeoutMessage;
+        static const std::string kProtocolErrorMessage;
+
+        // enable auto response to ping
+        bool _enablePong;
+        static const bool kDefaultEnablePong;
+
+        // Optional ping and pong timeout
+        // if both ping interval and timeout are set (> 0),
+        // then use GCD of these value to wait for the lowest time
+        int _pingIntervalSecs;
+        int _pingTimeoutSecs;
+        int _pingIntervalOrTimeoutGCDSecs;
+
+        static const int kDefaultPingIntervalSecs;
+        static const int kDefaultPingTimeoutSecs;
+        static const std::string kPingMessage;
+
+        // We record when ping are being sent so that we can know when to send the next one
+        // We also record when pong are being sent as a reply to pings, to close the connections
+        // if no pong were received sufficiently fast.
+        mutable std::mutex _lastSendPingTimePointMutex;
+        mutable std::mutex _lastReceivePongTimePointMutex;
+        std::chrono::time_point<std::chrono::steady_clock> _lastSendPingTimePoint;
+        std::chrono::time_point<std::chrono::steady_clock> _lastReceivePongTimePoint;
+
+        // If this function returns true, it is time to send a new ping
+        bool pingIntervalExceeded();
+
+        // No PONG data was received through the socket for longer than ping timeout delay
+        bool pingTimeoutExceeded();
 
         void sendOnSocket();
-        WebSocketSendInfo sendData(wsheader_type::opcode_type type, 
+        WebSocketSendInfo sendData(wsheader_type::opcode_type type,
                                    const std::string& message,
-                                   bool compress);
+                                   bool compress,
+                                   const OnProgressCallback& onProgressCallback = nullptr);
 
-        void emitMessage(MessageKind messageKind, 
+        void sendFragment(wsheader_type::opcode_type type,
+                          bool fin,
+                          std::string::const_iterator begin,
+                          std::string::const_iterator end,
+                          bool compress);
+
+        void emitMessage(MessageKind messageKind,
                          const std::string& message,
                          const wsheader_type& ws,
                          const OnMessageCallback& onMessageCallback);
@@ -144,9 +224,10 @@ namespace ix
                                 std::string::const_iterator end,
                                 uint64_t message_size,
                                 uint8_t masking_key[4]);
-        void appendToSendBuffer(const std::vector<uint8_t>& buffer);
 
         unsigned getRandomUnsigned();
         void unmaskReceiveBuffer(const wsheader_type& ws);
+
+        std::string getMergedChunks() const;
     };
 }

makefile

@@ -1,22 +1,41 @@
 #
 # This makefile is just used to easily work with docker (linux build)
 #
-all: run
+all: brew
+
+install: brew
+
+# Use -DCMAKE_INSTALL_PREFIX= to install into another location
+# on osx it is good practice to make /usr/local user writable
+# sudo chown -R `whoami`/staff /usr/local
+brew:
+	mkdir -p build && (cd build ; cmake -DUSE_TLS=1 .. ; make -j install)
+
+uninstall:
+	xargs rm -fv < build/install_manifest.txt
 
 .PHONY: docker
+
+NAME   := bsergean/ws
+TAG    := $(shell cat DOCKER_VERSION)
+IMG    := ${NAME}:${TAG}
+LATEST := ${NAME}:latest
+BUILD  := ${NAME}:build
+
 docker:
-	docker build -t ws_connect:latest .
+	docker build -t ${IMG} .
+	docker tag ${IMG} ${BUILD}
 
-run: docker
-	docker run --cap-add sys_ptrace -it ws_connect:latest bash
+docker_push:
+	docker tag ${IMG} ${LATEST}
+	docker push ${LATEST}
 
-build:
-	(cd examples/satori_publisher ; mkdir -p build ; cd build ; cmake .. ; make)
-	(cd examples/chat ; mkdir -p build ; cd build ; cmake .. ; make)
-	(cd examples/ping_pong ; mkdir -p build ; cd build ; cmake .. ; make)
-	(cd examples/ws_connect ; mkdir -p build ; cd build ; cmake .. ; make)
-	(cd examples/echo_server ; mkdir -p build ; cd build ; cmake .. ; make)
-	(cd examples/broadcast_server ; mkdir -p build ; cd build ; cmake .. ; make)
+run:
+	docker run --cap-add sys_ptrace --entrypoint=bash -it bsergean/ws:build
+
+# this is helpful to remove trailing whitespaces
+trail:
+	sh third_party/remote_trailing_whitespaces.sh
 
 # That target is used to start a node server, but isn't required as we have 
 # a builtin C++ server started in the unittest now
@@ -24,10 +43,13 @@ test_server:
 	(cd test && npm i ws && node broadcast-server.js)
 
 # env TEST=Websocket_server make test
-# env TEST=websocket_server make test
+# env TEST=Websocket_chat make test
 # env TEST=heartbeat make test
 test:
-	python test/run.py
+	python2.7 test/run.py
+
+ws_test: all
+	(cd ws ; bash test_ws.sh)
 
 # For the fork that is configured with appveyor
 rebase_upstream:
@@ -36,5 +58,9 @@ rebase_upstream:
 	git reset --hard upstream/master
 	git push origin master --force
 
+install_cmake_for_linux:
+	mkdir -p /tmp/cmake
+	(cd /tmp/cmake ; curl -L -O https://github.com/Kitware/CMake/releases/download/v3.14.0/cmake-3.14.0-Linux-x86_64.tar.gz ; tar zxf cmake-3.14.0-Linux-x86_64.tar.gz)
+
 .PHONY: test
 .PHONY: build