Templatize Websocket on read-buffer type; add slick stream-buffer backends (v3.0.0)

Replace the monolithic session-based implementation with a header-only template core
(detail/websocket_impl.hpp) that accepts any Beast-compatible read buffer. Explicitly
instantiate flat_buffer (default), slick::dynamic_buffer<stream_buffer>, and
slick::dynamic_buffer<producer_buffer> backends for lock-free zero-copy streaming.
Shared-backend reconnect reuses the same ring across open() cycles for slick buffer
types. Fix URL parsing for bare host:port forms and eliminate the tight-loop send
regression that fired before the socket reached CONNECTED. Add slick_buffer_tests,
three new buffer-specific examples, slick-stream-buffer/-multiplexer dependencies,
and .editorconfig.

Author: kzhdev

.editorconfig

@@ -0,0 +1,19 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# 4-space indentation for all files
+[*.{py,js,ts,json}]
+indent_style = space
+indent_size = 4
+
+# 2-space indentation for markup
+[*.{html,css,md,yml,yaml}]
+indent_style = space
+indent_size = 2
+
+# Trims trailing whitespace for all files except Makefiles
+[*.{cs,java,cpp,h}]
+trim_trailing_whitespace = true

CHANGELOG.md

@@ -1,24 +1,53 @@
-# [v3.0.0] - 2026-06-12
+# [v3.0.0] - 2026-06-16
 
 ## Added
-- Shared-buffer WebSocket read path built on `slick::dynamic_buffer` / `slick::stream_buffer`.
-- Configurable WebSocket buffer sizing and optional shared-memory naming via the `Websocket` constructor.
-- `Websocket::drain_data()` and `Websocket::initial_reading_index()` for draining published messages from a caller-owned thread.
-- New example `websocket_reading_from_different_thread.cpp` showing service-thread callbacks plus caller-thread draining.
-- Additional same-object reconnect tests covering deferred reconnect while disconnecting, rapid reconnect buffer handoff, and cancellation of a pending deferred open.
+- `Websocket<BufferT>` is now a class template parameterized on the read-buffer
+  type. Default is `boost::beast::flat_buffer`, and the library explicitly
+  instantiates the supported slick stream-buffer backends.
+- New constructor overload accepting a `std::shared_ptr<BackendT>`:
+  ```cpp
+  Websocket<slick::dynamic_buffer<slick::stream_buffer>> ws(url, callbacks..., sb);
+  Websocket<slick::dynamic_buffer<producer_buffer>>      ws(url, callbacks..., pb);
+  ```
+  This allows `slick::dynamic_buffer<stream_buffer>` and
+  `slick::dynamic_buffer<stream_buffer_multiplexer::producer_buffer>` as read-buffer
+  backends for lock-free zero-copy streaming while keeping application code on the
+  public `<slick/net/websocket.hpp>` include.
+- Shared-backend reconnect: for slick dynamic-buffer types the same backend is
+  reused across `open()` cycles — records from all sessions accumulate in the ring.
+  For `flat_buffer` each reconnect starts a fresh buffer.
+- `slick_buffer_tests` — new test binary exercising the `stream_buffer` and
+  `producer_buffer` paths end-to-end (construction, data round-trip, reconnect).
+- Additional same-object reconnect tests covering deferred reconnect while
+  disconnecting, rapid reconnect buffer handoff, and cancellation of a pending
+  deferred open.
+- Custom buffer types can opt into template definitions by defining
+  `SLICK_NET_WEBSOCKET_HEADER_ONLY` before including `<slick/net/websocket.hpp>`.
+- `websocket_with_custom_buffer_example` demonstrates the custom-buffer opt-in path.
 
 ## Changed
 - **BREAKING:** `Websocket::reset_callbacks()` was replaced by `Websocket::detach()`.
