aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-10-25 16:45:28 +0200
committerBenoit Germain <benoit.germain@ubisoft.com>2024-10-25 16:45:28 +0200
commitc860f557a7ba72e6a39ea5db36e293de802adea5 (patch)
tree1d15a9b798b2f812c5315022d579e8f083b4385a /docs
parentf2d578555bf51da7a0acd1d1d7e724860b89a149 (diff)
downloadlanes-c860f557a7ba72e6a39ea5db36e293de802adea5.tar.gz
lanes-c860f557a7ba72e6a39ea5db36e293de802adea5.tar.bz2
lanes-c860f557a7ba72e6a39ea5db36e293de802adea5.zip
New linda:wake() and linda.status
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html14
1 files changed, 12 insertions, 2 deletions
diff --git a/docs/index.html b/docs/index.html
index a8eadbf..b95bc0e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -70,7 +70,7 @@
70 </p> 70 </p>
71 71
72 <p> 72 <p>
73 This document was revised on 24-Sep-24, and applies to version <tt>4.0.0</tt>. 73 This document was revised on 25-Oct-24, and applies to version <tt>4.0.0</tt>.
74 </p> 74 </p>
75 </font> 75 </font>
76 </center> 76 </center>
@@ -1405,16 +1405,26 @@
1405 1405
1406<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 1406<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
1407 void = linda_h:cancel("read"|"write"|"both"|"none") 1407 void = linda_h:cancel("read"|"write"|"both"|"none")
1408 "cancelled"|"active" = linda_h.status
1408</pre></td></tr></table> 1409</pre></td></tr></table>
1409 1410
1410<p> 1411<p>
1411 Signals the linda so that lanes waiting for read, write, or both, wake up. 1412 <tt>linda:cancel()</tt> signals the linda so that lanes waiting for read, write, or both, wake up.
1412 All linda operations (including <tt>get()</tt> and <tt>set()</tt>) will return <tt>lanes.cancel_error</tt> as when the calling lane is <a href="#cancelling">soft-cancelled</a> as long as the linda is marked as cancelled.<br /> 1413 All linda operations (including <tt>get()</tt> and <tt>set()</tt>) will return <tt>lanes.cancel_error</tt> as when the calling lane is <a href="#cancelling">soft-cancelled</a> as long as the linda is marked as cancelled.<br />
1413 <tt>"none"</tt> reset the linda's cancel status, but doesn't signal it.<br /> 1414 <tt>"none"</tt> reset the linda's cancel status, but doesn't signal it.<br />
1415 <tt>linda.status</tt> reads the current cancel status.
1414 If not void, the lane's cancel status overrides the linda's cancel status. 1416 If not void, the lane's cancel status overrides the linda's cancel status.
1415</p> 1417</p>
1416 1418
1417<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> 1419<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
1420 void = linda_h:wake("read"|"write"|"both")
1421</pre></td></tr></table>
1422
1423<p>
1424 Signals the linda so that lanes waiting for read, write, or both, wake up. Does not change the current Linda's cancel status. Can be used to break early out of a blocking wait.
1425</p>
1426
1427<table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre>
1418 light userdata = h:deep() 1428 light userdata = h:deep()
1419</pre></td></tr></table> 1429</pre></td></tr></table>
1420 1430