lanes.threads(): documentation

1 files changed, 35 insertions, 1 deletions

diff --git a/docs/index.html b/docs/index.html
index 1368928..f90a36e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -69,7 +69,7 @@
                         </p>
 
                         <p>
-                                This document was revised on 11-Dec-12, and applies to version <tt>3.4.1</tt>.
+                                This document was revised on 14-Dec-12, and applies to version <tt>3.4.1</tt>.
                         </p>
                 </font>
         </center>
@@ -233,6 +233,19 @@
                 </tr>
 
                 <tr valign=top>
+                        <td id="track_lanes">
+                                <code>.track_lanes</code>
+                        </td>
+                        <td>
+                                <tt>nil</tt>/<tt>false</tt>/anything
+                        </td>
+                        <td>
+                                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.
+                                Default tracking behavior will only enable to get information about free-running garbage collected lanes.
+                        </td>
+                </tr>
+
+                <tr valign=top>
                         <td>
                                 <code>.on_create_state</code>
                         </td>
@@ -612,6 +625,27 @@
 </p>
 
 
+<!-- tracking +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+<hr/>
+<h2 id="tracking">Tracking</h2>
+
+        <table border="1" bgcolor="#E0E0FF" cellpadding="10" style="width:50%">
+                <tr>
+                        <td>
+                                <pre>   {}|nil = lanes.threads()</pre>
+                        </td>
+                </tr>
+        </table>
+
+<p>
+        Only available if lane tracking feature is compiled (see <tt>HAVE_LANE_TRACKING</tt> in <tt>lanes.c</tt>).
+        <br>
+        Returns a table where keys are a lane's name and values are the lane's status. Returns <tt>nil</tt> if no lane is running.
+        <br>
+        The list contents depends on configuration option <a href="#track_lanes"><tt>track_lanes</tt></a>.
+</p>
+
+
 <!-- results +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
 <hr/>
 <h2 id="results">Results and errors</h2>