aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBenoit Germain <benoit.germain@ubisoft.com>2024-06-18 09:03:43 +0200
committerBenoit Germain <benoit.germain@ubisoft.com>2024-06-18 09:03:43 +0200
commite3818609b54c81a83aa73beb322ea9c282b7add8 (patch)
treeb165d7925206ceb10a851fc8c1eed8b8566e7727 /docs
parent54b47307ce4b2e21bc12c1602c77fecf55380452 (diff)
downloadlanes-e3818609b54c81a83aa73beb322ea9c282b7add8.tar.gz
lanes-e3818609b54c81a83aa73beb322ea9c282b7add8.tar.bz2
lanes-e3818609b54c81a83aa73beb322ea9c282b7add8.zip
When it is a function, config.allocator is called with a string hint
Diffstat (limited to 'docs')
-rw-r--r--docs/index.html16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/index.html b/docs/index.html
index c9058fd..fe92565 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -289,7 +289,7 @@
289 <td> 289 <td>
290 If <tt>nil</tt>, Lua states are created with <tt>lua_newstate()</tt> and reuse the allocator from the master state.<br /> 290 If <tt>nil</tt>, Lua states are created with <tt>lua_newstate()</tt> and reuse the allocator from the master state.<br />
291 If <tt>"protected"</tt>, The default allocator obtained from <tt>lua_getallocf()</tt> in the master state is wrapped inside a critical section and used in all newly created states.<br /> 291 If <tt>"protected"</tt>, The default allocator obtained from <tt>lua_getallocf()</tt> in the master state is wrapped inside a critical section and used in all newly created states.<br />
292 If a <tt>function</tt>, this function is called prior to creating the state. It should return a full userdata containing the following structure: 292 If a <tt>function</tt>, this function is called prior to creating the state, with a single string argument, either <tt>"keeper"</tt> or <tt>"lane"</tt>. It should return a full userdata containing the following structure:
293 <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%"> 293 <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%">
294 <tr> 294 <tr>
295 <td> 295 <td>
@@ -347,7 +347,7 @@
347 <code>.on_state_create</code> 347 <code>.on_state_create</code>
348 </td> 348 </td>
349 <td> 349 <td>
350 function/<tt>nil</tt> 350 <tt>nil</tt>/function
351 </td> 351 </td>
352 <td> 352 <td>
353 If provided, will be called in every created Lua state right after initializing the base libraries, with a single string argument, either <tt>"lane"</tt> or <tt>"keeper"</tt>.<br /> 353 If provided, will be called in every created Lua state right after initializing the base libraries, with a single string argument, either <tt>"lane"</tt> or <tt>"keeper"</tt>.<br />
@@ -392,7 +392,7 @@
392 <code>.strip_functions</code> 392 <code>.strip_functions</code>
393 </td> 393 </td>
394 <td> 394 <td>
395 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt> 395 <tt>nil</tt>/<tt>boolean</tt>
396 </td> 396 </td>
397 <td> 397 <td>
398 Controls function bytecode stripping when dumping them for lane transfer. Choose between faster copies or more debug info. Default is <tt>true</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>.
@@ -403,7 +403,7 @@
403 <code>.track_lanes</code> 403 <code>.track_lanes</code>
404 </td> 404 </td>
405 <td> 405 <td>
406 <tt>nil</tt>/<tt>false</tt>/anything 406 <tt>nil</tt>/<tt>boolean</tt>
407 </td> 407 </td>
408 <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. 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.
@@ -416,7 +416,7 @@
416 <code>.verbose_errors</code> 416 <code>.verbose_errors</code>
417 </td> 417 </td>
418 <td> 418 <td>
419 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt> 419 <tt>nil</tt>/<tt>boolean</tt>
420 </td> 420 </td>
421 <td> 421 <td>
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). 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).
@@ -429,7 +429,7 @@
429 <code>.with_timers</code> 429 <code>.with_timers</code>
430 </td> 430 </td>
431 <td> 431 <td>
432 <tt>nil</tt>/<tt>false</tt>/<tt>true</tt> 432 <tt>nil</tt>/<tt>boolean</tt>
433 </td> 433 </td>
434 <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). 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).
@@ -440,11 +440,11 @@
440</p> 440</p>
441 441
442<p> 442<p>
443 Once Lanes is configured, one should register with Lanes the modules exporting functions that will be transferred either during lane generation or through <a href="#lindas">lindas</a>. 443 Once Lanes is configured, one should register with Lanes the modules exporting functions that will be transferred either during lane generation or through <a href="#lindas">Lindas</a>.
444 <br /> 444 <br />
445 Use <tt>lanes.require()</tt> for this purpose. This will call the original <tt>require()</tt>, then add the result to the lookup databases. 445 Use <tt>lanes.require()</tt> for this purpose. This will call the original <tt>require()</tt>, then add the result to the lookup databases.
446 <br /> 446 <br />
447 It is also possible to register a given module with <tt>lanes.register()</tt>. This function will raise an error if the registered module is not a function or table. 447 It is also possible to register a given module <i>a posteriori</i> with <tt>lanes.register()</tt>. This function will raise an error if the registered module is not a function or table.
448</p> 448</p>
449 449
450<table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%"> 450<table border="1" bgcolor="#FFFFE0" cellpadding="10" style="width:50%">