autodoc.git / traditional_manual / chapter_9.html

version» Context lines:

autodoc.git/traditional_manual/chapter_9.html:113:         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>connect</b></span>   </dt>   <dd><p><code><code class='modifier'>variant</code> <code class='datatype'>int</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>port</code><b>)</b></code><br>   <code><code class='modifier'>variant</code> <code class='datatype'>int</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>client</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>client_port</code><b>)</b></code><br>   <code><code class='modifier'>variant</code> <code class='datatype'>string</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code><br> - <code><code class='modifier'>variant</code> <code class='datatype'>string</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>int(0..0)</code>|<code class='datatype'>string</code> <code class='argument'>client</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>client_port</code>, <code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code></p></dd> + <code><code class='modifier'>variant</code> <code class='datatype'>string</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>int(0)</code>|<code class='datatype'>string</code> <code class='argument'>client</code>, <code class='datatype'>int(0..)</code>|<code class='datatype'>string</code> <code class='argument'>client_port</code>, <code class='datatype'>string</code> <code class='argument'>data</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Open a TCP/IP connection to the specified destination.</p>   <p> In nonblocking mode, success is indicated with the write-callback,    and failure with the close-callback or the read_oob-callback.</p>   <p> The <code>host</code> argument is the hostname or IP number of the remote    machine.</p>   <p> A local IP and port can be explicitly bound by specifying    <code>client</code> and <code>client_port</code>.</p>   <p> If the <code>data</code> argument is included the socket will use
autodoc.git/traditional_manual/chapter_9.html:438:    <code>PROP_SHUTDOWN</code>, <code>PROP_BUFFERED</code>, <code>PROP_REVERSE</code>,    <code>PROP_BIDIRECTIONAL</code>, <code>PROP_TTY</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>query_buffer_mode</b></span>   </dt> - <dd><p><code><code class='datatype'>array</code>(<code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0..0)</code>) <b><span class='method'>query_buffer_mode</span>(</b><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>array</code>(<code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0)</code>) <b><span class='method'>query_buffer_mode</span>(</b><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Get the active input and output buffers that have been    set with <code>set_buffer_mode()</code> (if any).</p>   </dd>   <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>Returns an array with two elements:</p>   <table class='box'><tr><td colspan='2'>Array</td></tr>   <tr><td><code><code class='object unresolved'>Stdio.Buffer</code> <code class='key'>0</code></code></td><td><p>The current input buffer.</p>   </td></tr>
autodoc.git/traditional_manual/chapter_9.html:602:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>set_nonblocking()</code>, <code>set_blocking()</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_buffer_mode</b></span>   </dt> - <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_buffer_mode</span>(</b><code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0..0)</code> <code class='argument'>in</code>, <code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0..0)</code> <code class='argument'>out</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>void</code> <b><span class='method'>set_buffer_mode</span>(</b><code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0)</code> <code class='argument'>in</code>, <code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0)</code> <code class='argument'>out</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Toggle the file to Buffer mode.</p>   <p> In this mode reading and writing will be done via Buffer    objects, in the directions you included buffers.</p>   </dd>   <dt class='head--doc'><span id='p-in'></span>Parameter <code class='parameter'>in</code></dt>   <dd></dd><dd class='body--doc'><p>Input buffer.</p>   </dd>   <dt class='head--doc'><span id='p-out'></span>Parameter <code class='parameter'>out</code></dt>
autodoc.git/traditional_manual/chapter_9.html:4620:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Clear the buffer.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>consume</b></span>   </dt> - <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1..-1)</code> <b><span class='method'>consume</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1)</code> <b><span class='method'>consume</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Discard the first <code>n</code> bytes from the buffer</p>   <p> Returns -1 on error and the amount of space still left otherwise.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>
autodoc.git/traditional_manual/chapter_9.html:5214:   <dd class='body--doc'><p>This function could possibly throw an out-of-memory error    if the realloc fails to find a new (smaller) memory area.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>truncate</b></span>   </dt> - <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1..-1)</code> <b><span class='method'>truncate</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1)</code> <b><span class='method'>truncate</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Truncates the buffer to a length of <code>n</code> bytes.</p>   <p> Returns -1 on error and the number of bytes removed otherwise.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>
autodoc.git/traditional_manual/chapter_9.html:5272:   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>read()</code></p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>unread</b></span>   </dt> - <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1..-1)</code> <b><span class='method'>unread</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>int(0..)</code>|<code class='datatype'>int(-1)</code> <b><span class='method'>unread</span>(</b><code class='datatype'>int(0..)</code> <code class='argument'>n</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Rewind the buffer <code>n</code> bytes.</p>   </dd>   <dt class='head--doc'>Returns</dt>   <dd class='body--doc'><p>This function returns how many more bytes of buffer is    available to rewind, or -1 on error.</p>   </dd>   <dt class='head--doc'>Note</dt>   <dd class='body--doc'><p>Unless you add new data to the buffer using any of the add
autodoc.git/traditional_manual/chapter_9.html:5742:   <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Returns size and the creation time of the string.</p>   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>sync</b></span>   </dt> - <dd><p><code><code class='datatype'>int(1..1)</code> <b><span class='method'>sync</span>(</b><b>)</b></code></p></dd> + <dd><p><code><code class='datatype'>int(1)</code> <b><span class='method'>sync</span>(</b><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Always returns 1.</p>   </dd>   <dt class='head--doc'>See also</dt>   <dd class='body--doc'><p><code>Stdio.File()-&gt;sync()</code></p>   </dd></dl>         <hr />
autodoc.git/traditional_manual/chapter_9.html:5922:   </dd></dl>         <hr />   <dl class='group--doc'>   <dt class='head--type'><span class='homogen--type'>Method</span>   <span class='homogen--name'><b>connect</b></span>   </dt>   <dd><p><code><code class='datatype'>bool</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>dest_addr</code>, <code class='datatype'>int</code> <code class='argument'>dest_port</code><b>)</b></code><br>   <code><code class='datatype'>bool</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>dest_addr</code>, <code class='datatype'>int</code> <code class='argument'>dest_port</code>, <code class='datatype'>string</code> <code class='argument'>src_addr</code>, <code class='datatype'>int</code> <code class='argument'>src_port</code><b>)</b></code><br> - <code><code class='datatype'>string(8bit)</code>|<code class='datatype'>int(0..0)</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>dest_addr</code>, <code class='datatype'>int</code> <code class='argument'>dest_port</code>, <code class='datatype'>string</code>|<code class='datatype'>int(0..0)</code> <code class='argument'>src_addr</code>, <code class='datatype'>int</code>|<code class='datatype'>int(0..0)</code> <code class='argument'>src_port</code>, <code class='datatype'>string(8bit)</code> <code class='argument'>data</code><b>)</b></code></p></dd> + <code><code class='datatype'>string(8bit)</code>|<code class='datatype'>int(0)</code> <b><span class='method'>connect</span>(</b><code class='datatype'>string</code> <code class='argument'>dest_addr</code>, <code class='datatype'>int</code> <code class='argument'>dest_port</code>, <code class='datatype'>string</code>|<code class='datatype'>int(0)</code> <code class='argument'>src_addr</code>, <code class='datatype'>int</code>|<code class='datatype'>int(0)</code> <code class='argument'>src_port</code>, <code class='datatype'>string(8bit)</code> <code class='argument'>data</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Open a TCP/IP connection to the specified destination.</p>   <p> In nonblocking mode, success is indicated with the write-callback,    and failure with the close-callback or the read_oob-callback.</p>   <p> If the <code>data</code> argument is included the socket will use    TCP_FAST_OPEN if available, if not the data will <i>not be    sent</i>. In the data case the function either returns the data    that has not been sent (only one packet can be sent with this    option) or 0 if the connection failed immediately.</p>
autodoc.git/traditional_manual/chapter_9.html:7085:   <code><code class='datatype'>int</code> <b><span class='method'>tcsetattr</span>(</b><code class='datatype'>mapping</code> <code class='argument'>attr</code><b>)</b></code><br>   <code><code class='datatype'>int</code> <b><span class='method'>tcsetattr</span>(</b><code class='datatype'>mapping</code> <code class='argument'>attr</code>, <code class='datatype'>string</code> <code class='argument'>when</code><b>)</b></code></p></dd>      <dt class='head--doc'>Description</dt>   <dd class='body--doc'><p>Gets/sets term attributes. The returned value/the <code>attr</code> parameter    is a mapping on the form</p>   <table class='box'><tr><td><code><code class='key'>"ispeed"</code> : <code class='datatype'>int(-1..)</code></code></td><td><p>In baud rate.</p>   </td></tr>   <tr><td><code><code class='key'>"ospeed"</code> : <code class='datatype'>int(-1..)</code></code></td><td><p>Out baud rate.</p>   </td></tr> - <tr><td><code><code class='key'>"csize"</code> : <code class='datatype'>int(-1..-1)</code>|<code class='datatype'>int(5..8)</code></code></td><td><p>Character size in bits.</p> + <tr><td><code><code class='key'>"csize"</code> : <code class='datatype'>int(-1)</code>|<code class='datatype'>int(5..8)</code></code></td><td><p>Character size in bits.</p>   </td></tr>   <tr><td><code><code class='key'>"rows"</code> : <code class='datatype'>int</code></code></td><td><p>Terminal rows.</p>   </td></tr>   <tr><td><code><code class='key'>"columns"</code> : <code class='datatype'>int</code></code></td><td><p>Terminal columns.</p>   </td></tr>   <tr><td><code><code class='key'>flag_name</code> : <code class='datatype'>bool</code></code></td><td><p>The value of a named flag. The flag name is    the string describing the termios flags (IGNBRK, BRKINT,    IGNPAR, PARMRK, INPCK, ISTRIP, INLCR, IGNCR, ICRNL, IUCLC,    IXON, IXANY, IXOFF, IMAXBEL, OPOST, OLCUC, ONLCR, OCRNL,    ONOCR, ONLRET, OFILL, OFDEL, OXTABS, ONOEOT, CSTOPB, CREAD,