diff options
| author | Benoit Germain <benoit.germain@ubisoft.com> | 2025-06-05 16:03:22 +0200 |
|---|---|---|
| committer | Benoit Germain <benoit.germain@ubisoft.com> | 2025-06-05 16:03:22 +0200 |
| commit | bfdc7a92c4e3e99522abb6d90ef2cbb021f36fc8 (patch) | |
| tree | 00f6633878b21dda6cad1177d5619a501b4ac0a4 /docs/index.html | |
| parent | f73702bcf4372a149b8b01a512c0e086b1e679e2 (diff) | |
| download | lanes-bfdc7a92c4e3e99522abb6d90ef2cbb021f36fc8.tar.gz lanes-bfdc7a92c4e3e99522abb6d90ef2cbb021f36fc8.tar.bz2 lanes-bfdc7a92c4e3e99522abb6d90ef2cbb021f36fc8.zip | |
Change lane:join() return values
* when no error is raised in the lane, lane:join() now precedes the lane returned values with true
* lane body is no longer forced to return something when used with join()
* adjusted all relevant unit tests accordingly
Diffstat (limited to 'docs/index.html')
| -rw-r--r-- | docs/index.html | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/index.html b/docs/index.html index be8ad7f..ab8aed2 100644 --- a/docs/index.html +++ b/docs/index.html | |||
| @@ -71,7 +71,7 @@ | |||
| 71 | </p> | 71 | </p> |
| 72 | 72 | ||
| 73 | <p> | 73 | <p> |
| 74 | This document was revised on 07-May-25, and applies to version <tt>4.0.0</tt>. | 74 | This document was revised on 05-Jun-25, and applies to version <tt>4.0.0</tt>. |
| 75 | </p> | 75 | </p> |
| 76 | </font> | 76 | </font> |
| 77 | </center> | 77 | </center> |
| @@ -1156,7 +1156,7 @@ | |||
| 1156 | </p> | 1156 | </p> |
| 1157 | 1157 | ||
| 1158 | <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> | 1158 | <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> |
| 1159 | [...]|[nil,err,stack_tbl]= lane_h:join([timeout]) | 1159 | [true, ...]|[nil,err,stack_tbl]= lane_h:join([timeout]) |
| 1160 | </pre></td></tr></table> | 1160 | </pre></td></tr></table> |
| 1161 | 1161 | ||
| 1162 | <p> | 1162 | <p> |
| @@ -1174,7 +1174,7 @@ | |||
| 1174 | </ul> | 1174 | </ul> |
| 1175 | </li> | 1175 | </li> |
| 1176 | <li><tt>nil, "killed"</tt> if forcefully killed.</li> | 1176 | <li><tt>nil, "killed"</tt> if forcefully killed.</li> |
| 1177 | <li>The return values of the lane function. If the first return value is <tt>nil</tt> (or there is no return value), an error is raised, to make sure you can tell timeout and error cases apart from successful return.</li> | 1177 | <li><tt>true [, returned-values]</tt>: The return values of the lane function.</li> |
| 1178 | </ul> | 1178 | </ul> |
| 1179 | If the lane handle obtained from <tt>lanes.gen()</tt> is to-be-closed, closing the value will cause a call to <tt>join()</tt>. Since it is implicit, the lane body isn't forced to return non-<tt>nil</tt> in that case. | 1179 | If the lane handle obtained from <tt>lanes.gen()</tt> is to-be-closed, closing the value will cause a call to <tt>join()</tt>. Since it is implicit, the lane body isn't forced to return non-<tt>nil</tt> in that case. |
| 1180 | </p> | 1180 | </p> |
