diff options
author | Benoit Germain <benoit.germain@ubisoft.com> | 2024-06-10 10:59:08 +0200 |
---|---|---|
committer | Benoit Germain <benoit.germain@ubisoft.com> | 2024-06-10 10:59:08 +0200 |
commit | e7fa2439c8f328ab146037628bce30894e36a32c (patch) | |
tree | 12676776098fc8a737d4917251391d0c37cef906 /docs | |
parent | 40d6d3f59de802c6e2187540eb654248a5affc30 (diff) | |
download | lanes-e7fa2439c8f328ab146037628bce30894e36a32c.tar.gz lanes-e7fa2439c8f328ab146037628bce30894e36a32c.tar.bz2 lanes-e7fa2439c8f328ab146037628bce30894e36a32c.zip |
Unify the value returned by linda:deep() and the string conversion of an unnamed Linda
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.html | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/docs/index.html b/docs/index.html index dd7854a..60f4970 100644 --- a/docs/index.html +++ b/docs/index.html | |||
@@ -1213,18 +1213,18 @@ | |||
1213 | <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> | 1213 | <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> |
1214 | h = lanes.linda([opt_name, [opt_group]]) | 1214 | h = lanes.linda([opt_name, [opt_group]]) |
1215 | 1215 | ||
1216 | [true|lanes.cancel_error] = h:send([timeout_secs,] key, ...) | 1216 | true|lanes.cancel_error = h:send([timeout_secs,] key, ...) |
1217 | 1217 | ||
1218 | key, val = h:receive([timeout_secs,] key [, key...]) | 1218 | key, val = h:receive([timeout_secs,] key [, key...]) |
1219 | 1219 | ||
1220 | key, val [, val...] = h:receive(timeout, h.batched, key, n_uint_min[, n_uint_max]) | 1220 | key, val [, val...] = h:receive(timeout, h.batched, key, n_uint_min[, n_uint_max]) |
1221 | 1221 | ||
1222 | [true|lanes.cancel_error] = h:limit(key, n_uint) | 1222 | true|lanes.cancel_error = h:limit(key, n_uint) |
1223 | </pre></td></tr></table> | 1223 | </pre></td></tr></table> |
1224 | 1224 | ||
1225 | <p> | 1225 | <p> |
1226 | Converting the Linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.<br/> | 1226 | Converting the Linda to a string will yield the provided name prefixed by <tt>"Linda: "</tt>.<br/> |
1227 | If <tt>opt_name</tt> is omitted, it will evaluate to an hexadecimal number uniquely representing that Linda.<br/> | 1227 | If <tt>opt_name</tt> is omitted, it will evaluate to an hexadecimal number uniquely representing that Linda when the Linda is converted to a string. The value is the same as returned by <tt>linda:deep()</tt>.<br/> |
1228 | If <tt>opt_name</tt> is <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the Linda name will be <tt>"<unresolved>"</tt>. | 1228 | If <tt>opt_name</tt> is <tt>"auto"</tt>, Lanes will try to construct a name from the source location that called <tt>lanes.linda()</tt>. If that fails, the Linda name will be <tt>"<unresolved>"</tt>. |
1229 | </p> | 1229 | </p> |
1230 | <p> | 1230 | <p> |
@@ -1331,6 +1331,14 @@ | |||
1331 | If not void, the lane's cancel status overrides the Linda's cancel status. | 1331 | If not void, the lane's cancel status overrides the Linda's cancel status. |
1332 | </p> | 1332 | </p> |
1333 | 1333 | ||
1334 | <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"><tr><td><pre> | ||
1335 | light userdata = h:deep() | ||
1336 | </pre></td></tr></table> | ||
1337 | |||
1338 | <p> | ||
1339 | Returns a light userdata that uniquely represents the Linda. The stored value is the same as what is seen when converting an unnamed Linda to a string. | ||
1340 | </p> | ||
1341 | |||
1334 | <h3 id="keepers">Granularity of using Lindas</h3> | 1342 | <h3 id="keepers">Granularity of using Lindas</h3> |
1335 | 1343 | ||
1336 | <p> | 1344 | <p> |