Skip to content

Merge develop to main in anticipation of Lou's DBC pull request #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cliffg-softwarelibre merged 6 commits into from
Jun 9, 2024
Merged

Merge develop to main in anticipation of Lou's DBC pull request #12

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bcd406c
Adding link, tweaking text
cliffg-softwarelibre May 28, 2024
4f28aab
Adding Boost License to main README
cliffg-softwarelibre May 31, 2024
eb3cb1d
Adding Boost License shield to main README
cliffg-softwarelibre May 31, 2024
f50555f
Adding Boost License shield to main README
cliffg-softwarelibre May 31, 2024
8b2fb6a
Adding Boost License shield to main README
cliffg-softwarelibre May 31, 2024
46cb245
Fixing typo
cliffg-softwarelibre May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@

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

![License](https://img.shields.io/badge/License-Boost%201.0-blue)

## Overview

`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.
Expand Down Expand Up @@ -39,7 +41,7 @@ The unit test uses two third-party libraries (each is a single header-only file)
- Martin Moene's [ring-span-lite](https://github.com/martinmoene/ring-span-lite)
- Justas Masiulis' [circular_buffer](https://github.com/JustasMasiulis/circular_buffer)

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

## Build and Run Unit Tests

Expand Down