Diff of autodoc.git/traditional_manual/chapter_9.html (d2af38a15788e1dbfa7c5c0105c29298177a6bf5 » 2326c08c0c9a24062031679cd171ae95f7b54d4d)

autodoc.git/traditional_manual/chapter_9.html:1526: but it certainly helps to increase data transfer speed when it does. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>open_socket()</code>, <code>accept()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + set_buffer_mode + </dt> + <dd><code><code class='datatype'>void</code> set_buffer_mode(<code class='object unresolved'>Stdio.IOBuffer</code>|<code class='datatype'>void</code> <code class='argument'>in</code>, <code class='object unresolved'>Stdio.IOBuffer</code>|<code class='datatype'>void</code> <code class='argument'>out</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>Toggle the file to IOBuffer mode. + In this mode reading and writing will be done from IOBuffer objects, + It is assumed that the file will be used in non-blocking mode. + If <code>in</code> or <code>out</code> that specific buffer is used for the specified direction. + The default is to create new buffers for both directions when + this function is called. + </dd> + <dt class='head--doc'>Note</dt> + <dd class='body--doc'>Normally you call <code>write</code> to re-trigger the write callback if + you do not output anything in it (which will stop it from + re-occuring again). + This will work with buffered mode as well, but simply adding more + data to the output buffer will work as well. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method set_callbacks </dt> - <dd><code><code class='datatype'>void</code> set_callbacks(<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>)</code></dd> + <dd><code><code class='datatype'>void</code> set_callbacks(<code class='datatype'>void</code>|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>|<code class='object unresolved'>IOBuffer</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'>void</code>|<code class='object unresolved'>IOBuffer</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>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Installs all the specified callbacks at once. Use <code>UNDEFINED</code> to keep the current setting for a callback. 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. </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_read_callback</code>, <code>set_write_callback</code>,
autodoc.git/traditional_manual/chapter_9.html:1560: Method set_read_oob_callback Method set_write_oob_callback Method set_close_callback Method set_fs_event_callback </dt> <dd><code><code class='datatype'>void</code> set_read_callback(<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> + <code><code class='datatype'>void</code> set_read_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>read_cb</code>)</code> <code><code class='datatype'>void</code> set_write_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_cb</code>)</code> - + <code><code class='datatype'>void</code> set_write_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>write_cb</code>)</code> <code><code class='datatype'>void</code> set_read_oob_callback(<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> <code><code class='datatype'>void</code> set_write_oob_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_oob_cb</code>)</code> <code><code class='datatype'>void</code> set_close_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_cb</code>)</code> <code><code class='datatype'>void</code> set_fs_event_callback(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>int</code>:<code class='datatype'>int</code>) <code class='argument'>fs_event_cb</code>, <code class='datatype'>int</code> <code class='argument'>event_mask</code>)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>These functions set the various callbacks, which will be called when various events occur on the stream. A zero as argument will remove the callback. A <code>Pike.Backend</code> object is responsible for calling the callbacks. It requires a thread to be waiting in it to execute the calls. That means that only one of the callbacks will be running at a time, so you don't need mutexes between them. Unless you've specified otherwise with the <code>set_backend</code> function, the default backend <code>Pike.DefaultBackend</code> will be used. It's normally activated by returning <code class='expr'>-1</code> from the <tt>main</tt> function and will then execute in the main thread. <ul> <li>When data arrives on the stream, <code>read_cb</code> will be called with some or all of that data as the second argument. - + If the file is in buffer mode, the second argument will be an IOBuffer. + This will always be the same buffer, so data you do not use in + one read callback can be simply left in the buffer, when new + data arrives it will be appended </li><li>When the stream has buffer space over for writing, <code>write_cb</code> will be called so that you can write more data to it. This callback is also called after the remote end of a socket connection has closed the write direction. An attempt to write data to it in that case will generate a <code>System.EPIPE</code> errno. If the remote end has closed both directions simultaneously (the usual case), Pike will first attempt to call <code>close_cb</code>, then this callback (unless <code>close_cb</code> has closed the stream). - + If the file is in buffer mode, the second argument will be an IOBuffer. + You should add data to write to this buffer. </li><li>When out-of-band data arrives on the stream, <code>read_oob_cb</code> will be called with some or all of that data as the second argument. </li><li>When the stream allows out-of-band data to be sent, <code>write_oob_cb</code> will be called so that you can write more out-of-band data to it. If the OS doesn't separate the write events for normal and out-of-band data, Pike will try to call <code>write_oob_cb</code> first. If it doesn't write anything, then <code>write_cb</code> will be tried. This also means that <code>write_oob_cb</code> might get called when the
autodoc.git/traditional_manual/chapter_9.html:1765: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>set_blocking()</code> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method set_nonblocking </dt> - <dd><code><code class='datatype'>void</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>read_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_callback</code>)</code> - <code><code class='datatype'>void</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) <code class='argument'>read_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_callback</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_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_oob_callback</code>)</code> + <dd><code><code class='datatype'>void</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>|<code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>read_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>void</code>|<code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_callback</code>)</code> + <code><code class='datatype'>void</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>|<code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>read_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>void</code>|<code class='object unresolved'>IOBuffer</code>:<code class='datatype'>int</code>) <code class='argument'>write_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>close_callback</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_callback</code>, <code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) <code class='argument'>write_oob_callback</code>)</code> <code><code class='datatype'>void</code> set_nonblocking()</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>This function sets a stream to nonblocking mode and installs the specified callbacks. See the <code class='expr'>set_*_callback</code> functions for details about them. If no arguments are given, the callbacks will be cleared. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>As opposed to calling the set callback functions separately,
autodoc.git/traditional_manual/chapter_9.html:6105: copy. </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'>The "avoid copy" part means that a IOBuffer will never shrink unless you call the <code>trim</code> function. </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'>Method + __fd_set_output + </dt> + <dd><code><code class='datatype'>int</code> __fd_set_output(<code class='datatype'>object</code> <code class='argument'>f</code>)</code></dd> + + <dt class='head--doc'>Description</dt> + <dd class='body--doc'>This tells the buffer to trigger the write callback for the + specified filedescriptor when data is added to the buffer. + This is used internally by Stdio.File to handle nonblocking + buffered mode, and is not really intended to be used directly. + If f is 0 the state is cleared. + </dd></dl> + + + <hr /> + <dl class='group--doc'> + <dt class='head--type'>Method _encode Method _decode </dt> <dd><code>string(8bit) encode_value(Stdio.IOBuffer data)</code> <code>Stdio.IOBuffer decode_value(string(8bit) data)</code></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'>Encode and decode Stdio.IOBuffer objects. Only the buffer data is kept, no other state is saved.

autodoc.git / traditional_manual / chapter_9.html