autodoc.git/ traditional_manual/ chapter_9.html

Branch: Tag:

2010-10-10

2010-10-10 21:56:26 by Martin Stjernholm <mast@lysator.liu.se>

Added set_callbacks and query_callbacks to handle several callbacks at once.

1036:   <span class='homogen--name'><b>query_write_oob_callback</b></span><br>   <span class='homogen--type'>Method</span>   <span class='homogen--name'><b>query_close_callback</b></span><br> + <span class='homogen--type'>Method</span> + <span class='homogen--name'><b>query_callbacks</b></span><br>   </dt>   <dd><p><code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <b><span class='method'>query_read_callback</span>(</b><b>)</b></code><br>   <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <b><span class='method'>query_write_callback</span>(</b><b>)</b></code><br>   <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <b><span class='method'>query_read_oob_callback</span>(</b><b>)</b></code><br>   <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <b><span class='method'>query_write_oob_callback</span>(</b><b>)</b></code><br> - <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <b><span class='method'>query_close_callback</span>(</b><b>)</b></code></p></dd> + <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <b><span class='method'>query_close_callback</span>(</b><b>)</b></code><br> + <code><code class='datatype'>array</code>(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code>:<code class='datatype'>int</code>)) <b><span class='method'>query_callbacks</span>(</b><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>These functions return the currently installed callbacks for the    respective events.</p> -  + <p> <code>query_callbacks</code> returns the callbacks in the same order as +  <code>set_callbacks</code> and <code>set_nonblocking</code> expect them.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>set_nonblocking()</code>, <code>set_read_callback</code>,    <code>set_write_callback</code>, <code>set_read_oob_callback</code>, -  <code>set_write_oob_callback</code>, <code>set_close_callback</code></p> +  <code>set_write_oob_callback</code>, <code>set_close_callback</code>, +  <code>set_callbacks</code></p>   </dd></dl>      
1372:   <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span> + <span class='homogen--name'><b>set_callbacks</b></span> + </dt> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_callbacks</span>(</b><code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>read_cb</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_cb</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_cb</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>read_oob_cb</code>, <code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_oob_cb</code><b>)</b></code></p></dd> +  + <dt class='head--doc'>Description</dt> + <dd class='body--doc'><p>Installs all the specified callbacks at once. Use <code>UNDEFINED</code> +  to keep the current setting for a callback.</p> + <p> Like <code>set_nonblocking</code>, the callbacks are installed atomically. +  As opposed to <code>set_nonblocking</code>, this function does not do +  anything with the stream, and it doesn't even have to be open.</p> + </dd> + <dt class='head--doc'>See also</dt> + <dd class='body--doc'><p><code>set_read_callback</code>, <code>set_write_callback</code>, +  <code>set_read_oob_callback</code>, <code>set_write_oob_callback</code>, +  <code>set_close_callback</code>, <code>query_callbacks</code></p> + </dd></dl> +  +  + <hr /> + <dl class='group--doc'> + <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_read_callback</b></span><br>   <span class='homogen--type'>Method</span>   <span class='homogen--name'><b>set_write_callback</b></span><br>
1458:   <dd class='body--doc'><p>These functions do not set the file nonblocking.</p>   </dd>   <dt class='head--doc'>Note</dt> - <dd class='body--doc'><p>Callbacks are also set by <code>set_nonblocking()</code>.</p> + <dd class='body--doc'><p>Callbacks are also set by <code>set_callbacks</code> and +  <code>set_nonblocking()</code>.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>After a callback has been called, it's disabled until it has
1497:    data arrives.</p>   </dd>   <dt class='head--doc'>See also</dt> - <dd class='body--doc'><p><code>set_nonblocking()</code>, <code>set_id()</code>, <code>set_backend</code>, -  <code>query_read_callback</code>, <code>query_write_callback</code>, + <dd class='body--doc'><p><code>set_callbacks</code>, <code>set_nonblocking()</code>, <code>set_id()</code>, +  <code>set_backend</code>, <code>query_read_callback</code>, <code>query_write_callback</code>,    <code>query_read_oob_callback</code>, <code>query_write_oob_callback</code>,    <code>query_close_callback</code></p>   </dd></dl>
1599:    option <tt>'--without-oob'</tt>.</p>   </dd>   <dt class='head--doc'>See also</dt> - <dd class='body--doc'><p><code>set_blocking()</code>, <code>set_read_callback()</code>, + <dd class='body--doc'><p><code>set_blocking()</code>, <code>set_callbacks</code>, <code>set_read_callback()</code>,    <code>set_write_callback()</code>, <code>set_read_oob_callback()</code>,    <code>set_write_oob_callback()</code>, <code>set_close_callback()</code>    <code>set_nonblocking_keep_callbacks()</code>,