https://github.com/johannes/jsring
A toy ring buffer in C++14
https://github.com/johannes/jsring
cpp14 ring-buffer toy-project
Last synced: about 2 months ago
JSON representation
A toy ring buffer in C++14
- Host: GitHub
- URL: https://github.com/johannes/jsring
- Owner: johannes
- License: mit
- Created: 2018-03-31T23:40:57.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-05-05T01:36:01.000Z (almost 8 years ago)
- Last Synced: 2025-01-20T06:46:53.362Z (about 1 year ago)
- Topics: cpp14, ring-buffer, toy-project
- Language: C++
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
jsring - A toy ring buffer
==========================
[](https://travis-ci.org/johannes/jsring)
This is a simple implementation of a ring buffer with a compile-time defined size. This is an saturday afternoon hack and not supposed to be used in production and maybe wll never be touched again. There certainly are more robust/efficient/... implementations.
Usage
-----
```c++
#include
#include
jsring::ring ring{1, 2, 3, 4, 5, 6, 7, 8, 9, 10};
ring.push_back(11);
ring.push_back(12);
ring.push_front(0);
for (auto i : ring) {
std::cout << i << " ";
}
std::cout << '\n';
```
This will print
0 3 4 5 6 7 8 9 10 11
See the [tests](test/main.cpp) for more examples.
Installation
------------
All code is included in `include/jsring.h`. Also a `CMakeLists.txt` is provided which allows installation using CMake. After installing other projects can add a dependency via
Assuming you have cmake and a C++14 compiler you could install it like this:
```sh
git clone git@github.com:johannes/jsring.git
cd jsring
cmake .
make install
```
In a different project you can include it from your `CMakeLists.txt` like this:
```cmake
find_package(jsring CONFIG REQUIRED)
target_link_libraries(YourApp jsring)
```
Tests are using GTest. CMake will load this dependency when needed. For testing you can use either `ctest` or run the more vebose test binary `testjsring` after running `make`.
License
-------
This library is licensed under the terms of the MIT License.
> Copyright 2018 Johannes Schlüter
>
> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
>
> The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
>
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.