Log of autodoc.git/traditional_manual/chapter

2020-05-23

2020-05-23 13:10:51 by Marcus Comstedt <marcus@mc.pp.se>

6bbb87babc3f4c1a732fee1a2a1926265fa96f3e (3089 lines) (+513/-2576) ^{[

Show
| Annotate

]}
Branch: master

Thread.ResourceCount: Provide fallback implementation

594: </dd> <dt><a name='9.5'></a> <h2 class='header'>9.5. Files and sockets</h2></dt> - <dd><dl><dt><h2 class='header'>Class Stdio.File</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This is the basic I/O object, it provides socket and pipe - communication as well as file access. It does not buffer reads and - writes by default, and provides no line-by-line reading, that is done - with <code>Stdio.FILE</code> object. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The file or stream will normally be closed when this object is - destructed (unless there are more objects that refer to the same - file through use of <code>assign</code> or <code>dup</code>). Objects do not contain - cyclic references in themselves, so they will be destructed timely - when they run out of references. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.FILE</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - assign - </dt> - <dd><code><code class='datatype'>int</code> assign(<code class='object unresolved'>File</code>|<code class='object unresolved'>Fd</code> <code class='argument'>o</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function takes a clone of Stdio.File and assigns all - variables of this file from it. It can be used together with <code>dup()</code> - to move files around. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>dup()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - async_connect - </dt> - <dd><code><code class='datatype'>int</code> async_connect(<code class='datatype'>string</code> <code class='argument'>host</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open a TCP/IP connection asynchronously. - This function is similar to <code>connect()</code>, but works asynchronously. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>host</code></dt> - <dd></dd><dd class='body--doc'>Hostname or IP to connect to. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>port</code></dt> - <dd></dd><dd class='body--doc'>Port number or service name to connect to. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>callback</code></dt> - <dd></dd><dd class='body--doc'>Function to be called on completion. - The first argument will be <code class='expr'>1</code> if a connection was - successfully established, and <code class='expr'>0</code> (zero) on failure. - The rest of the arguments to <code>callback</code> are passed - verbatim from <code>args</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>Extra arguments to pass to <code>callback</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>0</code> on failure to open a socket, and <code class='expr'>1</code> - if <code>callback</code> will be used. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The socket may be opened with <code>open_socket()</code> ahead of - the call to this function, but it is not required. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This object is put in callback mode by this function. For - <code>callback</code> to be called, the backend must be active. See e.g. - <code>set_read_callback</code> for more details about backends and - callback mode. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The socket will be in nonblocking state if the connection is - successful, and any callbacks will be cleared. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>connect()</code>, <code>open_socket()</code>, <code>set_nonblocking()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - close - </dt> - <dd><code><code class='datatype'>int</code> close()</code> - <code><code class='datatype'>int</code> close(<code class='datatype'>string</code> <code class='argument'>direction</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Close the file. Optionally, specify "r", "w" or "rw" to close just - the read, just the write or both read and write directions of the file - respectively. - An exception is thrown if an I/O error occurs. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Nonzero is returned if the file wasn't open in the specified - direction, zero otherwise. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function will not call the <tt>close_callback</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>open</code>, <code>open_socket</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - connect - </dt> - <dd><code><code class='modifier'>variant</code> <code class='datatype'>int</code> connect(<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> - <code><code class='modifier'>variant</code> <code class='datatype'>int</code> connect(<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>)</code> - <code><code class='modifier'>variant</code> <code class='datatype'>string</code> connect(<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>)</code> - <code><code class='modifier'>variant</code> <code class='datatype'>string</code> connect(<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>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open a TCP/IP connection to the specified destination. - In nonblocking mode, success is indicated with the write-callback, - and failure with the close-callback or the read_oob-callback. - The <code>host</code> argument is the hostname or IP number of the remote - machine. - A local IP and port can be explicitly bound by specifying - <code>client</code> and <code>client_port</code>. - If the <code>data</code> argument is included the socket will use - TCP_FAST_OPEN if posible. In this mode the the function will - return the part of the data that has not been sent to the remote - server yet instead of 1 (you will have to use <code>write</code> to send - this data). - Note that TCP_FAST_OPEN requires server support, the connection - might fail even though the remote server exists. It might be - advisable to retry without TCP_FAST_OPEN (and remember this - fact) - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>This function returns 1 or the remaining <code>data</code> for success, 0 - otherwise. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>In nonblocking mode <code class='expr'>0</code> (zero) may be returned and - <code>errno()</code> set to <code class='expr'>EWOULDBLOCK</code> or <code class='expr'>WSAEWOULDBLOCK</code>. - This should not be regarded as a - connection failure. In nonblocking mode you need to wait for a - write or close callback before you know if the connection failed - or not. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>query_address()</code>, <code>async_connect()</code>, <code>connect_unix()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - connect_unix - </dt> - <dd><code><code class='datatype'>int</code> connect_unix(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open a UNIX domain socket connection to the specified destination. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>1</code> on success, and <code class='expr'>0</code> on failure. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Nonblocking mode is not supported while connecting - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>Stdio.File Stdio.File()</code> - <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code> - <code>Stdio.File Stdio.File(<code class='datatype'>string</code> <code class='argument'>descriptorname</code>)</code> - <code>Stdio.File Stdio.File(<code class='datatype'>int</code> <code class='argument'>fd</code>)</code> - <code>Stdio.File Stdio.File(<code class='datatype'>int</code> <code class='argument'>fd</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>There are four basic ways to create a Stdio.File object. - The first is calling it without any arguments, in which case the you'd - have to call <code>open()</code>, <code>connect()</code> or some other method which connects - the File object with a stream. - The second way is calling it with a <code>filename</code> and open <code>mode</code>. This is - the same thing as cloning and then calling <code>open()</code>, except shorter and - faster. - The third way is to call it with <code>descriptorname</code> of <code class='expr'>"stdin"</code>, - <code class='expr'>"stdout"</code> or <code class='expr'>"stderr"</code>. This will open the specified - standard stream. - For the advanced users, you can use the file descriptors of the - systems (note: emulated by pike on some systems - like NT). This is - only useful for streaming purposes on unix systems. This is not - recommended at all if you don't know what you're into. Default - <code>mode</code> for this is <code class='expr'>"rw"</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Open mode will be filtered through the system UMASK. You - might need to use <code>chmod()</code> later. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>open()</code>, <code>connect()</code>, <code>Stdio.FILE</code>, - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - dup - </dt> - <dd><code><code class='object unresolved'>File</code> dup()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function returns a clone of Stdio.File with all variables - copied from this file. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>All variables, even <tt>id</tt>, are copied. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>assign()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - errno - </dt> - <dd><code><code class='datatype'>int</code> errno()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns the error code for the last command on this file. - Error code is normally cleared when a command is successful. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Fd - </dt> - <dd><code><code class='modifier'>optional</code> inherit Fd : Fd</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - line_iterator - </dt> - <dd><code><code class='object unresolved'>String.SplitIterator</code>|<code class='object unresolved'>LineIterator</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. - If trim is true, all <tt>'\r'</tt> characters will be removed from - the input. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - open - </dt> - <dd><code><code class='datatype'>int</code> open(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code><code class='datatype'>int</code> open(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open a file for read, write or append. The parameter <code>mode</code> should - contain one or more of the following letters: - <table class='box'><tr><td><code><code class='key'>"r"</code></code></td><td>Open file for reading. - </td></tr> - <tr><td><code><code class='key'>"w"</code></code></td><td>Open file for writing. - </td></tr> - <tr><td><code><code class='key'>"a"</code></code></td><td>Open file for append (use with <code class='expr'>"w"</code>). - </td></tr> - <tr><td><code><code class='key'>"t"</code></code></td><td>Truncate file at open (use with <code class='expr'>"w"</code>). - </td></tr> - <tr><td><code><code class='key'>"c"</code></code></td><td>Create file if it doesn't exist (use with <code class='expr'>"w"</code>). - </td></tr> - <tr><td><code><code class='key'>"x"</code></code></td><td>Fail if file already exists (use with <code class='expr'>"c"</code>). - </td></tr> - </table><code>mode</code> should always contain at least one of the letters - <code class='expr'>"r"</code> or <code class='expr'>"w"</code>. - The parameter <code>mask</code> is protection bits to use if the file is - created. Default is <code class='expr'>0666</code> (read+write for all in octal - notation). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>This function returns <code class='expr'>1</code> for success, <code class='expr'>0</code> otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>close()</code>, <code>create()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - open_socket - </dt> - <dd><code><code class='datatype'>int</code> open_socket(<code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>port</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>address</code>, <code class='datatype'>int</code>|<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>family_hint</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This makes this file into a socket ready for connections. The reason - for this function is so that you can set the socket to nonblocking - or blocking (default is blocking) before you call <code>connect()</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>port</code></dt> - <dd></dd><dd class='body--doc'>If you give a port number to this function, the socket will be - bound to this port locally before connecting anywhere. This is - only useful for some silly protocols like FTP. The port can - also be specified as a string, giving the name of the service - associated with the port. Pass -1 to not specify a port (eg to - bind only to an address). - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>address</code></dt> - <dd></dd><dd class='body--doc'>You may specify an address to bind to if your machine has many IP - numbers. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>family_hint</code></dt> - <dd></dd><dd class='body--doc'>A protocol family for the socket can be specified. If no family is - specified, one which is appropriate for the address is automatically - selected. Thus, there is normally no need to specify it. If you - do not want to specify a bind address, you can provide the address - as a hint here instead, to allow the automatic selection to work - anyway. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>This function returns 1 for success, 0 otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>connect()</code>, <code>set_nonblocking()</code>, <code>set_blocking()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - openat - </dt> - <dd><code><code class='object unresolved'>File</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='object unresolved'>File</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code><code class='object unresolved'>File</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open a file relative to an open directory. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>File.statat()</code>, <code>File.unlinkat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - openpt - </dt> - <dd><code><code class='datatype'>int</code> openpt(<code class='datatype'>string</code> <code class='argument'>mode</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Open the master end of a pseudo-terminal pair. The parameter - <code>mode</code> should contain one or more of the following letters: - <table class='box'><tr><td><code><code class='key'>"r"</code></code></td><td>Open terminal for reading. - </td></tr> - <tr><td><code><code class='key'>"w"</code></code></td><td>Open terminal for writing. - </td></tr> - </table><code>mode</code> should always contain at least one of the letters - <code class='expr'>"r"</code> or <code class='expr'>"w"</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>grantpt()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - pipe - </dt> - <dd><code><code class='object unresolved'>File</code> pipe(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>required_properties</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function creates a pipe between the object it was called in - and an object that is returned. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>required_properties</code></dt> - <dd></dd><dd class='body--doc'>Binary or (<code>predef::`|()</code>) of required <code class='expr'>PROP_</code> properties. - <table class='box'><tr><td><code><code class='key'>PROP_IPC</code></code></td><td>The resulting pipe may be used for inter process communication. - </td></tr> - <tr><td><code><code class='key'>PROP_NONBLOCK</code></code></td><td>The resulting pipe supports nonblocking I/O. - </td></tr> - <tr><td><code><code class='key'>PROP_SHUTDOWN</code></code></td><td>The resulting pipe supports shutting down transmission in either - direction (see <code>close()</code>). - </td></tr> - <tr><td><code><code class='key'>PROP_BUFFERED</code></code></td><td>The resulting pipe is buffered (usually 4KB). - </td></tr> - <tr><td><code><code class='key'>PROP_BIDIRECTIONAL</code></code></td><td>The resulting pipe is bi-directional. - </td></tr> - <tr><td><code><code class='key'>PROP_SEND_FD</code></code></td><td>The resulting pipe might support sending of file descriptors - (see <code>send_fd()</code> and <code>receive_fd()</code> for details). - </td></tr> - <tr><td><code><code class='key'>PROP_TTY</code></code></td><td>The resulting pipe is a pseudo-tty. - </td></tr> - <tr><td><code><code class='key'>PROP_REVERSE</code></code></td><td>The resulting pipe supports communication "backwards" (but - not necessarily "forwards", see <code>PROP_BIDIRECTIONAL</code>). - </td></tr> - </table>The default is <code class='expr'>PROP_NONBLOCK|PROP_BIDIRECTIONAL</code>. - If <code>PROP_BIDIRECTIONAL</code> isn't specified, the read-end is this - object, and the write-end is the returned object (unless - <code>PROP_REVERSE</code> has been specified, in which case it is the other - way around). - The two ends of a bi-directional pipe are indistinguishable. - For <code>PROP_TTY</code> the returned object is the slave (unless - <code>PROP_REVERSE</code> has been specified). - If the File object this function is called in was open to begin with, - it will be closed before the pipe is created. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Calling this function with an argument of <tt>0</tt> is not the - same as calling it with no arguments. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Process.create_process()</code>, <code>send_fd()</code>, <code>receive_fd()</code>, - <code>PROP_IPC</code>, <code>PROP_NONBLOCK</code>, <code>PROP_SEND_FD</code>, - <code>PROP_SHUTDOWN</code>, <code>PROP_BUFFERED</code>, <code>PROP_REVERSE</code>, - <code>PROP_BIDIRECTIONAL</code>, <code>PROP_TTY</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - query_buffer_mode - </dt> - <dd><code><code class='datatype'>array</code>(<code class='object unresolved'>Stdio.Buffer</code>|<code class='datatype'>int(0..0)</code>) query_buffer_mode()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get the active input and output buffers that have been - set with <code>set_buffer_mode()</code> (if any). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns an array with two elements: - <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>The current input buffer. - </td></tr> - <tr><td><code><code class='object unresolved'>Stdio.Buffer</code> <code class='key'>1</code></code></td><td>The current output buffer. - </td></tr> - </table> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_buffer_mode()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - query_read_callback - Method - query_write_callback - Method - query_read_oob_callback - Method - query_write_oob_callback - Method - query_close_callback - Method - query_callbacks - </dt> - <dd><code><code class='object unresolved'>read_callback_t</code> query_read_callback()</code> - <code><code class='object unresolved'>write_callback_t</code> query_write_callback()</code> - <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>string</code>:<code class='datatype'>int</code>) query_read_oob_callback()</code> - <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) query_write_oob_callback()</code> - <code><code class='datatype'>function</code>(<code class='datatype'>mixed</code>:<code class='datatype'>int</code>) query_close_callback()</code> - <code><code class='datatype'>array</code>(<code class='datatype'>function</code>(<code class='datatype'>mixed</code>, <code class='datatype'>void</code>|<code class='datatype'>string</code>:<code class='datatype'>int</code>)) query_callbacks()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>These functions return the currently installed callbacks for the - respective events. - <code>query_callbacks</code> returns the callbacks in the same order as - <code>set_callbacks</code> and <code>set_nonblocking</code> expect them. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_read_callback</code>, - <code>set_write_callback</code>, <code>set_read_oob_callback</code>, - <code>set_write_oob_callback</code>, <code>set_close_callback</code>, - <code>set_callbacks</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - query_id - </dt> - <dd><code><code class='datatype'>mixed</code> query_id()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function returns the <tt>id</tt> that has been set with <code>set_id()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_id()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read - </dt> - <dd><code><code class='datatype'>string(8bit)</code> read(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>nbytes</code>, <code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>not_all</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read (optionally buffered) data from a file or a stream. - Proxy function for <code>Fd::read()</code>, that adds support for - the buffering configured by <code>set_buffer_mode()</code> - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read_function()</code>, <code>write()</code>, <code>Fd::read()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_function - </dt> - <dd><code><code class='datatype'>function</code>(:<code class='datatype'>string</code>) read_function(<code class='datatype'>int</code> <code class='argument'>nbytes</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a function that when called will call <code>read</code> with - nbytes as argument. Can be used to get various callback - functions, eg for the fourth argument to - <code>String.SplitIterator</code>. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - send_fd - </dt> - <dd><code><code class='datatype'>void</code> send_fd(<code class='object unresolved'>File</code>|<code class='object unresolved'>Fd</code> <code class='argument'>file</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_blocking - </dt> - <dd><code><code class='datatype'>void</code> set_blocking()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function clears all callbacks and sets a stream to blocking - mode. i.e. reading, writing and closing will wait until data has - been transferred before returning. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The callbacks are cleared and blocking mode is set in one atomic - operation, so no callback gets called in between if the backend - is running in another thread. - Even so, if the stream is in callback mode (i.e. if any - callbacks are installed) then only the backend thread can use - this function reliably; it might otherwise already be running in - a callback which is about to call e.g. <code>write</code> when the stream - becomes blocking. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_nonblocking_keep_callbacks()</code>, - <code>set_blocking_keep_callbacks()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_nonblocking_keep_callbacks - Method - set_blocking_keep_callbacks - </dt> - <dd><code><code class='datatype'>void</code> set_nonblocking_keep_callbacks()</code> - <code><code class='datatype'>void</code> set_blocking_keep_callbacks()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Toggle between blocking and nonblocking, - without changing the callbacks. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_nonblocking()</code>, <code>set_blocking()</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.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>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Toggle the file to Buffer mode. - In this mode reading and writing will be done via Buffer - objects, in the directions you included buffers. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>in</code></dt> - <dd></dd><dd class='body--doc'>Input buffer. If this buffer is non-empty, its contents - will be returned after any already received data. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>out</code></dt> - <dd></dd><dd class='body--doc'>Output buffer. If this buffer is non-empty, its contents - will be sent after any data already queued for sending. - </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 output mode as well, but simply - adding more data to the output buffer will work as well. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>query_buffer_mode()</code> - </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='object unresolved'>read_callback_t</code>|<code class='datatype'>void</code> <code class='argument'>read_cb</code>, <code class='object unresolved'>write_callback_t</code>|<code class='datatype'>void</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>, - <code>set_read_oob_callback</code>, <code>set_write_oob_callback</code>, - <code>set_close_callback</code>, <code>query_callbacks</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_read_callback - Method - set_write_callback - 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'>Buffer</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'>Buffer</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 a Buffer. - 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 a Buffer. - 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 - remote end of a connection has closed the write direction. - </li><li>When an error or an end-of-stream in the read direction - occurs, <code>close_cb</code> will be called. <code>errno</code> will return the - error, or zero in the case of an end-of-stream. - The name of this callback is rather unfortunate since it - really has nothing to do with a close: The stream is still - open when <code>close_cb</code> is called (you might not be able to read - and/or write to it, but you can still use things like - <code>query_address</code>, and the underlying file descriptor is still - allocated). Also, this callback will not be called for a local - close, neither by a call to <code>close</code> or by destructing this - object. - Also, <code>close_cb</code> will not be called if a remote close only - occurs in the write direction; that is handled by <code>write_cb</code> - (or possibly <code>write_oob_cb</code>). - Events to <code>read_cb</code> and <code>close_cb</code> will be automatically - deregistered if an end-of-stream occurs, and all events in the - case of an error. I.e. there won't be any more calls to the - callbacks unless they are reinstalled. This doesn't affect the - callback settings - <code>query_read_callback</code> et al will still - return the installed callbacks. - </li></ul>If the stream is a socket performing a nonblocking connect (see - <code>open_socket</code> and <code>connect</code>), a connection failure will call - <code>close_cb</code>, and a successful connect will call either - <code>read_cb</code> or <code>write_cb</code> as above. - All callbacks will receive the <tt>id</tt> set by <code>set_id</code> as - first argument. - If a callback returns <code class='expr'>-1</code>, no other callback or call out - will be called by the backend in that round. I.e. the caller of - the backend will get control back right away. For the default - backend that means it will immediately start another round and - check files and call outs anew. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>event_mask</code></dt> - <dd></dd><dd class='body--doc'>An event mask specifing bitwise OR of one or more event types to - monitor, selected from <code>Stdio.NOTE_WRITE</code> and friends. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>These functions do not set the file nonblocking. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Callbacks are also set by <code>set_callbacks</code> and - <code>set_nonblocking()</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>After a callback has been called, it's disabled until it has - accessed the stream accordingly, i.e. the <code>write_cb</code> callback - is disabled after it's been called until something has been - written with <code>write</code>, and the <code>write_oob_cb</code> callback is - likewise disabled until something has been written with - <code>write_oob</code>. Since the data already has been read when the read - callbacks are called, this effect is not noticeable for them. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Installing callbacks means that you will start doing I/O on the - stream from the thread running the backend. If you are running - these set functions from another thread you must be prepared - that the callbacks can be called immediately by the backend - thread, so it might not be safe to continue using the stream in - this thread. - Because of that, it's useful to talk about "callback mode" when - any callback is installed. In callback mode the stream should be - seen as "bound" to the backend thread. For instance, it's only - the backend thread that reliably can end callback mode before - the stream is "handed over" to another thread. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Callback mode has nothing to do with nonblocking mode - although - the two often are used together they don't have to be. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The file object will stay referenced from the backend object as - long as there are callbacks that can receive events. - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'>Setting a close callback without a read callback currently only - works when there's no risk of getting more data on the stream. - Otherwise the close callback will be silently deregistered if - data arrives. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>fs_event callbacks only trigger on systems that support these events. - Currently, this includes systems that use kqueue, such as Mac OS X, - and various flavours of BSD. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_callbacks</code>, <code>set_nonblocking()</code>, <code>set_id()</code>, - <code>set_backend</code>, <code>query_read_callback</code>, <code>query_write_callback</code>, - <code>query_read_oob_callback</code>, <code>query_write_oob_callback</code>, - <code>query_close_callback</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_id - </dt> - <dd><code><code class='datatype'>void</code> set_id(<code class='datatype'>mixed</code> <code class='argument'>id</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function sets the <tt>id</tt> of this file. The <tt>id</tt> is mainly - used as an identifier that is sent as the first argument to all - callbacks. The default <tt>id</tt> is <code class='expr'>0</code> (zero). Another possible - use of the <tt>id</tt> is to hold all data related to this file in a - mapping or array. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>query_id()</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='object unresolved'>read_callback_t</code> <code class='argument'>read_callback</code>, <code class='object unresolved'>write_callback_t</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='object unresolved'>read_callback_t</code> <code class='argument'>read_callback</code>, <code class='object unresolved'>write_callback_t</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, - this function will set all the callbacks and nonblocking mode - atomically so that no callback gets called in between. That - avoids races in case the backend is executed by another thread. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Out-of-band data was not be supported on Pike 0.5 and earlier, - and not on Pike 0.6 through 7.4 if they were compiled with the - option <tt>'--without-oob'</tt>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>set_blocking()</code>, <code>set_callbacks</code>, <code>set_read_callback()</code>, - <code>set_write_callback()</code>, <code>set_read_oob_callback()</code>, - <code>set_write_oob_callback()</code>, <code>set_close_callback()</code> - <code>set_nonblocking_keep_callbacks()</code>, - <code>set_blocking_keep_callbacks()</code> - </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Stdio.FILE</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'><code>Stdio.FILE</code> is a buffered version of <code>Stdio.File</code>, it inherits - <code>Stdio.File</code> and has most of the functionality of <code>Stdio.File</code>. - However, it has an input buffer that allows line-by-line input. - It also has support for automatic charset conversion for both input - and output (see <code>Stdio.FILE()->set_charset()</code>). - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The output part of <code>Stdio.FILE</code> is currently not buffered. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - _get_iterator - </dt> - <dd><code>Stdio.FILE a; - foreach( a; index; value ) or </code><code><code class='modifier'>protected</code> <code class='datatype'>object</code> _get_iterator()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>line_iterator()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - getchar - </dt> - <dd><code><code class='modifier'>local</code> <code class='datatype'>int</code> getchar()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function returns one character from the input stream. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the ISO-10646 (Unicode) value of the character. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>Returns an <code class='expr'>int</code> and not a <code class='expr'>string</code> of length 1. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - gets - </dt> - <dd><code><code class='datatype'>string</code> gets(<code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>not_all</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read one line of input with support for input conversion. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>not_all</code></dt> - <dd></dd><dd class='body--doc'>Set this parameter to ignore partial lines at EOF. This - is useful for eg monitoring a growing logfile. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>This function returns the line read if successful, and <code class='expr'>0</code> if - no more lines are available. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>ngets()</code>, <code>read()</code>, <code>line_iterator()</code>, <code>set_charset()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - file - </dt> - <dd><code>inherit File : file</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - line_iterator - </dt> - <dd><code><code class='datatype'>object</code> line_iterator(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>trim</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns an iterator that will loop over the lines in this file. - If <code>trim</code> is true, all <tt>'\r'</tt> characters will be removed - from the input. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>It's not supported to call this method more than once - unless a call to <code>seek</code> is done in advance. Also note that it's - not possible to intermingle calls to <code>read</code>, <code>gets</code> or other - functions that read data with the line iterator, it will produce - unexpected results since the internal buffer in the iterator will not - contain sequential file-data in those cases. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>_get_iterator()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - ngets - </dt> - <dd><code><code class='datatype'>array</code>(<code class='datatype'>string</code>) ngets(<code class='datatype'>void</code>|<code class='datatype'>int(1..)</code> <code class='argument'>n</code>, <code class='datatype'>bool</code>|<code class='datatype'>void</code> <code class='argument'>not_all</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Get <code>n</code> lines. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>n</code></dt> - <dd></dd><dd class='body--doc'>Number of lines to get, or all remaining if zero. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>not_all</code></dt> - <dd></dd><dd class='body--doc'>Set this parameter to ignore partial lines at EOF. This - is useful for eg monitoring a growing logfile. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - openat - </dt> - <dd><code><code class='object unresolved'>FILE</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='object unresolved'>FILE</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>)</code> - <code><code class='object unresolved'>FILE</code> openat(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>mode</code>, <code class='datatype'>int</code> <code class='argument'>mask</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Same as <code>Stdio.File()->openat()</code>, but returns an <code>Stdio.FILE</code> - object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->openat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - pipe - </dt> - <dd><code><code class='object unresolved'>FILE</code> pipe(<code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>flags</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Same as <code>Stdio.File()->pipe()</code>, but returns an <code>Stdio.FILE</code> - object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->pipe()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - printf - </dt> - <dd><code><code class='datatype'>int</code> printf(<code class='datatype'>string</code> <code class='argument'>format</code>, <code class='datatype'>mixed</code> ... <code class='argument'>data</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function does approximately the same as: - <code class='expr'><code>write</code>(<code>sprintf</code>(<code>format</code>,@<code>data</code>))</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>write()</code>, <code>sprintf()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read - </dt> - <dd><code><code class='datatype'>string</code> read(<code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>bytes</code>, <code class='datatype'>void</code>|<code class='datatype'>bool</code> <code class='argument'>now</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>bytes</code> (wide-) characters with buffering and support for - input conversion. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->read()</code>, <code>set_charset()</code>, <code>unread()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_charset - </dt> - <dd><code><code class='datatype'>void</code> set_charset(<code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>charset</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sets the input and output charset of this file to the specified - <code>charset</code>. If <code>charset</code> is 0 or not specified the environment - is used to try to detect a suitable charset. - The default charset if this function is not called is - <tt>"ISO-8859-1"</tt>. - </dd><dt class='head--fixme'>FIXME</dt> - <dd class='body--fixme'>Consider using one of - ISO-IR-196 (<tt>"\e%G"</tt> - switch to UTF-8 with return) - or ISO-IR-190 (<tt>"\e%/G"</tt> - switch to UTF-8 level 1 no return) - or ISO-IR-191 (<tt>"\e%/H"</tt> - switch to UTF-8 level 2 no return) - or ISO-IR-192 (<tt>"\e%/I"</tt> - switch to UTF-8 level 3 no return) - or ISO-IR-193 (<tt>"\e%/J"</tt> - switch to UTF-16 level 1 no return) - or ISO-IR-194 (<tt>"\e%/K"</tt> - switch to UTF-16 level 2 no return) - or ISO-IR-195 (<tt>"\e%/L"</tt> - switch to UTF-16 level 3 no return) - or ISO-IR-162 (<tt>"\e%/@"</tt> - switch to UCS-2 level 1) - or ISO-IR-163 (<tt>"\e%/A"</tt> - switch to UCS-4 level 1) - or ISO-IR-174 (<tt>"\e%/C"</tt> - switch to UCS-2 level 2) - or ISO-IR-175 (<tt>"\e%/D"</tt> - switch to UCS-4 level 2) - or ISO-IR-176 (<tt>"\e%/E"</tt> - switch to UCS-2 level 3) - or ISO-IR-177 (<tt>"\e%/F"</tt> - switch to UCS-4 level 3) - or ISO-IR-178 (<tt>"\e%B"</tt> - switch to UTF-1) - automatically to encode wide strings. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - ungets - </dt> - <dd><code><code class='datatype'>void</code> ungets(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function puts a line back in the input buffer. The line - can then be read with eg <code>read()</code>, <code>gets()</code> or <code>getchar()</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The string is autoterminated by an extra line-feed. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code>, <code>unread()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - unread - </dt> - <dd><code><code class='datatype'>void</code> unread(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function puts a string back in the input buffer. The string - can then be read with eg <code>read()</code>, <code>gets()</code> or <code>getchar()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read()</code>, <code>gets()</code>, <code>getchar()</code>, <code>ungets()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write - </dt> - <dd><code><code class='datatype'>int</code> write(<code class='datatype'>array</code>(<code class='datatype'>string</code>)|<code class='datatype'>string</code> <code class='argument'>what</code>, <code class='datatype'>mixed</code> ... <code class='argument'>fmt</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Write <code>what</code> with support for output_conversion. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File()->write()</code> - </dd></dl> - </dd></dl></dd> + <dd></dd> <dt><a name='9.6'></a> <h2 class='header'>9.6. Ports and UDP</h2></dt> - <dd><dl><dt><h2 class='header'>Class Stdio.Port</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Handles listening to socket ports. Whenever you need a bound - socket that is open and listens for connections you should - use this program. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - accept - </dt> - <dd><code><code class='object unresolved'>File</code> accept()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function completes a connection made from a remote machine to - this port. It returns a two-way stream in the form of a clone of - <code>Stdio.File</code>. The new file is by initially set to blocking mode. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File</code>, <code>fd_factory()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - create - </dt> - <dd><code>Stdio.Port Stdio.Port()</code> - <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>)</code> - <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>)</code> - <code>Stdio.Port Stdio.Port(<code class='datatype'>int</code>|<code class='datatype'>string</code> <code class='argument'>port</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>, <code class='datatype'>string</code> <code class='argument'>ip</code>)</code> - <code>Stdio.Port Stdio.Port(<code class='argument'>"stdin"</code>)</code> - <code>Stdio.Port Stdio.Port(<code class='argument'>"stdin"</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>accept_callback</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>If the first argument is other than <code class='expr'>"stdin"</code> the arguments will - be passed to <code>bind()</code>. - When create is called with <code class='expr'>"stdin"</code> as the first argument, a - socket is created out of the file descriptor <code class='expr'>0</code>. This is only - useful if it actually is a socket to begin with, and is equivalent to - creating a port and initializing it with <code>listen_fd</code>(0). - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>bind</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - fd_factory - </dt> - <dd><code><code class='modifier'>protected</code> <code class='object unresolved'>Fd</code> fd_factory()</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Factory creating empty <code>Fd</code> objects. - This function is called by <code>accept()</code> when it needs to create - a new file. - The default implementation returns the <code>Fd</code> inherit in - an empty <code>File</code> object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>accept()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - _port - </dt> - <dd><code>inherit _port : _port</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Stdio.UDP</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>UDP (User Datagram Protocol) handling. - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - UDP - </dt> - <dd><code>inherit _Stdio.UDP : UDP</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_nonblocking - </dt> - <dd><code><code class='object unresolved'>UDP</code> set_nonblocking()</code> - <code><code class='object unresolved'>UDP</code> set_nonblocking(<code class='datatype'>function</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>), <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>read_cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Set this object to nonblocking mode. - If <code>read_cb</code> and <code>extra_args</code> are specified, they will be passed on - to <code>set_read_callback()</code>. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The called object. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_read_callback - </dt> - <dd><code><code class='object unresolved'>UDP</code> set_read_callback(<code class='datatype'>function</code>(<code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>|<code class='datatype'>string</code>), <code class='datatype'>mixed</code> ... :<code class='datatype void'>void</code>) <code class='argument'>read_cb</code>, <code class='datatype'>mixed</code> ... <code class='argument'>extra_args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The <code>read_cb</code> function will receive a mapping similar to the mapping - returned by <code>read()</code>: - <table class='box'><tr><td><code><code class='key'>"data"</code> : <code class='datatype'>string</code></code></td><td>Received data. - </td></tr> - <tr><td><code><code class='key'>"ip"</code> : <code class='datatype'>string</code></code></td><td>Data was sent from this IP. - </td></tr> - <tr><td><code><code class='key'>"port"</code> : <code class='datatype'>int</code></code></td><td>Data was sent from this port. - </td></tr> - </table> - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>The called object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read()</code> - </dd></dl> - </dd></dl></dd> + <dd></dd> <dt><a name='9.7'></a> <h2 class='header'>9.7. Terminal I/O</h2></dt> <dd><dl><dt><h2 class='header'>Module Stdio.Terminfo</h2>
3221: <dt><a name='9.8'></a> <h2 class='header'>9.8. Other</h2></dt> <dd><dl><dt><h2 class='header'>Module Stdio</h2> - </dt><dd> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - DATA_CHUNK_SIZE - </dt> - <dd><code><code class='datatype'><code class='modifier'>final</code> constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>DATA_CHUNK_SIZE</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Size used in various places to divide incoming or outgoing data - into chunks. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - TCSADRAIN - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSADRAIN</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. - Change after all output has been written. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - TCSAFLUSH - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSAFLUSH</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. - Change after all output has been written, - and empty the input buffers. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Constant - TCSANOW - </dt> - <dd><code><code class='datatype'>constant</code> <code class='datatype'>string</code> Stdio.<code class='constant'>TCSANOW</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Argument to <code>Stdio.File()->tcsetattr()</code>. - Change immediately. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - append_file - </dt> - <dd><code><code class='datatype'>int</code> append_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Append the string <code>str</code> onto the file <code>filename</code>. - For a description of <code>access</code>, see <code>Stdio.File->open()</code>. - </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of bytes written, i.e. <code class='expr'>sizeof(str)</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>write_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - append_path - Method - append_path_unix - Method - append_path_nt - </dt> - <dd><code><code class='datatype'>string</code> append_path(<code class='datatype'>string</code> <code class='argument'>absolute</code>, <code class='datatype'>string</code> ... <code class='argument'>relative</code>)</code> - <code><code class='datatype'>string</code> append_path_unix(<code class='datatype'>string</code> <code class='argument'>absolute</code>, <code class='datatype'>string</code> ... <code class='argument'>relative</code>)</code> - <code><code class='datatype'>string</code> append_path_nt(<code class='datatype'>string</code> <code class='argument'>absolute</code>, <code class='datatype'>string</code> ... <code class='argument'>relative</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Append <code>relative</code> paths to an <code>absolute</code> path and remove any - <code class='expr'>"//"</code>, <code class='expr'>"../"</code> or <code class='expr'>"/."</code> to produce a - straightforward absolute path as a result. - <code class='expr'>"../"</code> is ignorded in the relative paths if it makes the - created path begin with something else than the absolute path - (or so far created path). - <code>append_path_nt()</code> fixes drive letter issues in <code>relative</code> - by removing the colon separator <code class='expr'>":"</code> if it exists (k:/fnord appends - as k/fnord) - <code>append_path_nt()</code> also makes sure that UNC path(s) in <code>relative</code> is appended - correctly by removing any <code class='expr'>"\\"</code> or <code class='expr'>"//"</code> from the beginning. - <code>append_path()</code> is equivalent to <code>append_path_unix()</code> on UNIX-like - operating systems, and equivalent to <code>append_path_nt()</code> on NT-like - operating systems. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>combine_path()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - async_cp - </dt> - <dd><code><code class='datatype'>void</code> async_cp(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Copy a file asynchronously. - This function is similar to <code>cp()</code>, but works asynchronously. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>from</code></dt> - <dd></dd><dd class='body--doc'>Name of file to copy. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>to</code></dt> - <dd></dd><dd class='body--doc'>Name of file to create or replace with a copy of <code>from</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>callback</code></dt> - <dd></dd><dd class='body--doc'>Function to be called on completion. - The first argument will be <code class='expr'>1</code> on success, and <code class='expr'>0</code> (zero) - otherwise. The rest of the arguments to <code>callback</code> are passed - verbatim from <code>args</code>. - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>args</code></dt> - <dd></dd><dd class='body--doc'>Extra arguments to pass to <code>callback</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>For <code>callback</code> to be called, the backend must be active (ie - <code>main()</code> must have returned <code class='expr'>-1</code>, or <code>Pike.DefaultBackend</code> - get called in some other way). The actual copying may start - before the backend has activated. - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'>Currently the file sizes are not compared, so the destination file - (<code>to</code>) may be truncated. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>cp()</code>, <code>sendfile()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - convert_modestring2int - </dt> - <dd><code><code class='datatype'>int</code> convert_modestring2int(<code class='datatype'>string</code> <code class='argument'>mode_string</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Convert the mode_string string as returned by Stdio.Stat object - to int suitable for chmod - </dd> - <dt class='head--doc'>Parameter <code class='parameter'>mode_string</code></dt> - <dd></dd><dd class='body--doc'>The string as return from Stdio.Stat()->mode_string - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>An int matching the permission of the mode_string string suitable for - chmod - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - cp - </dt> - <dd><code><code class='datatype'>int</code> cp(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Copies the file <code>from</code> to the new position <code>to</code>. If there is - no system function for cp, a new file will be created and the - old one copied manually in chunks of <code>DATA_CHUNK_SIZE</code> bytes. - This function can also copy directories recursively. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>0 on error, 1 on success - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function keeps file and directory mode bits, unlike in Pike - 7.6 and earlier. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - exist - </dt> - <dd><code><code class='datatype'>int</code> exist(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check if a <code>path</code> exists. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns true if the given path exists (is a directory or file), - otherwise false. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>May fail with eg <code>errno()</code> <tt>EFBIG</tt> if the file exists, - but the filesystem doesn't support the file size. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>is_dir()</code>, <code>is_file()</code>, <code>is_link()</code>, <code>file_stat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - file_equal - </dt> - <dd><code><code class='datatype'>int</code> file_equal(<code class='datatype'>string</code> <code class='argument'>file_1</code>, <code class='datatype'>string</code> <code class='argument'>file_2</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns nonzero if the given paths are files with identical - content, returns zero otherwise. Zero is also returned for any - sort of I/O error. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - file_size - </dt> - <dd><code><code class='datatype'>int</code> file_size(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Give the size of a file. Size -1 indicates that the file either - does not exist, or that it is not readable by you. Size -2 - indicates that it is a directory, -3 that it is a symlink and -4 - that it is a device. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>file_stat()</code>, <code>write_file()</code>, <code>read_bytes()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - _Stdio - </dt> - <dd><code>inherit _Stdio : _Stdio</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - is_dir - </dt> - <dd><code><code class='datatype'>int</code> is_dir(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check if a <code>path</code> is a directory. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns true if the given path is a directory, otherwise false. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>exist()</code>, <code>is_file()</code>, <code>is_link()</code>, <code>file_stat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - is_file - </dt> - <dd><code><code class='datatype'>int</code> is_file(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check if a <code>path</code> is a file. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns true if the given path is a regular file, otherwise false. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>exist()</code>, <code>is_dir()</code>, <code>is_link()</code>, <code>file_stat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - is_link - </dt> - <dd><code><code class='datatype'>int</code> is_link(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Check if a <code>path</code> is a symbolic link. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns true if the given path is a symbolic link, otherwise false. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>exist()</code>, <code>is_dir()</code>, <code>is_file()</code>, <code>file_stat()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - mkdirhier - </dt> - <dd><code><code class='datatype'>int</code> mkdirhier(<code class='datatype'>string</code> <code class='argument'>pathname</code>, <code class='datatype'>void</code>|<code class='datatype'>int</code> <code class='argument'>mode</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Creates zero or more directories to ensure that the given <code>pathname</code> is - a directory. - If a <code>mode</code> is given, it's used for the new directories after being &'ed - with the current umask (on OS'es that support this). - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns zero on failure and nonzero on success. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>mkdir()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - perror - </dt> - <dd><code><code class='datatype'>void</code> perror(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>This function prints a message to stderr along with a description - of what went wrong if available. It uses the system errno to find - out what went wrong, so it is only applicable to IO errors. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>werror()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_bytes - </dt> - <dd><code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code> - <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>)</code> - <code><code class='datatype'>string</code> read_bytes(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>len</code> number of bytes from a regular file <code>filename</code> - starting at byte <code>start</code>, and return it as a string. - If <code>len</code> is omitted, the rest of the file will be returned. - If <code>start</code> is also omitted, the entire file will be returned. - </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error on any I/O error except when the file doesn't - exist. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) if the file doesn't exist or if - <code>start</code> is beyond the end of it. - Returns a string with the requested data otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read_file</code>, <code>write_file()</code>, <code>append_file()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Typedef - read_callback_t - </dt> - <dd><code><code class='datatype'><code class='modifier'>local</code> typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>, <code class='datatype'>string</code>:<code class='datatype'>int</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'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>)|<code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.<code class='typedef'>read_callback_t</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The various read_callback signatures. - The string (or void) version is used when buffer mode (see - <code>set_buffer_mode</code>) has not been enabled for reading. - The <code>Buffer</code> version is used when a <code>Buffer</code> has been enabled - for reading. - In both cases the data is the newly arrived data, but in buffered - mode data you did not fully read in the last read callback is - kept in the buffer. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_file - </dt> - <dd><code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>)</code> - <code><code class='datatype'>string</code> read_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>int</code> <code class='argument'>start</code>, <code class='datatype'>int</code> <code class='argument'>len</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Read <code>len</code> lines from a regular file <code>filename</code> after skipping - <code>start</code> lines and return those lines as a string. If both - <code>start</code> and <code>len</code> are omitted the whole file is read. - </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error on any I/O error except when the file doesn't - exist. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns <code class='expr'>0</code> (zero) if the file doesn't exist or if - <code>start</code> is beyond the end of it. - Returns a string with the requested data otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>read_bytes()</code>, <code>write_file()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - recursive_mv - </dt> - <dd><code><code class='datatype'>int</code> recursive_mv(<code class='datatype'>string</code> <code class='argument'>from</code>, <code class='datatype'>string</code> <code class='argument'>to</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Copy a file or a directory tree by copying and then - removing. Mode bits are preserved in the copy. - It's not the fastest but works on every OS and - works well across different file systems. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns 0 on failure, nonzero otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>recursive_rm</code> <code>cp</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - recursive_rm - </dt> - <dd><code><code class='datatype'>int</code> recursive_rm(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Remove a file or a directory tree. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns 0 on failure, nonzero otherwise. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>rm</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - sendfile - </dt> - <dd><code><code class='datatype'>object</code> sendfile(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>headers</code>, <code class='object unresolved'>File</code> <code class='argument'>from</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>int</code> <code class='argument'>len</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>trailers</code>, <code class='object unresolved'>File</code> <code class='argument'>to</code>)</code> - <code><code class='datatype'>object</code> sendfile(<code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>headers</code>, <code class='object unresolved'>File</code> <code class='argument'>from</code>, <code class='datatype'>int</code> <code class='argument'>offset</code>, <code class='datatype'>int</code> <code class='argument'>len</code>, <code class='datatype'>array</code>(<code class='datatype'>string</code>) <code class='argument'>trailers</code>, <code class='object unresolved'>File</code> <code class='argument'>to</code>, <code class='datatype'>function</code>(<code class='datatype'>int</code>, <code class='datatype'>mixed</code> ... :<code class='datatype'>void</code>) <code class='argument'>callback</code>, <code class='datatype'>mixed</code> ... <code class='argument'>args</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Sends <code>headers</code> followed by <code>len</code> bytes starting at <code>offset</code> - from the file <code>from</code> followed by <code>trailers</code> to the file <code>to</code>. - When completed <code>callback</code> will be called with the total number of - bytes sent as the first argument, followed by <code>args</code>. - Any of <code>headers</code>, <code>from</code> and <code>trailers</code> may be left out - by setting them to <code class='expr'>0</code>. - Setting <code>offset</code> to <code class='expr'>-1</code> means send from the current position in - <code>from</code>. - Setting <code>len</code> to <code class='expr'>-1</code> means send until <code>from</code>'s end of file is - reached. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The sending is performed asynchronously, and may complete - both before and after the function returns. - For <code>callback</code> to be called, the backend must be active (ie - <code>main()</code> must have returned <code class='expr'>-1</code>, or <code>Pike.DefaultBackend</code> - get called in some other way). - In some cases, the backend must also be active for any sending to - be performed at all. - In Pike 7.4.496, Pike 7.6.120 and Pike 7.7 and later the backend - associated with <code>to</code> will be used rather than the default backend. - Note that you usually will want <code>from</code> to have the same backend as <code>to</code>. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>The low-level sending may be performed with blocking I/O calls, and - thus trigger the process being killed with <tt>SIGPIPE</tt> when the - peer closes the other end. Add a call to <code>signal()</code> to avoid this. - </dd> - <dt class='head--doc'>Bugs</dt> - <dd class='body--doc'>FIXME: Support for timeouts? - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stdio.File->set_nonblocking()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - simplify_path - </dt> - <dd><code><code class='datatype'>string</code> simplify_path(<code class='datatype'>string</code> <code class='argument'>path</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Returns a canonic representation of <code>path</code> (without /./, /../, // - and similar path segments). - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - stderr - </dt> - <dd><code><code class='object unresolved'>FILE</code> Stdio.stderr</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of <tt>FILE("stderr")</tt>, the standard error stream. Use this - when you want to output error messages. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>predef::werror()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - stdin - </dt> - <dd><code><code class='object unresolved'>FILE</code> Stdio.stdin</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of <tt>FILE("stdin")</tt>, the standard input stream. Use this - when you want to read anything from the standard input. - This example will read lines from standard input for as long as there - are more lines to read. Each line will then be written to stdout together - with the line number. We could use <code>Stdio.stdout.write()</code> instead - of just <code>write()</code>, since they are the same function. - </dd> - <dt class='head--doc'>Example</dt> - <dd class='example'><pre>int main() - { - int line; - while(string s=Stdio.stdin.gets()) - write("%5d: %s\n", line++, s); - } - </pre></dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Variable - stdout - </dt> - <dd><code><code class='object unresolved'>FILE</code> Stdio.stdout</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>An instance of <tt>FILE("stdout")</tt>, the standatd output stream. Use this - when you want to write anything to the standard output. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>predef::write()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - werror - </dt> - <dd><code><code class='datatype'>void</code> werror(<code class='datatype'>string</code> <code class='argument'>s</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Write a message to stderr. Stderr is normally the console, even if - the process output has been redirected to a file or pipe. - </dd> - <dt class='head--doc'>Note</dt> - <dd class='body--doc'>This function is identical to <code>predef::werror()</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>predef::werror()</code> - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Typedef - write_callback_t - </dt> - <dd><code><code class='datatype'><code class='modifier'>local</code> typedef</code> <code class='datatype'>function</code>(<code class='datatype'>mixed</code>|<code class='datatype'>void</code>:<code class='datatype'>int</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'>Buffer</code>:<code class='datatype'>int</code>|<code class='datatype'>void</code>) Stdio.<code class='typedef'>write_callback_t</code></code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The various write_callback signatures. - The void version is used when buffer mode (see - <code>set_buffer_mode</code>) has not been enabled for writing. - The <code>Buffer</code> version is used when a <code>Buffer</code> has been enabled - for writing, add data to that buffer to send it. - </dd></dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write_file - </dt> - <dd><code><code class='datatype'>int</code> write_file(<code class='datatype'>string</code> <code class='argument'>filename</code>, <code class='datatype'>string</code> <code class='argument'>str</code>, <code class='datatype'>int</code>|<code class='datatype'>void</code> <code class='argument'>access</code>)</code></dd> - - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>Write the string <code>str</code> onto the file <code>filename</code>. Any existing - data in the file is overwritten. - For a description of <code>access</code>, see <code>Stdio.File()->open()</code>. - </dd> - <dt class='head--doc'>Throws</dt> - <dd class='body--doc'>Throws an error if <code>filename</code> couldn't be opened for writing. - </dd> - <dt class='head--doc'>Returns</dt> - <dd class='body--doc'>Returns the number of bytes written, i.e. <code class='expr'>sizeof(str)</code>. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>append_file()</code>, <code>read_bytes()</code>, <code>Stdio.File()->open()</code> - </dd></dl> - <dl><dt><h2 class='header'>Class Stdio.BlockFile</h2> + </dt><dd><dl><dt><h2 class='header'>Class Stdio.FakeFile</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The Stdio.BlockFile API. - This class exists purely for typing reasons. - Use in types in place of <code>Stdio.File</code> where only blocking - I/O is done with the object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stream</code>, <code>NonblockingStream</code>, <code>File</code>, <code>FILE</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Stream - </dt> - <dd><code>inherit Stream : Stream</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - seek - </dt> - <dd><code><code class='datatype'>int</code> seek(<code class='datatype'>int</code> <code class='argument'>to</code>, <code class='datatype'>string</code>|<code class='datatype'>void</code> <code class='argument'>how</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - tell - </dt> - <dd><code><code class='datatype'>int</code> tell()</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Stdio.FakeFile</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> + <dd class='body--doc'>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. </dd></dl>
4773: <dt class='head--doc'>See also</dt> <dd class='body--doc'><code>tcgetattr()</code>, <code>tcsetattr()</code> </dd></dl> - </dd></dl><dl><dt><h2 class='header'>Class Stdio.NonblockingStream</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The Stdio.NonblockingStream API. - This class exists purely for typing reasons. - Use in types in place of <code>Stdio.File</code> where nonblocking and/or - blocking stream-oriented I/O is done with the object. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>Stream</code>, <code>BlockFile</code>, <code>File</code>, <code>FILE</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Inherit - Stream - </dt> - <dd><code>inherit Stream : Stream</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_blocking - </dt> - <dd><code><code class='datatype'>void</code> set_blocking()</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_read_callback - Method - set_write_callback - Method - set_close_callback - Method - set_fs_event_callback - </dt> - <dd><code><code class='object unresolved'>NonblockingStream</code> set_read_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code>)</code> - <code><code class='object unresolved'>NonblockingStream</code> set_write_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code>)</code> - <code><code class='object unresolved'>NonblockingStream</code> set_close_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code>)</code> - <code><code class='object unresolved'>NonblockingStream</code> set_fs_event_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</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>)</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 void'>void</code>) <code class='argument'>a</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>b</code>, <code class='datatype'>function</code>(:<code class='datatype void'>void</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>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - set_read_oob_callback - Method - set_write_oob_callback - </dt> - <dd><code><code class='modifier'>optional</code> <code class='object unresolved'>NonblockingStream</code> set_read_oob_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code>)</code> - <code><code class='modifier'>optional</code> <code class='object unresolved'>NonblockingStream</code> set_write_oob_callback(<code class='datatype'>function</code>(:<code class='datatype void'>void</code>) <code class='argument'>f</code>, <code class='datatype'>mixed</code> ... <code class='argument'>rest</code>)</code></dd> - </dl> - </dd></dl><dl><dt><h2 class='header'>Class Stdio.Stream</h2> - </dt><dd><dl class='group--doc'> - <dt class='head--doc'>Description</dt> - <dd class='body--doc'>The Stdio.Stream API. - This class exists purely for typing reasons. - Use in types in place of <code>Stdio.File</code> where only blocking - stream-oriented I/O is done with the object. - This class lists the minimum functionality guaranteed to exist in - all Stream objects. - </dd> - <dt class='head--doc'>See also</dt> - <dd class='body--doc'><code>NonblockingStream</code>, <code>BlockFile</code>, <code>File</code>, <code>FILE</code> - </dd></dl> - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - close - </dt> - <dd><code><code class='datatype'>void</code> close()</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read - </dt> - <dd><code><code class='datatype'>string</code> read(<code class='datatype'>int</code> <code class='argument'>nbytes</code>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - read_oob - Method - write_oob - Method - tcgetattr - Method - tcsetattr - </dt> - <dd><code><code class='modifier'>optional</code> <code class='datatype'>string</code> read_oob(<code class='datatype'>int</code> <code class='argument'>nbytes</code>)</code> - <code><code class='modifier'>optional</code> <code class='datatype'>int</code> write_oob(<code class='datatype'>string</code> <code class='argument'>data</code>)</code> - <code><code class='modifier'>optional</code> <code class='datatype'>mapping</code>(<code class='datatype'>string</code>:<code class='datatype'>int</code>) tcgetattr()</code> - <code><code class='modifier'>optional</code> <code class='datatype'>int</code> tcsetattr(<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>)</code></dd> - </dl> - - - <hr /> - <dl class='group--doc'> - <dt class='head--type'>Method - write - </dt> - <dd><code><code class='datatype'>int</code> write(<code class='datatype'>string</code> <code class='argument'>data</code>)</code></dd> - </dl> + </dd></dl><dl><dt><h2 class='header'>Class Stdio.sendfile</h2> </dt><dd><dl class='group--doc'> <dt class='head--doc'>Description</dt>

autodoc.git/ traditional_manual/ chapter_9.html

2020-05-23

2020-05-23 13:10:51 by Marcus Comstedt <marcus@mc.pp.se>