</li>
<li>
- <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
+ <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
</li>
<li>
- <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
+ <a href="../modules/luci.http.date.html">luci.http.date</a>
</li>
<li>
- <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
- </li>
-
- <li>
- <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
+ <a href="../modules/luci.http.mime.html">luci.http.mime</a>
</li>
<li>
</tr>
<tr>
+ <td class="name" nowrap><a href="#Cursor.get_session_id">Cursor:get_session_id</a> ()</td>
+ <td class="summary">
+
+Get the effective session ID.</td>
+ </tr>
+
+ <tr>
<td class="name" nowrap><a href="#Cursor.load">Cursor:load</a> (config)</td>
<td class="summary">
</tr>
<tr>
+ <td class="name" nowrap><a href="#Cursor.set_session_id">Cursor:set_session_id</a> (id)</td>
+ <td class="summary">
+
+Set the effective session ID.</td>
+ </tr>
+
+ <tr>
<td class="name" nowrap><a href="#Cursor.substate">Cursor:substate</a> ()</td>
<td class="summary">
</li>
<li>
- comparator: Function that will be called for each section and
-returns a boolean whether to delete the current section (optional)
+ comparator: Function that will be called for each section and returns
+ a boolean whether to delete the current section (optional)
</li>
</ul>
<h3>Return value:</h3>
-UCI value
+table. If the option was not found, you will simply get an empty
+ table.
+<dt><a name="Cursor.get_session_id"></a><strong>Cursor:get_session_id</strong> ()</dt>
+<dd>
+
+
+Get the effective session ID.
+
+
+
+
+
+
+
+
+<h3>Return value:</h3>
+String containing the session ID
+
+
+
+</dd>
+
+
+
+
<dt><a name="Cursor.load"></a><strong>Cursor:load</strong> (config)</dt>
<dd>
Set a value or create a named section.
+
+When invoked with three arguments <code>config</code>, <code>sectionname</code>, <code>sectiontype</code>,
+then a named section of the given type is created.
+
+When invoked with four arguments <code>config</code>, <code>sectionname</code>, <code>optionname</code> and
+<code>optionvalue</code> then the value of the specified option is set to the given value.
</li>
<li>
- value: UCI value or nil if you want to create a section
+ value: UCI value or nothing if you want to create a section
</li>
</ul>
<dd>
-Set given values as list.
+Set given values as list. Setting a list option to an empty list
+has the same effect as deleting the option.
</li>
<li>
- value: UCI value
+ value: Value or table. Non-table values will be set as single
+ item UCI list.
</li>
</ul>
+<dt><a name="Cursor.set_session_id"></a><strong>Cursor:set_session_id</strong> (id)</dt>
+<dd>
+
+
+Set the effective session ID.
+
+
+
+<h3>Parameters</h3>
+<ul>
+
+ <li>
+ id: String containing the session ID to set
+ </li>
+
+</ul>
+
+
+
+
+
+
+<h3>Return value:</h3>
+Boolean whether operation succeeded
+
+
+
+</dd>
+
+
+
+
<dt><a name="Cursor.substate"></a><strong>Cursor:substate</strong> ()</dt>
<dd>
-Create a sub-state of this cursor. The sub-state is tied to the parent
+Create a sub-state of this cursor.
-curser, means it the parent unloads or loads configs, the sub state will
-do so as well.
+The sub-state is tied to the parent curser, means it the parent unloads or
+loads configs, the sub state will do so as well.
+