StickyLocking is a general purpose embedded lock manager which allows for locking any resource hierarchy. Installable Lock modes allow for custimization of the locking system that can meet the needs of almost any locking scenario.
It offers multiple levels of locking for various use cases.
Sticky Locking provides the Locker class which is a high-level locking system designed to facilitate many different
concurrency use cases including simple readers-writer locks which provide shared access for read operations and
exclusive access for write operations to more complex hierarchical locking schemes used to power database file,
database, page, and row level locking.
The Locker is highly configurable to your specific use case using three interconnected constructs.
- The
LockModedefines the symbols your application will use to specify the lock modes various resources can be locked in. - The
CompatibilityMatrixdefines whether two modes can be granted concurrently for the same resource (is it shared or exclusive). - The
GroupModeMatrixdefines the composite mode a group of granted locks take on when granted together.
Sticky has two built-in sets of these values in the following enums.
SharedExclusiveLockMode which is a simple readers-writer system used to provide shared read access and exclusive
write access.
An example use case for this mode may be to protect access to a file or many files which require all readers to be able to share access to the file and writers to be granted exclusive access forcing readers and writers to wait until the write operation is complete before they proceed.
ExtendedLockMode an extended mode that includes intention and update modes which can be used for advanced database
type use cases. This LockMode set was designed to be used by other models in the Sticky Tools suite of libraries.
You are free to define your own LockMode set depending on your use case, from simpler mode structures to more complex, Sticky Locking will adapt to the mode given.
Sticky Locking provides a low-level mutual exclusion lock through the Mutex class to protect critical sections of
your code. In addition, wait conditions (Condition) are provided to allow for threads to wait for a mutex to
become available.
The mutual exclusion lock is provided through the Mutex class while wait conditions can be created with the
Condition class. Internally, the higher level components are implemented using these two primitives, and other
modules in the Sticky Tools suite of libraries also use the mutex for protecting various critical sections of code.
You can find the latest sources and binaries on github.
- If you found a bug, and can provide steps to reliably reproduce it, open an issue.
- If you have a feature request, open an issue.
- If you want to contribute
- Fork it! StickyLocking repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :-)
StickyLocking supports dependency management via Swift Package Manager on All Apple OS variants as well as Linux.
Please see Swift Package Manager for further information.
Build Environment
| Platform | Swift | Swift Build | Xcode |
|---|---|---|---|
| Linux | 4.0 | ✔ | ✘ |
| OSX | 4.0 | ✔ | Xcode 9.0 |
Minimum Runtime Version
| iOS | OS X | tvOS | watchOS | Linux |
|---|---|---|---|---|
| 8.0 | 10.10 | 9.0 | 2.0 | Ubuntu 14.04, 16.04, 16.10 |
Note:
To build and run on Linux we have a a preconfigure Vagrant file located at https://github.com/tonystone/vagrant-swift
See the README for instructions.
Tony Stone (https://github.com/tonystone)
StickyLocking is released under the Apache License, Version 2.0