-- `Websocket::open()` now defers a same-object reconnect until the previous session's read loop releases the shared read buffer.
-- `Websocket::close()` can now cancel a pending deferred `open()` before the new session starts.
-- `Websocket::send()` and `Websocket::send_binary_data()` now accept an optional `suppress_log` flag.
-- The packaged CMake dependency wiring now finds or fetches `slick-dynamic-buffer` for both source builds and installed-package consumers.
-- GoogleTest discovery now runs in `PRE_TEST` mode to avoid slow first-launch failures during the build step.
+- `Websocket::open()` now defers a same-object reconnect until the previous
+  session's read loop releases the shared backend (shared-buffer path only;
+  `flat_buffer` starts immediately).
+- `Websocket::close()` can now cancel a pending deferred `open()` before the new
+  session starts.
+- `Websocket::send()` and `Websocket::send_binary_data()` now accept an optional
+  `suppress_log` flag.
+- GoogleTest discovery now runs in `PRE_TEST` mode to avoid slow first-launch
+  failures during the build step.
 
 ## Fixed
-- Rapid same-object reconnect no longer allows overlapping producers to touch the shared read buffer.
-- Detached or superseded WebSocket sessions now suppress stale error and disconnect callbacks during teardown.
-- Partial read data from an interrupted session is discarded before the next session starts reading on the shared buffer.
+- Rapid same-object reconnect no longer allows overlapping producers to touch the
+  shared read buffer.
+- Detached or superseded WebSocket sessions now suppress stale error and disconnect
+  callbacks during teardown.
+- Partial read data from an interrupted session is discarded before the next session
+  starts reading on the shared buffer.
+- Queued sends made while a connection is still handshaking no longer repost
+  writes in a tight loop before the socket reaches `CONNECTED`.
+- URL parsing now handles normal short `host:port` forms such as `abc:9000`
+  instead of treating the colon as part of the host.
 
 # [v2.1.0] - 2026-06-04
 

CMakeLists.txt

@@ -1,6 +1,10 @@
 cmake_minimum_required(VERSION 3.20)
 
-option(LINK_STATICALLY "Link statically" OFF)
+option(LINK_STATICALLY "Link Boost and OpenSSL statically" OFF)
+option(ENABLE_ASAN "Enable AddressSanitizer" OFF)
+option(BUILD_SLICK_NET_TESTS "Build tests" ${PROJECT_IS_TOP_LEVEL})
+option(BUILD_SLICK_NET_EXAMPLES "Build examples" ${PROJECT_IS_TOP_LEVEL})
+
 if (LINK_STATICALLY)
     if (MSVC)
         set(VCPKG_TARGET_TRIPLET x64-windows-static)
@@ -37,7 +41,7 @@ if (slick-shm_FOUND)
     message(STATUS "slick-shm: ${slick-shm_VERSION}")
 endif()
 
-find_package(slick-queue 1.2.2 CONFIG QUIET)
+find_package(slick-queue 1.5.0 CONFIG QUIET)
 if (NOT slick-queue_FOUND)
     message(STATUS "Fetching slick-queue...")
     include(FetchContent)
@@ -46,27 +50,56 @@ if (NOT slick-queue_FOUND)
     FetchContent_Declare(
         slick-queue
         GIT_REPOSITORY https://github.com/SlickQuant/slick-queue.git
-        GIT_TAG v1.4.1 # See https://github.com/SlickQuant/slick-queue/releases for latest version
+        GIT_TAG v1.5.0 # See https://github.com/SlickQuant/slick-queue/releases for latest version
     )
     FetchContent_MakeAvailable(slick-queue)
 else()
-    message(STATUS "slick-queue: ${slick-queue_VERSION}")
+    message(STATUS "Found slick-queue: ${slick-queue_VERSION}")
+endif()
+
+find_package(slick-stream-buffer 1.0.5 CONFIG QUIET)
+if (NOT slick-stream-buffer_FOUND)
+    message(STATUS "Fetching slick-stream-buffer...")
+    include(FetchContent)
+    set(BUILD_SLICK_STREAM_BUFFER_TESTS OFF CACHE BOOL "" FORCE)
+    FetchContent_Declare(
+        slick-stream-buffer
+        GIT_REPOSITORY https://github.com/SlickQuant/slick-stream-buffer.git
+        GIT_TAG v1.0.5
+    )
+    FetchContent_MakeAvailable(slick-stream-buffer)
+else()
+    message(STATUS "Found slick-stream-buffer: ${slick-stream-buffer_VERSION}")
 endif()
 
