ZigRazor / Labrador

C++ Queue Elaboration Framework

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Labrador

C++ Queue Elaboration Framework

License GitHub release CMake

codecov CodeFactor

Generic badge Generic badge

Table of Contents

Description

Labrador is a C++ Queue library. This project aims to fulfill a framework for concurrent queue elaboration. By using Labrador, users can:

  • Create queues of different type ( ex. Bounded, Lock-wait, Concurrent )
  • Craete more sophisticated application that use queue processor to process in a simple way the enqueued items.

Features

  • Concurrent Queue
  • Boundend Queue
  • Lock-Wait Bounded Queue
  • Queue Processor
  • Asynchronous Queue Processor

Installation

To install and set up Labrador, follow these steps:

  1. Clone the repository:
    git clone https://github.com/ZigRazor/Labrador.git
  2. Navigate to the project directory:
cd Labrador
  1. Prepare CMake:
mkdir build
cd build
cmake ..
  1. Install Library
    make install

Usage

You can use the Library in your project with CMake adding the following lines:

CPMAddPackage(
    NAME Labrador
    GITHUB_REPOSITORY ZigRazor/Labrador
    GIT_TAG origin/main
)

or install it and the add to the include path {StandardIncludePath}/DogBreeds/Labrador.

For simple use you can see the Example For more detailed usage instructions, refer to the documentation.

Contributing

We welcome contributions to Labrador! To contribute, follow these steps:

  1. Fork the repository.
  2. Create a new branch:
git checkout -b feature/your-feature-name
  1. Make your changes and commit them:
git commit -m "Add your commit message"
  1. Push to the branch:
git push origin feature/your-feature-name
  1. Create a pull request.

Please read our contributing guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

If you have any questions, suggestions, or feedback, feel free to reach out:

Acknowledgements

We would like to thank the following individuals for their support:

Contributors

Credits

Photo of Helena Lopes on Unsplash

About

C++ Queue Elaboration Framework

License:MIT License


Languages

Language:C++ 89.1%Language:CMake 10.9%