ki

A lightweight structured concurrency library

BSD-3-Clause licensed by Mitchell Rosen

Maintained by Mitchell Rosen, Travis Staton

This version can be pinned in stack with:ki-1.0.0.2@sha256:0514c5dfdb1d3701ee1910ca7c7903ea54474ab11284728a6c7003af9b8821dc,2611

Depends on 2 packages(full list with versions):

Used by 3 packages in nightly-2023-03-28(full list with versions):

Overview

ki is a lightweight structured-concurrency library inspired by many other projects and blog posts:

A previous version of ki also included a mechanism for soft-cancellation/graceful shutdown, which took inspiration from:

However, this feature was removed (perhaps temporarily) because the design of the API was unsatisfactory.

Bugfix #20: previously, a child thread could deadlock when attempting to propagate an exception to its parent

Breaking: Remove Context type, Ki.Implicit module, and the ability to soft-cancel a Scope.
Breaking: Remove Duration type and its associated API, including waitFor and awaitFor.
Breaking: Remove Ki.Internal module.
Breaking: Generalize async to forkTry.
Breaking: Generalize forkWithUnmask to forkWith.
Breaking: Make fork_ take an IO Void rather than an IO ().
Breaking: Make fork create an unmasked thread, rather than inherit the parent’s masking state.
Breaking: Rename waitSTM to awaitAll (replacing the old wait in IO).
Change: Make scoped kill threads in the order they were created.
Bugfix: Fix small memory leak related to closing a scope.
Bugfix: Fix subtle bug related to GHC’s treatment of deadlocked threads.
Bugfix: make async (now forkTry) propagate async exceptions.
Bugfix: make scoped safe to run with asynchronous exceptions masked.
Bugfix: propagate exceptions to creator of scope, not creator of thread
Performance: Use atomic fetch-and-add rather than a TVar to track internal child thread ids.

Misc: Replace AtomicCounter with Int to drop the atomic-primops dependency.
Bounds: Lower cabal-version from 3.0 to 2.2 because stack cannot parse 3.0.