diff options
author | Benoit Germain <benoit.germain@ubisoft.com> | 2024-07-04 09:47:12 +0200 |
---|---|---|
committer | Benoit Germain <benoit.germain@ubisoft.com> | 2024-07-04 09:47:12 +0200 |
commit | dc55ffcf9cf3592b822bbdb90b63c72ed61ec668 (patch) | |
tree | e3d3aa7dc8abc028146a13961821a26fd224dbcc /CHANGES | |
parent | f3b7facea8de585dda1d4f5bd1d9716b40b1ce94 (diff) | |
download | lanes-dc55ffcf9cf3592b822bbdb90b63c72ed61ec668.tar.gz lanes-dc55ffcf9cf3592b822bbdb90b63c72ed61ec668.tar.bz2 lanes-dc55ffcf9cf3592b822bbdb90b63c72ed61ec668.zip |
Documentation for coroutine lanes
Diffstat (limited to 'CHANGES')
-rw-r--r-- | CHANGES | 2 |
1 files changed, 2 insertions, 0 deletions
@@ -16,11 +16,13 @@ CHANGE 2: BGe 11-Jun-24 | |||
16 | - __lanesignore removed. Use __lanesconvert instead. | 16 | - __lanesignore removed. Use __lanesconvert instead. |
17 | - __lanesconvert added. | 17 | - __lanesconvert added. |
18 | - Lanes API and behavior: | 18 | - Lanes API and behavior: |
19 | - new generator lanes.coro() to start a lane as a coroutine. | ||
19 | - new function lanes.finally(). Installs a function that gets called at Lanes shutdown after attempting to terminate all lanes. | 20 | - new function lanes.finally(). Installs a function that gets called at Lanes shutdown after attempting to terminate all lanes. |
20 | - If some lanes still run at shutdown, Lanes with throw an exception (or freeze, this is to be decided). | 21 | - If some lanes still run at shutdown, Lanes with throw an exception (or freeze, this is to be decided). |
21 | - lanes have a __close metamethod that calls join(). | 22 | - lanes have a __close metamethod that calls join(). |
22 | - lanes can no longer be "killed" by hard-stopping their thread without any resource cleanup (see lane:cancel()). | 23 | - lanes can no longer be "killed" by hard-stopping their thread without any resource cleanup (see lane:cancel()). |
23 | - lane:join() returns nil, error in case of problem. | 24 | - lane:join() returns nil, error in case of problem. |
25 | - lane:get_debug_threadname() renamed get_threadname(). | ||
24 | - lane function body must return a non-nil first value on success if lane is waited upon with lane:join(). | 26 | - lane function body must return a non-nil first value on success if lane is waited upon with lane:join(). |
25 | - lanes.sleep() accept a new argument "indefinitely" to block forever (until hard cancellation is received). | 27 | - lanes.sleep() accept a new argument "indefinitely" to block forever (until hard cancellation is received). |
26 | - lanes.gen() is stricter wrt base libraries (can raise an error if it doesn't exist in the Lua flavor it's built against). | 28 | - lanes.gen() is stricter wrt base libraries (can raise an error if it doesn't exist in the Lua flavor it's built against). |