Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.73 KB

README.md

File metadata and controls

49 lines (30 loc) · 1.73 KB

libGuarded

Introduction

The libGuarded library is a standalone header-only library for multithreaded programming.

This library provides templated classes which prevent race conditions by controlling access to shared data. Existing multithreading primitives like mutexes and locks are only bound to the protected data by conventions. This makes it very easy to introduce bugs in your code by forgetting to use the right locks before accessing a block of data. The idea of this library is to tie the data and the locks in a type safe interface that only allows correct usage.

System Requirements

To use libGuarded you will need a C++11 compiler and a C++11 standard library. Some of the advanced features of libGuarded leverage the C++14 standard or equivalent functionality in Boost.

Currently uses the Autotools build system for building and running the unit test suite. The library has been tested with clang sanitizer and a major code review.

Documentation

Class level documentation for many libGuarded classes is available on the CopperSpice website:

www.copperspice.com/docs/libguarded/index.html

Presentations

For additional information on multithreading refer to Ansel Sermersheim presentations:

www.copperspice.com/presentations.html

Authors

  • Ansel Sermersheim - Initial work

  • Barbara Geller - Testing, Documentation

  • Philip Top - Addition of handles, atomic_guarded, guarded_opt, shared_guarded_opt, staged_guarded types and modification in this library to work with google test

License

This library is released under the BSD 2-clause license. For more information refer to the LICENSE file provided with this project.

References