Skip to content

Commit 5344942

Browse files
committed
rename slick_buffer.h to slick_buffer.hpp; bump version; update CHANGELOG and README
1 parent 178515b commit 5344942

7 files changed

Lines changed: 720 additions & 696 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
## v1.0.5 - 2026-06-16
4+
- Renamed canonical header from `slick/stream_buffer.h` to `slick/stream_buffer.hpp`.
5+
The old `.h` path is kept as a backward-compatibility shim that re-exports the new
6+
header and emits a compiler warning directing users to update their includes.
7+
38
## v1.0.4 - 2026-06-12
49
- Separatad slick/dynamic_stream_buffer.h into slick-dynamic-buffer repo due to vcpk dependencies issue
510
- Added `slick::stream_buffer` as the preferred snake_case spelling of

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
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
4-
VERSION 1.0.4
4+
VERSION 1.0.5
55
DESCRIPTION "A C++ lock-free SPMC byte stream buffer"
66
LANGUAGES CXX)
77

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ zero-copy as `(pointer, length)` pairs — the broadcast pattern of
5555
Header-only. Add the `include` directory to your include path:
5656

5757
```cpp
58-
#include <slick/stream_buffer.h>
58+
#include <slick/stream_buffer.hpp>
5959
```
6060

6161
### Using vcpkg
@@ -92,7 +92,7 @@ target_link_libraries(your_target PRIVATE slick::stream_buffer)
9292
### Producer: receive bytes, publish on message boundaries
9393

9494
```cpp
95-
#include <slick/stream_buffer.h>
95+
#include <slick/stream_buffer.hpp>
9696

9797
// 64 MB data ring, 64K message records; named -> shared memory, nullptr -> local
9898
slick::stream_buffer stream(1ull << 26, 1u << 16, "market_data");
@@ -127,7 +127,7 @@ for (;;) {
127127
### Minimal end-to-end example
128128

129129
```cpp
130-
#include <slick/stream_buffer.h>
130+
#include <slick/stream_buffer.hpp>
131131

132132
slick::stream_buffer buf(1024, 16); // capacity bytes, record count (both pow2)
133133

0 commit comments

Comments
 (0)