Merge remote-tracking branch 'upstream/master'

* upstream/master:
  docs: update compatibility table for Socket.IO v4
  docs: fix title format (socketio#297)
  feat: allow resource path to be set in connection URI (socketio#134)
  fix: resolve client_impl::ping LOG call syntax in debug builds
  fix: resolve socketio#254: handle closing sockets upon on_fail events
  fix: lower the minimum CMake supported version
  feat: implement socketio#45: add support for logging configuration
  feat: add support for Socket.IO v3
  refactor: use correct Engine.IO protocol revision
  refactor: use standard install paths (socketio#58)
  ci: migrate to GitHub Actions
  chore: update .gitignore with cmake output
  refactor: remove Boost dependency (socketio#176)

Author: druckdev

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+    steps:
+    - name: Checkout
+      uses: actions/[email protected]
+
+    - name: Build project
+      uses: nicledomaS/[email protected]
+      with:
+        submodule_update: ON
+        run_tests: ON
+        unit_test_build: -DBUILD_UNIT_TESTS=ON
+        cmake_args: -DCMAKE_CXX_FLAGS=-std=c++11

.gitignore

@@ -1,2 +1,9 @@
 build/
-**/*.user
+**/*.user
+
+CMakeCache.txt
+CMakeFiles/
+Makefile
+cmake_install.cmake
+install_manifest.txt
+libsioclient.a

.gitmodules

@@ -4,3 +4,9 @@
 [submodule "lib/rapidjson"]
 	path = lib/rapidjson
 	url = https://github.com/miloyip/rapidjson.git
+[submodule "lib/asio"]
+	path = lib/asio
+	url = https://github.com/chriskohlhoff/asio.git
+[submodule "lib/catch"]
+	path = lib/catch
+	url = https://github.com/philsquared/Catch.git

.travis.yml

@@ -168,6 +168,19 @@ Set listener for reconnecting is in process.
 
 Set listener for reconnecting event, called once a delayed connecting is scheduled.
 
+#### Logs
+`void set_logs_default()`
+
+Configure logs to the default level (connect, disconnect, app)
+
+`void set_logs_quiet()`
+
+Configure logs to the quiet level
+
+`void set_logs_verbose()`
+
+Configure logs to the verbose level
+
 #### Namespace
 `socket::ptr socket(std::string const& nsp)`
 

API.md

@@ -1,8 +1,8 @@
-cmake_minimum_required(VERSION 3.1.0 FATAL_ERROR)
+cmake_minimum_required(VERSION 2.8 FATAL_ERROR)
 PROJECT(sioclient)
 
 option(BUILD_SHARED_LIBS "Build the shared library" OFF)
-option(Boost_USE_STATIC_LIBS "Use Boost static version" ON)
+option(BUILD_UNIT_TESTS  "Builds unit tests target" OFF)
 
 set(MAJOR 1)
 set(MINOR 6)
@@ -16,27 +16,35 @@ MESSAGE(SEND_ERROR "CMAKE_BUILD_TYPE must be either Release or Debug")
 return()
 endif()
 
-set(BOOST_VER "1.55.0" CACHE STRING "boost version" )
-
-set(Boost_USE_MULTITHREADED ON) 
-set(Boost_USE_STATIC_RUNTIME OFF) 
-find_package(Boost ${BOOST_VER} REQUIRED COMPONENTS system date_time random) 
-
 aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src ALL_SRC)
 aux_source_directory(${CMAKE_CURRENT_LIST_DIR}/src/internal ALL_SRC)
 file(GLOB ALL_HEADERS ${CMAKE_CURRENT_LIST_DIR}/src/*.h )
 set(SIO_INCLUDEDIR ${CMAKE_CURRENT_LIST_DIR})
 
+add_definitions(
+    # These will force ASIO to compile without Boost
+    -DBOOST_DATE_TIME_NO_LIB
+    -DBOOST_REGEX_NO_LIB
+    -DASIO_STANDALONE
+    # These will force WebsocketPP to compile with C++11
+    -D_WEBSOCKETPP_CPP11_STL_
+    -D_WEBSOCKETPP_CPP11_FUNCTIONAL_
+)
+
 add_library(sioclient ${ALL_SRC})
-target_include_directories(sioclient PRIVATE ${Boost_INCLUDE_DIRS} 
+target_include_directories(sioclient PRIVATE 
     ${CMAKE_CURRENT_LIST_DIR}/src 
     ${CMAKE_CURRENT_LIST_DIR}/lib/websocketpp 
     ${CMAKE_CURRENT_LIST_DIR}/lib/rapidjson/include
+    ${CMAKE_CURRENT_LIST_DIR}/lib/asio/asio/include
 )
 
+if (CMAKE_VERSION VERSION_GREATER "3.1")
 set_property(TARGET sioclient PROPERTY CXX_STANDARD 11)
 set_property(TARGET sioclient PROPERTY CXX_STANDARD_REQUIRED ON)
-target_link_libraries(sioclient PRIVATE ${Boost_LIBRARIES})
+else()
+set_property(TARGET sioclient APPEND_STRING PROPERTY COMPILE_FLAGS "-std=c++11")
+endif()
 if(BUILD_SHARED_LIBS)
 set_target_properties(sioclient
 	PROPERTIES
@@ -49,16 +57,21 @@ list(APPEND TARGET_LIBRARIES sioclient)
 find_package(OpenSSL)
 if(OPENSSL_FOUND)
 add_library(sioclient_tls ${ALL_SRC})
-target_include_directories(sioclient_tls PRIVATE ${Boost_INCLUDE_DIRS} 
+target_include_directories(sioclient_tls PRIVATE
     ${CMAKE_CURRENT_LIST_DIR}/src 
     ${CMAKE_CURRENT_LIST_DIR}/lib/websocketpp 
     ${CMAKE_CURRENT_LIST_DIR}/lib/rapidjson/include
+    ${CMAKE_CURRENT_LIST_DIR}/lib/asio/asio/include
     ${OPENSSL_INCLUDE_DIR}
 )
 
+if (CMAKE_VERSION VERSION_GREATER "3.1")
 set_property(TARGET sioclient_tls PROPERTY CXX_STANDARD 11)
 set_property(TARGET sioclient_tls PROPERTY CXX_STANDARD_REQUIRED ON)
-target_link_libraries(sioclient_tls PRIVATE ${Boost_LIBRARIES} ${OPENSSL_LIBRARIES} )
+target_link_libraries(sioclient_tls PRIVATE ${OPENSSL_LIBRARIES} )
+else()
+set_property(TARGET sioclient_tls APPEND_STRING PROPERTY COMPILE_FLAGS "-std=c++11")
+endif()
 target_compile_definitions(sioclient_tls PRIVATE -DSIO_TLS)
 if(BUILD_SHARED_LIBS)
 set_target_properties(sioclient_tls
@@ -71,14 +84,18 @@ list(APPEND TARGET_LIBRARIES sioclient_tls)
 
 endif()
 
+include(GNUInstallDirs)
+
 install(FILES ${ALL_HEADERS} 
-    DESTINATION "${CMAKE_CURRENT_LIST_DIR}/build/include"
+    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
 )
 
 install(TARGETS ${TARGET_LIBRARIES}
-    DESTINATION "${CMAKE_CURRENT_LIST_DIR}/build/lib/${CMAKE_BUILD_TYPE}"
+    DESTINATION ${CMAKE_INSTALL_LIBDIR}
 )
 
-install(FILES ${Boost_LIBRARIES} 
-    DESTINATION "${CMAKE_CURRENT_LIST_DIR}/build/lib/${CMAKE_BUILD_TYPE}"
-)
+if(BUILD_UNIT_TESTS)
+message(STATUS "Building with unit test support.")
+enable_testing()
+add_subdirectory(test)
+endif()

BOOST.md

@@ -1,48 +1,13 @@
 ## Install
 
 ### With CMake
-1. Install boost, see [Boost setup](#boost_setup) section.
-2. Use `git clone --recurse-submodules https://github.com/socketio/socket.io-client-cpp.git` to clone your local repo.
-3. Run `cmake -DBOOST_ROOT:STRING=<your boost install folder> -DBOOST_VER:STRING=<your boost version> ./`
-4. Run `make install`(if makefile generated) or open generated project (if project file generated) to build.
-5. Outputs is under `./build`, link with the all static libs under `./build/lib` and  include headers under `./build/include` in your client code where you want to use it.
-
-* If you're using boost without install,you can specify `boost include dir` and `boost lib dir` separately by:
-```bash
-cmake
--DBOOST_INCLUDEDIR=<your boost include folder>
--DBOOST_LIBRARYDIR=<your boost lib folder>
--DBOOST_VER:STRING=<your boost version>
-./
-```
-* CMake didn't allow merging static libraries,but they're all copied to `./build/lib`, you can DIY if you like.
+1. Use `git clone --recurse-submodules https://github.com/socketio/socket.io-client-cpp.git` to clone your local repo.
+2. Run `cmake  ./`
+3. Run `make install`(if makefile generated) or open generated project (if project file generated) to build.
+4. Outputs is under `./build`, link with the all static libs under `./build/lib` and  include headers under `./build/include` in your client code where you want to use it.
 
 ### Without CMake
-1. Install boost, see [Boost setup](#boost_setup) section.
-2. Use `git clone --recurse-submodules https://github.com/socketio/socket.io-client-cpp.git` to clone your local repo.
-3. Add `<your boost install folder>/include`,`./lib/websocketpp` and `./lib/rapidjson/include` to headers search path.
-4. Include all files under `./src` in your project, add `sio_client.cpp`,`sio_socket.cpp`,`internal/sio_client_impl.cpp`, `internal/sio_packet.cpp` to source list.
-5. Add `<your boost install folder>/lib` to library search path, add `boost.lib`(Win32) or `-lboost`(Other) link option.
-6. Include `sio_client.h` in your client code where you want to use it.
-
-## Boost setup
-
-1. Download boost from [boost.org](http://www.boost.org/).
-1. Unpack boost to some place.
-1. Run either .\bootstrap.bat (on Windows), or ./bootstrap.sh (on other operating systems) under boost folder.
-
-## Boost build (Build the necessary subset only)
-Windows (or other mainstream desktop platforms shall work too):
-
-The following script will build the necessary subset:
-
-```bash
-bjam install --prefix="<your boost install folder>" --with-system --with-date_time --with-random link=static runtime-link=shared threading=multi
-```
-Optionally You can merge all output .lib files into a fat one, especially if you're not using cmake.
-
-In output folder, run:
-
-```bash
-lib.exe /OUT:boost.lib *
-```
+1. Use `git clone --recurse-submodules https://github.com/socketio/socket.io-client-cpp.git` to clone your local repo.
+2. Add `./lib/asio/asio/include`, `./lib/websocketpp` and `./lib/rapidjson/include` to headers search path.
+3. Include all files under `./src` in your project, add `sio_client.cpp`,`sio_socket.cpp`,`internal/sio_client_impl.cpp`, `internal/sio_packet.cpp` to source list.
+4. Include `sio_client.h` in your client code where you want to use it.

CMakeLists.txt

@@ -1,20 +1,45 @@
 # Socket.IO C++ Client
-[![Build Status](https://travis-ci.org/socketio/socket.io-client-cpp.svg)](https://travis-ci.org/socketio/socket.io-client-cpp)
+
+[![Build Status](https://github.com/socketio/socket.io-client-cpp/workflows/CI/badge.svg)](https://github.com/socketio/socket.io-client-cpp/actions)
 
 By virtue of being written in C++, this client works in several different platforms. The [examples](https://github.com/socketio/socket.io-client-cpp/tree/master/examples) folder contains an iPhone, QT and Console example chat client! It depends on [websocket++](https://github.com/zaphoyd/websocketpp) and is inspired by [socket.io-clientpp](https://github.com/ebshimizu/socket.io-clientpp).
 
 [![Clients with iPhone, QT, Console and web](https://cldup.com/ukvVVZmvYV.png)](https://github.com/socketio/socket.io-client-cpp/tree/master/examples)
 
+## Compatibility table
+
+<table>
+  <tr>
+    <th rowspan="2">C++ Client version</th>
+    <th colspan="2">Socket.IO server version</th>
+  </tr>
+  <tr>
+    <td align="center">1.x / 2.x</td>
+    <td align="center">3.x / 4.x</td>
+  </tr>
+  <tr>
+    <td>2.x (<code>2.x</code> branch)</td>
+    <td align="center">YES</td>
+    <td align="center">YES, with <code><a href="https://socket.io/docs/v4/server-initialization/#allowEIO3">allowEIO3: true</a></code></td>
+  </tr>
+  <tr>
+    <td>3.x (<code>master</code> branch)</td>
+    <td align="center">NO</td>
+    <td align="center">YES</td>
+  </tr>
+</table>
+
 ## Features
 
 - 100% written in modern C++11
-- Compatible with socket.io 1.0+ protocol
 - Binary support
 - Automatic JSON encoding
 - Multiplex support
 - Similar API to the Socket.IO JS client
 - Cross platform
 
+Note: Only the WebSocket transport is currently implemented (no fallback to HTTP long-polling)
+
 ## Installation alternatives
 
 * [With CMAKE](./INSTALL.md#with-cmake)