mirror of https://github.com/mutouyun/cpp-ipc.git synced 2025-12-06 08:46:45 +08:00

Go to file

木头云 91e4489a55 refactor(buffer): rename 'additional' parameter to 'mem_to_free' for clarity Header changes (include/libipc/buffer.h): - Rename: additional → mem_to_free (better semantic name) - Add documentation comments explaining the parameter's purpose - Clarifies that mem_to_free is passed to destructor instead of p - Use case: when data pointer is offset into a larger allocation Implementation changes (src/libipc/buffer.cpp): - Update parameter name in constructor implementation - No logic changes, just naming improvement Test changes (test/test_buffer.cpp): - Fix TEST_F(BufferTest, ConstructorWithMemToFree) - Previous test caused crash: passed stack variable address to destructor - New test correctly demonstrates the parameter's purpose: * Allocate 100-byte block * Use offset portion (bytes 25-75) as data * Destructor receives original block pointer for proper cleanup - Prevents double-free and invalid free errors Semantic explanation: buffer(data_ptr, size, destructor, mem_to_free) On destruction: destructor(mem_to_free ? mem_to_free : data_ptr, size) This allows: char* block = new char[100]; char* data = block + 25; buffer buf(data, 50, my_free, block); // Frees 'block', not 'data'		2025-11-30 05:09:56 +00:00
.github/workflows	Update c-cpp.yml	2021-07-10 13:52:44 +08:00
3rdparty	Fixed memory access exception in multithreading.	2023-10-28 16:44:16 +08:00
demo	mingw: use lower case windows.h	2025-11-17 09:56:49 +00:00
include/libipc	refactor(buffer): rename 'additional' parameter to 'mem_to_free' for clarity	2025-11-30 05:09:56 +00:00
src	refactor(buffer): rename 'additional' parameter to 'mem_to_free' for clarity	2025-11-30 05:09:56 +00:00
test	refactor(buffer): rename 'additional' parameter to 'mem_to_free' for clarity	2025-11-30 05:09:56 +00:00
.gitignore	disable warning C4858	2023-10-28 16:44:16 +08:00
CMakeLists.txt	Supplement similar demo under linux.	2023-10-28 16:44:16 +08:00
LICENSE	调整目录结构，隔离include路径，修正tls在win下的问题	2020-09-13 17:29:14 +08:00
performance.xlsx	performance.xlsx 更新图示说明	2021-10-17 14:32:38 +08:00
README.md	Update README.md	2025-02-09 17:00:48 +08:00

README.md

cpp-ipc (libipc) - C++ IPC Library

A high-performance inter-process communication library using shared memory on Linux/Windows.

Compilers with C++17 support are recommended (msvc-2017/gcc-7/clang-4)
No other dependencies except STL.
Only lock-free or lightweight spin-lock is used.
Circular array is used as the underline data structure.
ipc::route supports single write and multiple read. ipc::channel supports multiple read and write. (Note: currently, a channel supports up to 32 receivers, but there is no such a limit for the sender.)
Broadcasting is used by default, but user can choose any read/ write combinations.
No long time blind wait. (Semaphore will be used after a certain number of retries.)
Vcpkg way of installation is supported. E.g. vcpkg install cpp-ipc

Usage

See: Wiki

Performance

Environment	Value
Device	Lenovo ThinkPad T450
CPU	Intel® Core™ i5-4300U @ 2.5 GHz
RAM	16 GB
OS	Windows 7 Ultimate x64
Compiler	MSVC 2017 15.9.4

Unit & benchmark tests: test
Performance data: performance.xlsx

Reference

使用共享内存的跨平台（Linux/Windows，x86/x64/ARM）高性能IPC通讯库

推荐支持C++17的编译器（msvc-2017/gcc-7/clang-4）
除STL外，无其他依赖
无锁（lock-free）或轻量级spin-lock
底层数据结构为循环数组（circular array）
ipc::route支持单写多读，ipc::channel支持多写多读【注意：目前同一条通道最多支持32个receiver，sender无限制】
默认采用广播模式收发数据，支持用户任意选择读写方案
不会长时间忙等（重试一定次数后会使用信号量进行等待），支持超时
支持Vcpkg方式安装，如vcpkg install cpp-ipc

使用方法

详见：Wiki

性能

环境	值
设备	联想 ThinkPad T450
CPU	英特尔® Core™ i5-4300U @ 2.5 GHz
内存	16 GB
操作系统	Windows 7 Ultimate x64
编译器	MSVC 2017 15.9.4

单元测试和Benchmark测试: test
性能数据: performance.xlsx

README.md Unescape Escape