-find_package(slick-dynamic-buffer CONFIG QUIET)
+find_package(slick-stream-buffer-multiplexer 1.0.1 CONFIG QUIET)
+if (NOT slick-stream-buffer-multiplexer_FOUND)
+    message(STATUS "Fetching slick-stream-buffer-multiplexer...")
+    include(FetchContent)
+    set(BUILD_SLICK_STREAM_BUFFER_MULTIPLEXER_TESTS OFF CACHE BOOL "" FORCE)
+    FetchContent_Declare(
+        slick-stream-buffer-multiplexer
+        GIT_REPOSITORY https://github.com/SlickQuant/slick-stream-buffer-multiplexer.git
+        GIT_TAG v1.0.1
+    )
+    FetchContent_MakeAvailable(slick-stream-buffer-multiplexer)
+else()
+    message(STATUS "Found slick-stream-buffer-multiplexer: ${slick-stream-buffer-multiplexer_VERSION}")
+endif()
+
+find_package(slick-dynamic-buffer 1.0.1 CONFIG QUIET)
 if (NOT slick-dynamic-buffer_FOUND)
     message(STATUS "Fetching slick-dynamic-buffer...")
     include(FetchContent)
-    # Disable tests for slick-dynamic-buffer
     set(BUILD_SLICK_DYNAMIC_BUFFER_TESTS OFF CACHE BOOL "" FORCE)
     FetchContent_Declare(
         slick-dynamic-buffer
         GIT_REPOSITORY https://github.com/SlickQuant/slick-dynamic-buffer.git
-        GIT_TAG v1.0.0 # See https://github.com/SlickQuant/slick-dynamic-buffer/releases for latest version
+        GIT_TAG v1.0.1
     )
     FetchContent_MakeAvailable(slick-dynamic-buffer)
 else()
-    message(STATUS "slick-dynamic-buffer: ${slick-dynamic-buffer_VERSION}")
+    message(STATUS "Found slick-dynamic-buffer: ${slick-dynamic-buffer_VERSION}")
 endif()
 
 message(STATUS "OpenSSL: ${OPENSSL_INCLUDE_DIR}")
@@ -76,7 +109,8 @@ add_library(slick-net STATIC
     src/http.cpp
     src/http_stream.cpp
     src/websocket.cpp
-    src/websocket_session.cpp
+    src/websocket_stream_buffer.cpp
+    src/websocket_stream_buffer_multiplexer.cpp
     src/logging.cpp
 )
 add_library(slick::net ALIAS slick-net)
@@ -88,7 +122,17 @@ target_include_directories(slick-net PUBLIC
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
     $<INSTALL_INTERFACE:include>
 )
-target_link_libraries(slick-net PUBLIC slick::queue slick::dynamic_buffer Boost::asio Boost::beast Boost::context OpenSSL::SSL OpenSSL::Crypto)
+target_link_libraries(slick-net PUBLIC
+    slick::queue
+    slick::stream_buffer
+    slick::stream_buffer_multiplexer
+    slick::dynamic_buffer
+    Boost::asio
+    Boost::beast
+    Boost::context
+    OpenSSL::SSL
+    OpenSSL::Crypto
+)
 set_target_properties(slick-net PROPERTIES EXPORT_NAME net)
 
 
@@ -109,7 +153,6 @@ else()
     endif()
 endif()
 
-option(ENABLE_ASAN "Enable AddressSanitizer" OFF)
 if(ENABLE_ASAN)
   if(MSVC)
     # MSVC AddressSanitizer (requires Visual Studio 2022 17.7+)
@@ -133,7 +176,6 @@ if(ENABLE_ASAN)
   endif()
 endif()
 
-option(BUILD_SLICK_NET_TESTS "Build tests" ${PROJECT_IS_TOP_LEVEL})
 if (BUILD_SLICK_NET_TESTS)
     message(STATUS "Building slick-net tests")
     enable_testing()
@@ -142,7 +184,6 @@ else()
     message(STATUS "Skipping slick-net tests")
 endif()
 
-option(BUILD_SLICK_NET_EXAMPLES "Build examples" ${PROJECT_IS_TOP_LEVEL})
 if(BUILD_SLICK_NET_EXAMPLES)
     message(STATUS "Building slick::net examples")
     add_subdirectory(examples)