Skip to content

Commit 7ad7417

Browse files
committed
Update header file naming and improve backward compatibility
- Renamed canonical header from slick/stream_buffer_multiplexer.h to slick/stream_buffer_multiplexer.hpp. - Added backward-compatibility shim in the old header to direct users to update their includes. - Updated CMakeLists.txt to reflect the new version 1.0.1 and dependency changes. - Modified README and test files to use the new header file name. - Documented changes in CHANGELOG.md.
1 parent 0984cfd commit 7ad7417

8 files changed

Lines changed: 363 additions & 338 deletions

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
All notable changes to this project will be documented in this file.
44

5+
## [1.0.1] - 2026-06-17
6+
7+
- Renamed canonical header from slick/stream_buffer_multiplexer.h to slick/stream_buffer_multiplexer.hpp. The old .h path is kept as a backward-compatibility shim that re-exports the new header and emits a compiler warning directing users to update their includes.
8+
59
## [1.0.0] - 2026-06-15
610

711
### Added

CMakeLists.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
cmake_minimum_required(VERSION 3.10)
22

33
project(slick-stream-buffer-multiplexer
4-
VERSION 1.0.0
4+
VERSION 1.0.1
55
DESCRIPTION "A C++ lock-free MPMC byte stream buffer multiplexer"
66
LANGUAGES CXX)
77

@@ -10,7 +10,7 @@ set(CMAKE_CXX_STANDARD 20)
1010
# Options:
1111
option(BUILD_SLICK_STREAM_BUFFER_MULTIPLEXER_TESTS "Build tests" ${PROJECT_IS_TOP_LEVEL})
1212

13-
find_package(slick-stream-buffer 1.0.4 CONFIG QUIET)
13+
find_package(slick-stream-buffer 1.0.5 CONFIG QUIET)
1414

1515
if (NOT slick-stream-buffer_FOUND)
1616
include(FetchContent)
@@ -20,7 +20,7 @@ if (NOT slick-stream-buffer_FOUND)
2020
FetchContent_Declare(
2121
slick-stream-buffer
2222
GIT_REPOSITORY https://github.com/SlickQuant/slick-stream-buffer.git
23-
GIT_TAG v1.0.4 # See https://github.com/SlickQuant/slick-stream-buffer/releases for latest version
23+
GIT_TAG v1.0.5 # See https://github.com/SlickQuant/slick-stream-buffer/releases for latest version
2424
)
2525
FetchContent_MakeAvailable(slick-stream-buffer)
2626
else()

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ returning a zero-copy view directly into that producer's ring.
6666
Header-only. Add the `include` directory to your include path:
6767

6868
```cpp
69-
#include <slick/stream_buffer_multiplexer.h>
69+
#include <slick/stream_buffer_multiplexer.hpp>
7070
```
7171

7272
### Using CMake FetchContent
@@ -90,7 +90,7 @@ target_link_libraries(your_target PRIVATE slick::stream_buffer_multiplexer)
9090
### Registering producers and publishing
9191

9292
```cpp
93-
#include <slick/stream_buffer_multiplexer.h>
93+
#include <slick/stream_buffer_multiplexer.hpp>
9494

9595
// shared record queue: 1024 slots (must be power of 2), local memory
9696
slick::stream_buffer_multiplexer mux(1024);

include/slick/stream_buffer_multiplexer.h

Lines changed: 6 additions & 330 deletions
Large diffs are not rendered by default.

include/slick/stream_buffer_multiplexer.hpp

Lines changed: 345 additions & 0 deletions
Large diffs are not rendered by default.

tests/multiplexer_mpmc_tests.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
********************************************************************************/
1111

1212
#include <gtest/gtest.h>
13-
#include <slick/stream_buffer_multiplexer.h>
13+
#include <slick/stream_buffer_multiplexer.hpp>
1414

1515
#include <atomic>
1616
#include <cstring>

tests/multiplexer_shm_tests.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
********************************************************************************/
1111

1212
#include <gtest/gtest.h>
13-
#include <slick/stream_buffer_multiplexer.h>
13+
#include <slick/stream_buffer_multiplexer.hpp>
1414

1515
#include <cstring>
1616
#include <stdexcept>

tests/multiplexer_tests.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
********************************************************************************/
1111

1212
#include <gtest/gtest.h>
13-
#include <slick/stream_buffer_multiplexer.h>
13+
#include <slick/stream_buffer_multiplexer.hpp>
1414

1515
#include <atomic>
1616
#include <cstring>

0 commit comments

Comments
 (0)