autodoc.git
/
traditional_manual
/
chapter_9.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_9.html:3915:
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>tell</b></span> </dt> <dd><p><code><code class='datatype'>int</code> <b><span class='method'>tell</span>(</b><b>)</b></code></p></dd> </dl> </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.FakeFile</b></h2> </dt><dd><dl class='group--doc'>
+
<dt class='head--doc'>Annotations</dt>
+
<dd class='body--annotation'><pre><code>@<code>Pike.Annotations.Implements</code>(<code>Stdio.BlockFile</code>)</code></pre></dd><dd class='body--annotation'><pre><code>@<code>Pike.Annotations.Implements</code>(<code>Stdio.NonblockingStream</code>)</code></pre></dd>
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>A string wrapper that pretends to be a <code>Stdio.File</code> object in addition to some features of a <code>Stdio.FILE</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>_sizeof</b></span> </dt>
autodoc.git/traditional_manual/chapter_9.html:4667:
<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> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>set_close_callback</b></span><br> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>set_fs_event_callback</b></span><br> </dt>
-
<dd><p><code><code class='
object unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_read_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>
,
<
code class='datatype'>mixed</code> ... <code class='argument'>rest</code><
b>)</b></code><br>
-
<code><code class='
object unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_write_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>
,
<
code class='datatype'>mixed</code> ... <code class='argument'>rest</code><
b>)</b></code><br>
-
<code><code class='
object unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_close_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>
,
<
code class='datatype'>mixed</code> ... <code class='argument'>rest</code><
b>)</b></code><br>
-
<code><code class='
object
unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_fs_event_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>, <code class='datatype'>int</code> <code class='argument'>event_mask</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code><b>)</b></code></p></dd>
+
<dd><p><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='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code><br>
+
<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='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code><br>
+
<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='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code><br>
+
<code><code class='
modifier'>optional</code>
<code class=
'
datatype'
>
void
</code> <b><span class='method'>set_fs_event_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>, <code class='datatype'>int</code> <code class='argument'>event_mask</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code><b>)</b></code></p></dd>
+
</dl>
-
<dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>11</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='datatype'>void</code> <b><span class='method'>set_nonblocking</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>a</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>b</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>c</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>void</code> <code class='argument'>d</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>void</code> <code class='argument'>e</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_oob_callback</b></span><br> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>set_write_oob_callback</b></span><br> </dt>
-
<dd><p><code><code class='modifier'>optional</code> <code class='
object unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_read_oob_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>
,
<
code class='datatype'>mixed</code> ... <code class='argument'>rest</code><
b>)</b></code><br>
-
<code><code class='modifier'>optional</code> <code class='
object unresolved
'>
NonblockingStream
</code> <b><span class='method'>set_write_oob_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code>
,
<
code class='datatype'>mixed</code> ... <code class='argument'>rest</code><
b>)</b></code></p></dd>
+
<dd><p><code><code class='modifier'>optional</code> <code class='
datatype
'>
void
</code> <b><span class='method'>set_read_oob_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code><br>
+
<code><code class='modifier'>optional</code> <code class='
datatype
'>
void
</code> <b><span class='method'>set_write_oob_callback</span>(</b><code class='datatype'>function</code>(:<code class='datatype void'>void</code>)|<code class='datatype'>zero</code> <code class='argument'>f</code><b>)</b></code></p></dd>
</dl> </dd></dl><dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.Stream</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>The Stdio.Stream API.</p> <p> This class exists purely for typing reasons.</p> <p> Use in types in place of <code>Stdio.File</code> where only blocking stream-oriented I/O is done with the object.</p> <p> This class lists the minimum functionality guaranteed to exist in all Stream objects.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>NonblockingStream</code>, <code>BlockFile</code>, <code>File</code>, <code>FILE</code></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='datatype'>
void
</code> <b><span class='method'>close</span>(</b><b>)</b></code></p></dd>
+
<dd><p><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>read</b></span> </dt>
-
<dd><p><code><code class='datatype'>string</code> <b><span class='method'>read</span>(</b><code class='datatype'>int</code> <code class='argument'>nbytes</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>string</code> <b><span class='method'>read</span>(</b><code class='datatype'>int
(0..)
</code> <code class='argument'>nbytes</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>read_oob</b></span><br> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>write_oob</b></span><br> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>tcgetattr</b></span><br> <span class='homogen--type'>Method</span> <span class='homogen--name'><b>tcsetattr</b></span><br> </dt>
-
<dd><p><code><code class='modifier'>optional</code> <code class='datatype'>string</code> <b><span class='method'>read_oob</span>(</b><code class='datatype'>int</code> <code class='argument'>nbytes</code><b>)</b></code><br>
-
<code><code class='modifier'>optional</code> <code class='datatype'>int</code> <b><span class='method'>write_oob</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code><br>
-
<code><code class='modifier'>optional</code> <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) <b><span class='method'>tcgetattr</span>(</b><b>)</b></code><br>
+
<dd><p><code><code class='modifier'>optional</code> <code class='datatype'>string</code> <b><span class='method'>read_oob</span>(</b><code class='datatype'>int
(0..)
</code> <code class='argument'>nbytes</code><b>)</b></code><br>
+
<code><code class='modifier'>optional</code> <code class='datatype'>int
(-1..)
</code> <b><span class='method'>write_oob</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code><br>
+
<code><code class='modifier'>optional</code> <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>)
|<code
class='datatype'>zero
<
/code> <
b><span class='method'>tcgetattr</span>(</b><b>)</b></code><br>
<code><code class='modifier'>optional</code> <code class='datatype'>int</code> <b><span class='method'>tcsetattr</span>(</b><code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>attr</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>when</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='datatype'>int</code> <b><span class='method'>write</span>(</b><code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code></p></dd>
+
<dd><p><code><code class='datatype'>int
(-1..)
</code> <b><span class='method'>write</span>(</b><code class='datatype'>string</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.sendfile</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Send <code class='expr'>headers + from_fd[off..off+len-1] + trailers</code> to <code class='expr'>to_fd</code> asyncronously.</p> </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'><p>This is the low-level implementation, which has several limitations. You probably want to use <code>Stdio.sendfile()</code> instead.</p>