autodoc.git
/
traditional_manual
/
chapter_21.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_21.html:16372:
that is directly returned to the user is the return value from <code>future()</code>.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>Future</code>, <code>future()</code></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>aggregate_cb</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>void</code> <b><span class='method'>aggregate_cb</span>(</b><code class='datatype'>mixed</code> <code class='argument'>value</code>, <code class='datatype'>int</code> <code class='argument'>idx</code>, <code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>mixed</code>) <code class='argument'>results</code><b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Callback used to aggregate the results from dependencies.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-value'></span>Parameter <code class='parameter'>value</code></dt>
+
<dd></dd><dd class='body--doc'><p>Value received from the dependency.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-idx'></span>Parameter <code class='parameter'>idx</code></dt>
+
<dd></dd><dd class='body--doc'><p>Identification number for the dependency.</p>
+
</dd>
+
<dt class='head--doc'><span id='p-results'></span>Parameter <code class='parameter'>results</code></dt>
+
<dd></dd><dd class='body--doc'><p>Either of the mappings in <code>dependency_results</code> depending on
+
whether this was a success or a failure callback.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>The function may also be called with all arguments set to
+
<code>UNDEFINED</code> in order to poll the current state. This is
+
typically done via a call to <code>start()</code>.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>start()</code></p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
<span class='homogen--name'><b>any_results</b></span> </dt> <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>any_results</span>(</b><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Sets the number of failures to be accepted in the list of futures this promise depends upon to unlimited. It is equivalent to <code class='expr'>max_failures(-1)</code>.</p> </dd> <dt class='head--doc'>Returns</dt>
autodoc.git/traditional_manual/chapter_21.html:16441:
not possible to call <code>depend()</code> anymore.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>fold()</code>, <code>first_completed()</code>, <code>max_failures()</code>, <code>min_failures()</code>, <code>any_results()</code>, <code>Concurrent.results()</code>, <code>Concurrent.all()</code></p> </dd></dl> <hr /> <dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Variable</span>
+
<span class='homogen--name'><b>dependency_results</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>array</code>(<code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>mixed</code>)) Concurrent.Promise.<b><span class='variable'>dependency_results</span></b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><table class='box'><tr><td colspan='2'>Array</td></tr>
+
<tr><td><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>mixed</code>) <code class='key'>0</code></code></td><td><p>Successful results.</p>
+
</td></tr>
+
<tr><td><code><code class='datatype'>mapping</code>(<code class='datatype'>int</code>:<code class='datatype'>mixed</code>) <code class='key'>1</code></code></td><td><p>Failed results.</p>
+
</td></tr>
+
</table>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
<dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>failure</b></span> </dt> <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>failure</span>(</b><code class='datatype'>mixed</code> <code class='argument'>value</code><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Reject the <code>Future</code> value.</p> </dd> <dt class='head--doc'><span id='p-value'></span>Parameter <code class='parameter'>value</code></dt> <dd></dd><dd class='body--doc'><p>Failure result of the <code>Future</code>.</p>
autodoc.git/traditional_manual/chapter_21.html:16583:
<dd class='body--doc'><p>The new <code>Promise</code>.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>depend()</code>, <code>max_failures()</code></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>start</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>void</code> <b><span class='method'>start</span>(</b><b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Start the aggregation of values from dependencies.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>This function is called from several functions. These
+
include <code>on_success()</code>, <code>on_failure()</code>, <code>wait()</code>,
+
<code>get()</code>, <code>fold()</code> and <code>first_completed()</code>.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>After this function has been called, several functions
+
may no longer be called. These include <code>depend()</code>,
+
<code>fold()</code>, <code>first_completed()</code>, <code>max_failures()</code>,
+
<code>min_failures()</code>, <code>any_results()</code>.</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
<span class='homogen--name'><b>success</b></span> </dt> <dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>success</span>(</b><code class='datatype'>mixed</code> <code class='argument'>value</code><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Fulfill the <code>Future</code>.</p> </dd> <dt class='head--doc'><span id='p-value'></span>Parameter <code class='parameter'>value</code></dt> <dd></dd><dd class='body--doc'><p>Result of the <code>Future</code>.</p> </dd>
autodoc.git/traditional_manual/chapter_21.html:74869:
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Calling `() will return a <code>State</code> object.</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>crypt_hash</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(
8bit
)</code> <b><span class='method'>crypt_hash</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>string(8bit)</code> <code class='argument'>salt</code>, <code class='datatype'>int</code> <code class='argument'>rounds</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(
7bit
)</code> <b><span class='method'>crypt_hash</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>password</code>, <code class='datatype'>string(8bit)</code> <code class='argument'>salt</code>, <code class='datatype'>int</code> <code class='argument'>rounds</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Password hashing function in <code>crypt_md5()</code>-style.</p> <p> Implements the algorithm described in <a href='http://www.akkadia.org/drepper/SHA-crypt.txt'>http://www.akkadia.org/drepper/SHA-crypt.txt</a>.</p> <p> This is the algorithm used by <tt>crypt(2)</tt> in methods <tt>$5$</tt> (SHA256) and <tt>$6$</tt> (SHA512).</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>crypt_md5()</code></p>
autodoc.git/traditional_manual/chapter_21.html:75397:
<dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>client_2</code></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>client_2</b></span> </dt>
-
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>client_2</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>line</code>, <code class='datatype'>string
(8bit)
</code> <code class='argument'>pass</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string(7bit)</code> <b><span class='method'>client_2</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>line</code>, <code class='datatype'>string</code> <code class='argument'>pass</code><b>)</b></code></p></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Client-side step 2 in the SCRAM handshake.</p> </dd> <dt class='head--doc'><span id='p-line'></span>Parameter <code class='parameter'>line</code></dt> <dd></dd><dd class='body--doc'><p>The received server-first challenge from the server.</p> </dd> <dt class='head--doc'><span id='p-pass'></span>Parameter <code class='parameter'>pass</code></dt> <dd></dd><dd class='body--doc'><p>The password to feed to the server.</p> </dd>