autodoc.git
/
traditional_manual
/
chapter_9.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_9.html:6215:
<dt class='head--doc'>Description</dt> <dd class='body--doc'><p>This module emulates a bidirectional pipe/socket without using any actual file descriptors.</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.FakePipe</span> <span class='class'>Stdio.FakePipe</span><b>(</b><b>)</b></code></p></dd>
+
<dd><p><code><span class='object'>Stdio.FakePipe</span> <span class='class'>Stdio.FakePipe</span><b>(</b><
code class='datatype'>void</code>|<code class='datatype'>string</code> <code class='argument'>direction</code><
b>)</b></code></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>
+
<span class='homogen--name'><b>
InternalSocket
</b></span>
</dt>
-
<dd><p><code><span class='datatype'>
<code class='modifier'>local</code>
inherit InternalSocket</span> : <span class='inherit'>
Base
</span></code></p></dd>
+
<dd><p><code><span class='datatype'>inherit InternalSocket</span> : <span class='inherit'>
InternalSocket
</span></code></p></dd>
</dl>
-
-
-
<hr />
-
<dl class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>Inherit</span>
-
<span class='homogen--name'><b>Other</b></span>
-
</dt>
-
<dd><p><code><span class='datatype'><code class='modifier'>protected</code> <code class='modifier'>local</code> inherit InternalSocket</span> : <span class='inherit'>Other</span></code></p></dd>
-
</dl>
+
<dl><dt><h2 class='header'>Class <b class='ms datatype'>Stdio.FakePipe.InternalSocket</b></h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Class that implements one end of an emulated bi-directional pipe/socket.</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 class='head--type'><span class='homogen--type'>
Variable
</span>
+
<span class='homogen--name'><b>
_other
</b></span>
<br>
+
<span class='homogen--type'>Variable</span>
+
<span class='homogen--name'><b>_read_buffer</b></span><br>
+
<span class='homogen--type'>Variable</span>
+
<span class='homogen--name'><b>_write_buffer</b></span><br>
</dt>
-
<dd><p><code><code class='
datatype
'>
int
</code> <b><span class='
method
'>
close
</span>
(
</b><code class='
datatype
'>
string
</code>
|
<
code
class='
datatype
'>
void
</code>
<code class='
argument
'>
direction
</code><b>
)
</b></code></p></dd>
+
<dd><p><code><code class='
modifier
'>
protected
</code>
<
code class='object unresolved'>this_program</code> Stdio.FakePipe.InternalSocket.<
b><span class='
variable
'>
_other
</span></b><
/
code
><br>
+
<code><code
class='
object unresolved
'>
Stdio.Buffer
</code>
Stdio.FakePipe.InternalSocket.
<
b><span
class='
variable
'>
_read_buffer
</
span></b></
code><
br>
+
<
code
><code
class='
object unresolved
'>
Stdio.Buffer
</code>
Stdio.FakePipe.InternalSocket.
<b><
span class='variable'>_write_buffer<
/
span></
b></code></p></dd>
</dl> <hr /> <dl class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>
Variable
</span>
-
<span class='homogen--name'><b>
other
</b></span>
<br>
-
<span class='homogen--type'>Variable</span>
-
<span class='homogen--name'><b>read_buffer</b></span><br>
-
<span class='homogen--type'>Variable</span>
-
<span class='homogen--name'><b>write_buffer</b></span><br>
-
<span class='homogen--type'>Variable</span>
-
<span class='homogen--name'><b>mux</b></span><br>
-
<span class='homogen--type'>Variable</span>
-
<span class='homogen--name'><b>cond</b></span><br>
+
<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
'>
protected
</code>
<
code class='object unresolved'>this_program</code> Stdio.FakePipe.InternalSocket.<
b><span class='
variable
'>
other
</span></b><
/
code
><br>
-
<code><code
class='
modifier
'>
protected
</code>
<code class='
object unresolved
'>
Stdio.Buffer
</code>
Stdio.FakePipe.InternalSocket.
<
b><span class='variable'>read_buffer</span></b></
code
><br>
-
<code><code
class='
modifier
'>
protected
</code>
<
code class='object unresolved'>Stdio.Buffer</code> Stdio.FakePipe.InternalSocket.<
b><
span class='variable'>write_buffer<
/
span></
b></code><
br>
-
<code><code class='modifier'>protected<
/
code> <code class='object unresolved'>Thread.Mutex</code> Stdio.FakePipe.InternalSocket.<b><span class='variable'>mux</span></b></code><br>
-
<code><code class='modifier'>protected</code> <code class='object unresolved'>Thread.Condition</code> Stdio.FakePipe.InternalSocket.<b><span class='variable'>cond</span></b></code></
p></dd>
+
<dd><p><code><code class='
datatype
'>
int
</code> <b><span class='
method
'>
close
</span>
(
</b><code class='
datatype
'>
string
</code>
|
<code class='
datatype
'>
void
</code> <code class='
argument
'>
direction
</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>create</b></span> </dt>
-
<dd><p><code><span class='object'>Stdio.FakePipe.InternalSocket</span> <span class='class'>Stdio.FakePipe.InternalSocket</span><b>(</b><code class='object unresolved'>this_program</code> <code class='argument'>other</code>, <code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>read_buffer</code>, <code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>write_buffer</code>
,
<
code class='object unresolved'>Thread.Mutex</code> <code class='argument'>mux</code>, <code class='object unresolved'>Thread.Condition</code> <code class='argument'>cond</code><
b>)</b></code></p></dd>
+
<dd><p><code><span class='object'>Stdio.FakePipe.InternalSocket</span> <span class='class'>Stdio.FakePipe.InternalSocket</span><b>(</b><code class='object unresolved'>this_program</code> <code class='argument'>
_
other</code>, <code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>
_
read_buffer</code>, <code class='object unresolved'>Stdio.Buffer</code> <code class='argument'>
_
write_buffer</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>errno</b></span> </dt> <dd><p><code><code class='datatype'>int</code> <b><span class='method'>errno</span>(</b><b>)</b></code></p></dd> </dl>
autodoc.git/traditional_manual/chapter_9.html:6310:
<dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>get_id</b></span> </dt> <dd><p><code><code class='datatype'>mixed</code> <b><span class='method'>get_id</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>get_other</b></span>
-
</dt>
-
<dd><p><code><code class='object unresolved'>this_program</code> <b><span class='method'>get_other</span>(</b><b>)</b></code></p></dd>
-
-
<dt class='head--doc'>Description</dt>
-
<dd class='body--doc'><p>Get the other end of the emulated pipe/socket.</p>
-
</dd></dl>
-
-
-
<hr />
-
<dl class='group--doc'>
-
<dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>get_read_callback</b></span> </dt> <dd><p><code><code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <b><span class='method'>get_read_callback</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>get_write_callback</b></span>
autodoc.git/traditional_manual/chapter_9.html:6348:
<dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span> <span class='homogen--name'><b>is_open</b></span> </dt> <dd><p><code><code class='datatype'>bool</code> <b><span class='method'>is_open</span>(</b><code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>direction</code><b>)</b></code></p></dd> </dl> <hr /> <dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Variable</span>
+
<span class='homogen--name'><b>other</b></span>
+
</dt>
+
<dd><p><code><code class='object unresolved'>this_program</code> Stdio.FakePipe.InternalSocket.<b><span class='variable'>other</span></b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Get the other end of the emulated pipe/socket.</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>peek</b></span> </dt> <dd><p><code><code class='datatype'>int(-1..1)</code> <b><span class='method'>peek</span>(</b><code class='datatype'>int</code>|<code class='datatype'>float</code>|<code class='datatype'>void</code> <code class='argument'>timeout</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>not_eof</code><b>)</b></code></p></dd> </dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>