autodoc.git
/
traditional_manual
/
chapter_9.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_9.html:8274:
from the backend associated with <code>to</code>.</p> </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'><p>May use blocking I/O and thus trigger process being killed with <tt>SIGPIPE</tt> when the other end closes the connection. Add a call to <code>signal()</code> to avoid this.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>Stdio.sendfile()</code></p> </dd></dl>
-
</dd></dl></dd></dl></dd></dl></body></html>
+
</dd></dl><
dl><dt><h2 class='header'>Module <b class='ms datatype'>Stdio.Pipe<
/
b></h2>
+
</dt><
dd><
dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.Pipe.Base<
/
b></h2>
+
</dt><dd><
dl
class='group--doc'
>
+
<
dt class='head--doc'>Description<
/
dt>
+
<
dd
class='body--doc'
><
p>This module provides a generic data processing non-blocking pipe interface.
+
Set it to a pool of dedicated backends to use more than one CPU core
+
(use one thread per backend).
+
Use it in conjunction with the Shuffler to scale to an unlimited number
+
of CPU cores.<
/
p>
+
</dd></
dl>
+
+
<
hr
/
>
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>close</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>int</code> <b><span class='method'>close</span>(</b><b>)</b></code></p></dd>
+
</dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>create</b></span>
+
</dt>
+
<dd><p><code><span class='object'>Stdio.Pipe.Base</span> <span class='class'>Stdio.Pipe.Base</span><b>(</b><code class='object unresolved'>Gz.deflate</code>|<code class='datatype'>void</code> <code class='argument'>engine</code><b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='
body
--doc'
><
p>Note that the Gz.deflate engine provided needs to be preconfigured
+
using negative compression levels.<
/
p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Variable</span>
+
<span class='homogen--name'><b>engine</b></span>
+
</dt>
+
<dd><p><code><code class='datatype'>object</code> Stdio.Pipe.Base.<b><span class='variable'>engine</span></b></code></p></dd>
+
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Read only</p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>process_data</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>void</code> <b><span class='method'>process_data</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>data</code><b>)</b></code></p></dd>
+
</dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>process_header</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>string(8bit)</code> <b><span class='method'>process_header</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>data</code><b>)</b></code></p></dd>
+
</dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>process_init</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>void</code> <b><span class='method'>process_init</span>(</b><b>)</b></code></p></dd>
+
</dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>process_trailer</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>protected</code> <code class='datatype'>void</code> <b><span class='method'>process_trailer</span>(</b><b>)</b></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_backend</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>void</code> <b><span class='method'>set_backend</span>(</b><code class='object unresolved'>Pike.Backend</code> <code class='argument'>_backend</code><b>)</b></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_close_callback</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>void</code> <b><span class='method'>set_close_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>ccb</code><b>)</b></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_nonblocking</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>void</code> <b><span class='method'>set_nonblocking</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>rcb</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>wcb</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>ccb</code><b>)</b></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>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>void</code> <b><span class='method'>set_read_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>rcb</code><b>)</b></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_write_callback</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>void</code> <b><span class='method'>set_write_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>wcb</code><b>)</b></code></p></dd>
+
</dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>write</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>final</code> <code class='datatype'>int</code> <b><span class='method'>write</span>(</b><code class='datatype'>string(8bit)</code> <code class='argument'>data</code><b>)</b></code></p></dd>
+
</dl>
+
</dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.Pipe.Gunzip</b></h2>
+
</dt><dd><dl class='group--doc'>
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>This module provides a gzip-uncompressing non-blocking pipe interface.</p>
+
</dd></dl>
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Inherit</span>
+
<span class='homogen--name'><b>Base</b></span>
+
</dt>
+
<dd><p><code><span class='datatype'>inherit .Base</span> : <span class='inherit'>Base</span></code></p></dd>
+
</dl>
+
</dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.Pipe.Gzip</b></h2>
+
</dt><dd><dl class='group--doc'>
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>This module provides a gzip-compressing non-blocking pipe interface.
+
Set it to a pool of dedicated backends to use more than one CPU core to
+
compress data (use one thread per backend).
+
Use it in conjunction with the Shuffler to scale to an unlimited number
+
of CPU cores.</p>
+
</dd></dl>
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Inherit</span>
+
<span class='homogen--name'><b>Base</b></span>
+
</dt>
+
<dd><p><code><span class='datatype'>inherit .Base</span> : <span class='inherit'>Base</span></code></p></dd>
+
</dl>
+
</dd></dl></dd></dl></dd></dl></dd></dl></body></
html>