Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/regexident/sync
Useful synchronization primitives in Swift
https://github.com/regexident/sync
multithreading mutex read-write-lock rwlock synchronization
Last synced: 8 days ago
JSON representation
Useful synchronization primitives in Swift
- Host: GitHub
- URL: https://github.com/regexident/sync
- Owner: regexident
- License: mpl-2.0
- Created: 2020-10-13T14:13:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-17T16:35:40.000Z (almost 2 years ago)
- Last Synced: 2024-12-28T04:13:30.342Z (21 days ago)
- Topics: multithreading, mutex, read-write-lock, rwlock, synchronization
- Language: Swift
- Homepage:
- Size: 62.5 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sync
Useful synchronization primitives in Swift.
## `Mutex`
A fair mutual exclusion primitive useful for protecting shared data
> This mutex will block threads waiting for the lock to become available.
> The mutex can also be statically initialized or created via a new
> constructor. Each mutex has a type parameter which represents the data
> that it is protecting. The data can only be accessed through the `access`
> handle passed to the callback of `lock` and `tryLock`, which guarantees
> that the data is only ever accessed when the mutex is locked.
>
> Note: The implementation is based on `pthread_mutex_t` (64 bytes).
### Minimal Example
```swift
let mutex = try Mutex(0)
try! mutex.read { value in
print(value)
}
try! mutex.write { access in
access { value in
value += 42
}
}
```
Real-world Example
### Real-world Example
```swift
let mutex = try Mutex(0)
let count: Int = 1000
let queue = DispatchQueue(
label: #function,
attributes: .concurrent
)
let group = DispatchGroup()
for _ in 0..
## `UnfairMutex`
An unfair mutual exclusion primitive useful for protecting shared data
> This mutex will block threads waiting for the lock to become available.
> The mutex can also be statically initialized or created via a new
> constructor. Each mutex has a type parameter which represents the data
> that it is protecting. The data can only be accessed through the `access`
> handle passed to the callback of `lock` and `tryLock`, which guarantees
> that the data is only ever accessed when the mutex is locked.
>
> Note: The implementation is based on `os_unfair_lock_s` (4 bytes).
### Minimal Example
```swift
let mutex = try Mutex(0)
try! mutex.read { value in
print(value)
}
try! mutex.write { access in
access { value in
value += 42
}
}
```
Real-world Example
### Real-world Example
```swift
let unfairMutex = try UnfairMutex(0)
let count: Int = 1000
let queue = DispatchQueue(
label: #function,
attributes: .concurrent
)
let group = DispatchGroup()
for _ in 0..
## `RWLock`
A reader-writer lock
> This type of lock allows a number of readers or at most one writer
> at any point in time. The write portion of this lock typically allows
> modification of the underlying data (exclusive access) and the read
> portion of this lock typically allows for read-only access (shared access).
>
> In comparison, a `Mutex` does not distinguish between readers or writers
> that acquire the lock, therefore blocking any threads waiting for the
> lock to become available. An `RWLock` will allow any number of readers
> to acquire the lock as long as a writer is not holding the lock.
>
> Note: The implementation is based on `pthread_rwlock_t` (200 bytes).
>
> **Important**: `RWLock` does not support priority inversion avoidance.
### Minimal Example
```swift
let rwlock = try RWLock(0)
try! rwlock.read { value in
print(value)
}
try! rwlock.write { access in
access { value in
value += 42
}
}
```
Real-world Example
### Real-world Example
```swift
let rwlock = try RWLock(0)
let count: Int = 1000
let queue = DispatchQueue(
label: #function,
attributes: .concurrent
)
let group = DispatchGroup()
for _ in 0..
## License
This project is licensed under the [**MPL-2.0**](https://www.tldrlegal.com/l/mpl-2.0) – see the [LICENSE.md](LICENSE.md) file for details.