aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGES11
-rw-r--r--docs/index.html8
2 files changed, 10 insertions, 9 deletions
diff --git a/CHANGES b/CHANGES
index fe5b72e..64794b1 100644
--- a/CHANGES
+++ b/CHANGES
@@ -4,18 +4,19 @@ CHANGE 2: BGe 11-Jun-24
4 * Lanes API changes 4 * Lanes API changes
5 - Version is now 4.0.0 5 - Version is now 4.0.0
6 - Lanes configuration settings: 6 - Lanes configuration settings:
7 - demote_full_userdata removed. 7 - demote_full_userdata removed. Use __lanesconvert instead.
8 - keepers_gc_threshold added. Control when GC runs inside keepers. 8 - keepers_gc_threshold added. Controls when GC runs inside keepers.
9 - nb_keepers changed to nb_user_keepers. limited to 100 keepers on top of the internal keeper used by the timer Linda. 9 - nb_keepers changed to nb_user_keepers. limited to 100 keepers on top of the internal keeper used by the timer Linda.
10 - shutdown_mode added. Controls how free running lanes are signalled at Lanes shutdown. 10 - shutdown_mode added. Controls how free running lanes are signalled at Lanes shutdown.
11 - strip_functions added. Only useful for Lua 5.3+. 11 - strip_functions added. Only useful for Lua 5.3+.
12 - verbose_errors removed. 12 - verbose_errors removed. Use lane error_trace_level instead.
13 - with_timers is false by default. 13 - with_timers is false by default.
14 - Full userdata conversion: 14 - Full userdata conversion:
15 - __lanesignore removed. 15 - __lanesignore removed. Use __lanesconvert instead.
16 - __lanesconvert added. Also replaces the global Lanes setting demote_full_userdata. 16 - __lanesconvert added.
17 - Lanes API and behavior: 17 - Lanes API and behavior:
18 - new function lanes.finally(). Installs a function that gets called at Lanes shutdown. 18 - new function lanes.finally(). Installs a function that gets called at Lanes shutdown.
19 - lanes have a __close metamethod that calls join().
19 - lanes can no longer be "killed" by hard-stopping their thread without any resource cleanup (see lane:cancel()). 20 - lanes can no longer be "killed" by hard-stopping their thread without any resource cleanup (see lane:cancel()).
20 - lane:join(), linda:receive(), linda:send() return nil, error in case of problem. 21 - lane:join(), linda:receive(), linda:send() return nil, error in case of problem.
21 - lane function body must return a non-nil first value on success if lane is waited upon with lane:join(). 22 - lane function body must return a non-nil first value on success if lane is waited upon with lane:join().
diff --git a/docs/index.html b/docs/index.html
index 3136fb3..10bf832 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -776,7 +776,8 @@
776 Change <tt>HAVE_DECODA_SUPPORT()</tt> in <tt>lanesconf.h</tt> to enable the Decoda support, that sets a special global variable <tt>decoda_name</tt> in the lane's state.<br /> 776 Change <tt>HAVE_DECODA_SUPPORT()</tt> in <tt>lanesconf.h</tt> to enable the Decoda support, that sets a special global variable <tt>decoda_name</tt> in the lane's state.<br />
777 The name is stored inside the Lua state registry so that it is available for error reporting. Changing <tt>decoda_name</tt> doesn't affect this hidden name or the OS thread name reported by MSVC.<br /> 777 The name is stored inside the Lua state registry so that it is available for error reporting. Changing <tt>decoda_name</tt> doesn't affect this hidden name or the OS thread name reported by MSVC.<br />
778 When Lanes is initialized by the first <a href="#initialization"><tt>lanes.configure()</tt></a> call, <tt>"main"</tt> is stored in the registry in the same fashion (but <tt>decoda_name</tt> and the OS thread name are left unchanged).<br /> 778 When Lanes is initialized by the first <a href="#initialization"><tt>lanes.configure()</tt></a> call, <tt>"main"</tt> is stored in the registry in the same fashion (but <tt>decoda_name</tt> and the OS thread name are left unchanged).<br />
779 The lane also has a method <tt>lane:get_debug_threadname()</tt> that gives access to that name from the caller side (returns <tt>"&lt;unnamed&gt;"</tt> if unset, <tt>"&lt;closed&gt;"</tt> if the internal Lua state is closed). 779 The lane also has a method <tt>lane:get_debug_threadname()</tt> that gives access to that name from the caller side (returns <tt>"&lt;unnamed&gt;"</tt> if unset, <tt>"&lt;closed&gt;"</tt> if the internal Lua state is closed).<br />
780 With Lua 5.4, Lanes have a <tt>__close</tt> metamethod, meaning they can be declared to-be-closed. <tt>__close</tt> calls <tt>lane:join(nil)</tt>.
780</p> 781</p>
781 782
782<p> 783<p>
@@ -986,12 +987,11 @@
986</p> 987</p>
987 988
988<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 989<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
989 [...]|[nil,err,stack_tbl]= lane_h:join([timeout_secs]) 990 [...]|[nil,err,stack_tbl]= lane_h:join([timeout])
990</pre></td></tr></table> 991</pre></td></tr></table>
991 992
992<p> 993<p>
993 <tt>timeout</tt> is an optional number &gt= 0 (the default if unspecified).<br /> 994 Waits until the lane finishes, or <tt>timeout</tt> seconds have passed (forever if <tt>nil</tt>).<br />
994 Waits until the lane finishes, or <tt>timeout</tt> seconds have passed.<br />
995 Unlike in reading the results in table fashion, errors are not propagated.<br /> 995 Unlike in reading the results in table fashion, errors are not propagated.<br />
996 Possible return values are: 996 Possible return values are:
997 <ul> 997 <ul>