awkward-squad/ki
1
1
Fork 0
mirror of https://github.com/awkward-squad/ki.git synced 2024-10-03 22:57:51 +03:00
Code Issues Projects Releases Wiki Activity

move files around

Browse Source
This commit is contained in:
Mitchell Rosen 2021-12-07 20:48:43 -05:00
parent 308751e5a4
commit 385e1182c5
6 changed files with 81 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CHANGELOG.md
View File

@ -1,34 +0,0 @@
## [0.3.0] - Unreleased
- 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 `wait` (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.
- Performance: Use atomic fetch-and-add rather than a `TVar` to track internal child thread ids.
## [0.2.0] - 2020-12-17
- Breaking: Remove `ThreadFailed` exception wrapper.
- Breaking: Rename `cancelScope` to `cancel`.
## [0.1.0.1] - 2020-11-30
- 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.
## [0.1.0] - 2020-11-11
- Initial release.

1
CHANGELOG.md Symbolic link
View File

@ -0,0 +1 @@
ki/CHANGELOG.md

11
LICENSE
View File

@ -1,11 +0,0 @@
Copyright 2020 Mitchell Rosen
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

1
LICENSE Symbolic link
View File

@ -0,0 +1 @@
ki/LICENSE

33
README.md
View File

@ -1,33 +0,0 @@
# ki
[![GitHub CI](https://github.com/awkward-squad/ki/workflows/CI/badge.svg)](https://github.com/awkward-squad/ki/actions)
[![Hackage](https://img.shields.io/hackage/v/ki.svg?label=ki&logo=haskell)](https://hackage.haskell.org/package/ki)
[![Stackage LTS](https://stackage.org/package/ki/badge/lts)](https://www.stackage.org/lts/package/ki)
[![Stackage Nightly](https://stackage.org/package/ki/badge/nightly)](https://www.stackage.org/nightly/package/ki)
[![Dependencies](https://img.shields.io/hackage-deps/v/ki)](https://packdeps.haskellers.com/reverse/ki)
`ki` is a lightweight structured-concurrency library inspired by many other projects:
* [`libdill`](http://libdill.org/)
* [`trio`](https://github.com/python-trio/trio)
* [Kotlin coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/
* https://250bpm.com/blog:124
* https://250bpm.com/blog:137
* https://250bpm.com/blog:139/
* https://libdill.org/structured-concurrency.html
A previous version of `ki` also included a mechanism for soft-cancellation/graceful shutdown, which took inspiration
from:
* [Go Concurrency Patterns: Context](https://blog.golang.org/context)
* [.NET 4 Cancellation Framework](https://devblogs.microsoft.com/pfxteam/net-4-cancellation-framework/)
* https://vorpus.org/blog/timeouts-and-cancellation-for-humans/
* https://250bpm.com/blog:146
However, this feature was removed (perhaps temporarily) because the design of the API was unsatisfactory.
# Documentation
[Hackage documentation](https://hackage.haskell.org/package/ki/docs/Ki.html)

1
README.md Symbolic link
View File

@ -0,0 +1 @@
ki/README.md

34
ki/CHANGELOG.md Normal file
View File

@ -0,0 +1,34 @@
## [0.3.0] - Unreleased
- 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 `wait` (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.
- Performance: Use atomic fetch-and-add rather than a `TVar` to track internal child thread ids.
## [0.2.0] - 2020-12-17
- Breaking: Remove `ThreadFailed` exception wrapper.
- Breaking: Rename `cancelScope` to `cancel`.
## [0.1.0.1] - 2020-11-30
- 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.
## [0.1.0] - 2020-11-11
- Initial release.

11
ki/LICENSE Normal file
View File

@ -0,0 +1,11 @@
Copyright 2020 Mitchell Rosen
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

33
ki/README.md Normal file
View File

@ -0,0 +1,33 @@
# ki
[![GitHub CI](https://github.com/awkward-squad/ki/workflows/CI/badge.svg)](https://github.com/awkward-squad/ki/actions)
[![Hackage](https://img.shields.io/hackage/v/ki.svg?label=ki&logo=haskell)](https://hackage.haskell.org/package/ki)
[![Stackage LTS](https://stackage.org/package/ki/badge/lts)](https://www.stackage.org/lts/package/ki)
[![Stackage Nightly](https://stackage.org/package/ki/badge/nightly)](https://www.stackage.org/nightly/package/ki)
[![Dependencies](https://img.shields.io/hackage-deps/v/ki)](https://packdeps.haskellers.com/reverse/ki)
`ki` is a lightweight structured-concurrency library inspired by many other projects:
* [`libdill`](http://libdill.org/)
* [`trio`](https://github.com/python-trio/trio)
* [Kotlin coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html)
* https://vorpus.org/blog/notes-on-structured-concurrency-or-go-statement-considered-harmful/
* https://250bpm.com/blog:124
* https://250bpm.com/blog:137
* https://250bpm.com/blog:139/
* https://libdill.org/structured-concurrency.html
A previous version of `ki` also included a mechanism for soft-cancellation/graceful shutdown, which took inspiration
from:
* [Go Concurrency Patterns: Context](https://blog.golang.org/context)
* [.NET 4 Cancellation Framework](https://devblogs.microsoft.com/pfxteam/net-4-cancellation-framework/)
* https://vorpus.org/blog/timeouts-and-cancellation-for-humans/
* https://250bpm.com/blog:146
However, this feature was removed (perhaps temporarily) because the design of the API was unsatisfactory.
# Documentation
[Hackage documentation](https://hackage.haskell.org/package/ki/docs/Ki.html)