Skip to content

Commit 4c30c34

Browse files
Merge pull request #12 from connectivecpp/develop
Merge develop to main in anticipation of Lou's DBC pull request
2 parents d9f721b + 46cb245 commit 4c30c34

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
![GH Tag](https://img.shields.io/github/v/tag/connectivecpp/wait-queue?label=GH%20tag)
1212

13+
![License](https://img.shields.io/badge/License-Boost%201.0-blue)
14+
1315
## Overview
1416

1517
`wait_queue` is a multi-reader, multi-writer FIFO thread-safe wait queue (often called MPMC for multiple producer / multiple consumer) for transferring data between threads. It is templatized on the type of data passed through the queue as well as the queue container type. Data is passed with value semantics, either by copying or by moving (as opposed to a queue that transfers data by pointer or reference). The wait queue has both wait and no-wait pop semantics. A fixed size container (e.g. a `ring_span`) can be used, eliminating any and all dynamic memory management (useful in embedded or deterministic environments). Similarly, a circular buffer that only allocates on construction can be used, which eliminates dynamic memory management when pushing or popping values on or off the queue.
@@ -39,7 +41,7 @@ The unit test uses two third-party libraries (each is a single header-only file)
3941
- Martin Moene's [ring-span-lite](https://github.com/martinmoene/ring-span-lite)
4042
- Justas Masiulis' [circular_buffer](https://github.com/JustasMasiulis/circular_buffer)
4143

42-
Specific version (or branch) specs for the dependencies are in `test/CMakeLists.txt`.
44+
Specific version (or branch) specs for the dependencies are in the [test/CMakeLists.txt](test/CMakeLists.txt) file, look for the `CPMAddPackage` command.
4345

4446
## Build and Run Unit Tests
4547

0 commit comments

Comments
 (0)