logos-storage/apatheia
1
0
Fork 0
mirror of https://github.com/logos-storage/apatheia.git synced 2026-01-02 13:03:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Jaremy Creechley 2024-02-16 15:15:39 -07:00
parent e7191ad930
commit 30bead2ba2
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/apatheia/jobs.nim
View File

@ -17,19 +17,18 @@ logScope:
## This module provides a simple way to submit jobs to taskpools ## This module provides a simple way to submit jobs to taskpools
## and getting a result returned via an async future. ## and getting a result returned via an async future.
## ##
## Any compatible arguments of `seq[T]` or `string` args passed ## Any compatible arguments of `seq[T]` or `string` args passed
## via the `submit` macro will be converted into the special `OpenArrayHolder[T]` type. ## via the `submit` macro will be converted into the special `OpenArrayHolder[T]` type.
## The `submit` macro converts these arguments in this object and retains the ## The `submit` macro converts these arguments in this object and retains the
## memory associated with the original `seq[T]` or `string` object. ## memory associated with the original `seq[T]` or `string` object.
## This greatly simplifies the passing of these these types in `refc`. ## This greatly simplifies the passing of these these types in `refc`.
## ##
## Note, for `arc` or `orc` GC's this setup will be replaced with a move operation in the future. ## Note, for `arc` or `orc` GC's this setup will be replaced with a move operation in the future.
## These GC's also allow greater support for moving GC types across thread boundaries. ## These GC's also allow greater support for moving GC types across thread boundaries.
## ##
## Currently this module limits support for GC types to ensure `refc` safety. ## Currently this module limits support for GC types to ensure `refc` safety.
## ##
type type
JobQueue*[T] = ref object ## job queue object JobQueue*[T] = ref object ## job queue object