aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html125
1 files changed, 64 insertions, 61 deletions
diff --git a/docs/index.html b/docs/index.html
index defb0ad..4fdc6f3 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -278,55 +278,6 @@
278 <th style="width:15%">value</th> 278 <th style="width:15%">value</th>
279 <th style="width:70%">definition</th> 279 <th style="width:70%">definition</th>
280 </tr> 280 </tr>
281 <tr valign=top>
282 <td id="nb_user_keepers">
283 <code>.nb_user_keepers</code>
284 </td>
285 <td>integer in [0,100]</td>
286 <td>
287 Controls the number of "user" <a href="#keepers">Keeper state</a> used internally by <a href="#lindas">Linda</a>) objects to transfer data between lanes. Default is <tt>0</tt>.<br />
288 Lanes always creates at least one keeper state (of group <tt>0</tt> for the internal timer <a href="#lindas">Linda</a>. If <tt>nb_user_keepers</tt> is <tt>0</tt>, the other lindas you create will share this keeper by necessity.<br />
289 If there is more than one <a href="#keepers">Keeper state</a> (in total), <a href="#lindas">Linda</a> creation must specify the group it belongs to.
290 </td>
291 </tr>
292
293 <tr valign=top>
294 <td id="keepers_gc_threshold">
295 <code>.keepers_gc_threshold</code>
296 </td>
297 <td>integer</td>
298 <td>
299 If &lt;0, GC runs automatically. This is the default.<br />
300 If 0, GC runs after *every* <a href="#keepers">Keeper</a> operation.<br />
301 If &gt;0, <a href="#keepers">Keeper states</a> run GC manually with <tt>lua_gc(LUA_GCCOLLECT)</tt> whenever memory usage reported by <tt>lua_gc(LUA_GCCOUNT)</tt> reaches this threshold. Check is made after every operation (see <a href="#lindas">below</a>). If memory usage remains above threshold after the GC cycle, an error is raised.
302 </td>
303 </tr>
304
305 <tr valign=top>
306 <td id="with_timers">
307 <code>.with_timers</code>
308 </td>
309 <td>
310 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt>
311 </td>
312 <td>
313 If equal to <tt>false</tt> or <tt>nil</tt>, Lanes doesn't start the timer service, and the associated API will be absent from the interface (see below).
314 Default is <tt>false</tt>.
315 </td>
316 </tr>
317
318 <tr valign=top>
319 <td id="verbose_errors">
320 <code>.verbose_errors</code>
321 </td>
322 <td>
323 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt>
324 </td>
325 <td>
326 If equal to <tt>true</tt>, Lanes will collect more information when transfering stuff across Lua states to help identify errors (with a cost).
327 Default is <tt>false</tt>.
328 </td>
329 </tr>
330 281
331 <tr valign=top> 282 <tr valign=top>
332 <td id="allocator"> 283 <td id="allocator">
@@ -367,15 +318,27 @@
367 </tr> 318 </tr>
368 319
369 <tr valign=top> 320 <tr valign=top>
370 <td id="track_lanes"> 321 <td id="keepers_gc_threshold">
371 <code>.track_lanes</code> 322 <code>.keepers_gc_threshold</code>
372 </td> 323 </td>
324 <td>integer</td>
373 <td> 325 <td>
374 <tt>nil</tt>/<tt>false</tt>/anything 326 If &lt;0, GC runs automatically. This is the default.<br />
327 If 0, GC runs after *every* <a href="#keepers">Keeper</a> operation.<br />
328 If &gt;0, <a href="#keepers">Keeper states</a> run GC manually with <tt>lua_gc(LUA_GCCOLLECT)</tt> whenever memory usage reported by <tt>lua_gc(LUA_GCCOUNT)</tt> reaches this threshold.
329 Check is made after every operation (see <a href="#lindas">below</a>). If memory usage remains above threshold after the GC cycle, an error is raised.
330 </td>
331 </tr>
332
333 <tr valign=top>
334 <td id="nb_user_keepers">
335 <code>.nb_user_keepers</code>
375 </td> 336 </td>
337 <td>integer in [0,100]</td>
376 <td> 338 <td>
377 Any non-<tt>nil|false</tt> value instructs Lanes keeps track of all lanes, so that <a href="#tracking"><tt>lanes.threads()</tt></a> can list them. If <tt>false</tt>, <tt>lanes.threads()</tt> will raise an error when called. 339 Controls the number of "user" <a href="#keepers">Keeper state</a> used internally by <a href="#lindas">Linda</a>) objects to transfer data between lanes. Default is <tt>0</tt>.<br />
378 Default is <tt>false</tt>. 340 Lanes always creates at least one keeper state (of group <tt>0</tt> for the internal timer <a href="#lindas">Linda</a>. If <tt>nb_user_keepers</tt> is <tt>0</tt>, the other lindas you create will share this keeper by necessity.<br />
341 If there is more than one <a href="#keepers">Keeper state</a> (in total), <a href="#lindas">Linda</a> creation must specify the group it belongs to.
379 </td> 342 </td>
380 </tr> 343 </tr>
381 344
@@ -401,6 +364,18 @@
401 </tr> 364 </tr>
402 365
403 <tr valign=top> 366 <tr valign=top>
367 <td id="shutdown_mode">
368 <code>.shutdown_mode</code>
369 </td>
370 <td>
371 <tt>"hard"</tt>/<tt>"soft"</tt>/<tt>"call"</tt>/<tt>"ret"</tt>/<tt>"line"</tt>/<tt>"count"</tt>
372 </td>
373 <td>
374 Select the cancellation mode used at Lanes shutdown to request free running lane termination. See <a href="#cancelling">lane cancellation</a>. Default is <tt>"hard"</tt>.
375 </td>
376 </tr>
377
378 <tr valign=top>
404 <td id="shutdown_timeout"> 379 <td id="shutdown_timeout">
405 <code>.shutdown_timeout</code> 380 <code>.shutdown_timeout</code>
406 </td> 381 </td>
@@ -411,26 +386,54 @@
411 Sets the duration in seconds Lanes will wait for graceful termination of running lanes at application shutdown. Default is <tt>0.25</tt>. 386 Sets the duration in seconds Lanes will wait for graceful termination of running lanes at application shutdown. Default is <tt>0.25</tt>.
412 </td> 387 </td>
413 </tr> 388 </tr>
389
414 <tr valign=top> 390 <tr valign=top>
415 <td id="shutdown_mode"> 391 <td id="strip_functions">
416 <code>.shutdown_mode</code> 392 <code>.strip_functions</code>
417 </td> 393 </td>
418 <td> 394 <td>
419 <tt>"hard"</tt>/<tt>"soft"</tt>/<tt>"call"</tt>/<tt>"ret"</tt>/<tt>"line"</tt>/<tt>"count"</tt> 395 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt>
420 </td> 396 </td>
421 <td> 397 <td>
422 Select the cancellation mode used at Lanes shutdown to request free running lane termination. See <a href="#cancelling">lane cancellation</a>. Default is <tt>"hard"</tt>. 398 Controls function bytecode stripping when dumping them for lane transfer. Choose between faster copies or more debug info. Default is <tt>true</tt>.
423 </td> 399 </td>
424 </tr> 400 </tr>
425 <tr valign=top> 401 <tr valign=top>
426 <td id="strip_functions"> 402 <td id="track_lanes">
427 <code>.strip_functions</code> 403 <code>.track_lanes</code>
404 </td>
405 <td>
406 <tt>nil</tt>/<tt>false</tt>/anything
407 </td>
408 <td>
409 Any non-<tt>nil|false</tt> value instructs Lanes keeps track of all lanes, so that <a href="#tracking"><tt>lanes.threads()</tt></a> can list them. If <tt>false</tt>, <tt>lanes.threads()</tt> will raise an error when called.
410 Default is <tt>false</tt>.
411 </td>
412 </tr>
413
414 <tr valign=top>
415 <td id="verbose_errors">
416 <code>.verbose_errors</code>
428 </td> 417 </td>
429 <td> 418 <td>
430 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt> 419 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt>
431 </td> 420 </td>
432 <td> 421 <td>
433 Controls function bytecode stripping when dumping them for lane transfer. Choose between faster copies or more debug info. Default is <tt>true</tt>. 422 If equal to <tt>true</tt>, Lanes will collect more information when transfering stuff across Lua states to help identify errors (with a cost).
423 Default is <tt>false</tt>.
424 </td>
425 </tr>
426
427 <tr valign=top>
428 <td id="with_timers">
429 <code>.with_timers</code>
430 </td>
431 <td>
432 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt>
433 </td>
434 <td>
435 If equal to <tt>false</tt> or <tt>nil</tt>, Lanes doesn't start the timer service, and the associated API will be absent from the interface (see below).
436 Default is <tt>false</tt>.
434 </td> 437 </td>
435 </tr> 438 </tr>
436 </table> 439 </table>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-15 22:05:56 +0000