https://github.com/octogonapus/countdownlatches.jl

A simple multithreading primitive.
https://github.com/octogonapus/countdownlatches.jl

Last synced: 20 days ago
JSON representation

A simple multithreading primitive.

• Host: GitHub
• URL: https://github.com/octogonapus/countdownlatches.jl
• Owner: Octogonapus
• License: mit
• Created: 2021-03-17T02:45:57.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-25T19:49:52.000Z (over 2 years ago)
• Last Synced: 2024-12-19T08:55:31.212Z (20 days ago)
• Language: Julia
• Homepage: https://octogonapus.github.io/CountDownLatches.jl/dev/
• Size: 151 KB
• Stars: 5
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CountDownLatches

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://Octogonapus.github.io/CountDownLatches.jl/stable)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://Octogonapus.github.io/CountDownLatches.jl/dev)

[![Build Status](https://github.com/Octogonapus/CountDownLatches.jl/workflows/CI/badge.svg)](https://github.com/Octogonapus/CountDownLatches.jl/actions)

[![Coverage](https://codecov.io/gh/Octogonapus/CountDownLatches.jl/branch/main/graph/badge.svg?token=MJVL5EVXTP)](https://codecov.io/gh/Octogonapus/CountDownLatches.jl)

[![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)

This package implements a multithreading primitive called a `CountDownLatch` that holds an internal count.

The latch's count can be decremented by multiple threads.

Threads may also wait on the latch's count to become zero.

## Example

In this example, the main thread will be blocked by `await` until the spawned thread counts the latch down.

This is clearly a contrived example, but imagine that there is much more code before `count_down` and before `await`.

```julia

latch = CountDownLatch(1)

Threads.@spawn begin

    # Decrease the latch's count by one

    count_down(latch)

end

# Wait until the latch's count become zero

await(latch)

```