<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Predefined Constants</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eio.resources.html">Resource Types</a></div> <div class="next" style="text-align: right; float: right;"><a href="eio.examples.html">Examples</a></div> <div class="up"><a href="book.eio.html">Eio</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="eio.constants" class="appendix"> <h1>Predefined Constants</h1> <p class="simpara"> The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime. </p> <p class="para">Request priority constants: <dl> <dt id="constant.eio-pri-min"> <span class="term"> <strong><code>EIO_PRI_MIN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Request minimal prioriry </span> </dd> </dt> <dt id="constant.eio-pri-default"> <span class="term"> <strong><code>EIO_PRI_DEFAULT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Request default prioriry </span> </dd> </dt> <dt id="constant.eio-pri-max"> <span class="term"> <strong><code>EIO_PRI_MAX</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Request maximal prioriry </span> </dd> </dt> </dl> </p> <p class="para"> <span class="function"><a href="function.eio-seek.html" class="function">eio_seek()</a></span> <em><code class="parameter">whence</code></em> argument: <dl> <dt id="constant.eio-seek-set"> <span class="term"> <strong><code>EIO_SEEK_SET</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The offset is set to specified number of bytes(<em><code class="parameter">offset</code></em>). </span> </dd> </dt> <dt id="constant.eio-seek-cur"> <span class="term"> <strong><code>EIO_SEEK_CUR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The offset is set to its current location plus <em><code class="parameter">offset</code></em> bytes. </span> </dd> </dt> <dt id="constant.eio-seek-end"> <span class="term"> <strong><code>EIO_SEEK_END</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> The offset is set to the size of the file plus <em><code class="parameter">offset</code></em> bytes. </span> </dd> </dt> </dl> </p> <p class="para"> Flags used with <span class="function"><a href="function.eio-readdir.html" class="function">eio_readdir()</a></span>: <dl> <dt id="constant.eio-readdir-dents"> <span class="term"> <strong><code>EIO_READDIR_DENTS</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> <span class="function"><a href="function.eio-readdir.html" class="function">eio_readdir()</a></span> flag. If specified, the result argument of the callback becomes an array with the following keys: <em>'names'</em> - array of directory names <em>'dents'</em> - array of <em>struct eio_dirent</em>-like arrays having the following keys each: <em>'name'</em> - the directory name; <em>'type'</em> - one of <em class="emphasis">EIO_DT_*</em> constants; <em>'inode'</em> - the inode number, if available, otherwise unspecified; </span> </dd> </dt> <dt id="constant.eio-readdir-dirs-first"> <span class="term"> <strong><code>EIO_READDIR_DIRS_FIRST</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> When this flag is specified, the names will be returned in an order where likely directories come first, in optimal stat order. </span> </dd> </dt> <dt id="constant.eio-readdir-stat-order"> <span class="term"> <strong><code>EIO_READDIR_STAT_ORDER</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> When this flag is specified, then the names will be returned in an order suitable for <em>stat</em>'ing each one. When planning to <span class="function"><a href="function.stat.html" class="function">stat()</a></span> all files in the given directory, the returned order will likely be fastest. </span> </dd> </dt> <dt id="constant.eio-readdir-found-unknown"> <span class="term"> <strong><code>EIO_READDIR_FOUND_UNKNOWN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-dt-unknown"> <span class="term"> <strong><code>EIO_DT_UNKNOWN</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Unknown node type(very common). Further <span class="function"><a href="function.stat.html" class="function">stat()</a></span> needed. </span> </dd> </dt> <dt id="constant.eio-dt-fifo"> <span class="term"> <strong><code>EIO_DT_FIFO</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> FIFO node type </span> </dd> </dt> <dt id="constant.eio-dt-chr"> <span class="term"> <strong><code>EIO_DT_CHR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Node type </span> </dd> </dt> <dt id="constant.eio-dt-mpc"> <span class="term"> <strong><code>EIO_DT_MPC</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Multiplexed char device (v7+coherent) node type </span> </dd> </dt> <dt id="constant.eio-dt-dir"> <span class="term"> <strong><code>EIO_DT_DIR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Directory node type </span> </dd> </dt> <dt id="constant.eio-dt-nam"> <span class="term"> <strong><code>EIO_DT_NAM</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Xenix special named file node type </span> </dd> </dt> <dt id="constant.eio-dt-blk"> <span class="term"> <strong><code>EIO_DT_BLK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Node type </span> </dd> </dt> <dt id="constant.eio-dt-mpb"> <span class="term"> <strong><code>EIO_DT_MPB</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Multiplexed block device (v7+coherent) </span> </dd> </dt> <dt id="constant.eio-dt-reg"> <span class="term"> <strong><code>EIO_DT_REG</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Node type </span> </dd> </dt> <dt id="constant.eio-dt-nwk"> <span class="term"> <strong><code>EIO_DT_NWK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-dt-cmp"> <span class="term"> <strong><code>EIO_DT_CMP</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> HP-UX network special node type </span> </dd> </dt> <dt id="constant.eio-dt-lnk"> <span class="term"> <strong><code>EIO_DT_LNK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Link node type </span> </dd> </dt> <dt id="constant.eio-dt-sock"> <span class="term"> <strong><code>EIO_DT_SOCK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Socket node type </span> </dd> </dt> <dt id="constant.eio-dt-door"> <span class="term"> <strong><code>EIO_DT_DOOR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Solaris door node type </span> </dd> </dt> <dt id="constant.eio-dt-wht"> <span class="term"> <strong><code>EIO_DT_WHT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Node type </span> </dd> </dt> <dt id="constant.eio-dt-max"> <span class="term"> <strong><code>EIO_DT_MAX</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> Highest node type value </span> </dd> </dt> </dl> </p> <p class="para"> Access modes for <span class="function"><a href="function.eio-open.html" class="function">eio_open()</a></span> <em><code class="parameter">flags</code></em> argument: <dl> <dt id="constant.eio-o-rdonly"> <span class="term"> <strong><code>EIO_O_RDONLY</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-wronly"> <span class="term"> <strong><code>EIO_O_WRONLY</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-rdwr"> <span class="term"> <strong><code>EIO_O_RDWR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-nonblock"> <span class="term"> <strong><code>EIO_O_NONBLOCK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-append"> <span class="term"> <strong><code>EIO_O_APPEND</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-creat"> <span class="term"> <strong><code>EIO_O_CREAT</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-trunc"> <span class="term"> <strong><code>EIO_O_TRUNC</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-excl"> <span class="term"> <strong><code>EIO_O_EXCL</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-o-fsync"> <span class="term"> <strong><code>EIO_O_FSYNC</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> <p class="para"> <em><code class="parameter">mode</code></em> argument flags for <span class="function"><a href="function.eio-open.html" class="function">eio_open()</a></span>: <dl> <dt id="constant.eio-s-irusr"> <span class="term"> <strong><code>EIO_S_IRUSR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-iwusr"> <span class="term"> <strong><code>EIO_S_IWUSR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ixusr"> <span class="term"> <strong><code>EIO_S_IXUSR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-irgrp"> <span class="term"> <strong><code>EIO_S_IRGRP</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-iwgrp"> <span class="term"> <strong><code>EIO_S_IWGRP</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ixgrp"> <span class="term"> <strong><code>EIO_S_IXGRP</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-iroth"> <span class="term"> <strong><code>EIO_S_IROTH</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-iwoth"> <span class="term"> <strong><code>EIO_S_IWOTH</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ixoth"> <span class="term"> <strong><code>EIO_S_IXOTH</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ifreg"> <span class="term"> <strong><code>EIO_S_IFREG</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ifchr"> <span class="term"> <strong><code>EIO_S_IFCHR</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ifblk"> <span class="term"> <strong><code>EIO_S_IFBLK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ififo"> <span class="term"> <strong><code>EIO_S_IFIFO</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-s-ifsock"> <span class="term"> <strong><code>EIO_S_IFSOCK</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> <p class="para"> <span class="function"><a href="function.eio-sync-file-range.html" class="function">eio_sync_file_range()</a></span> flags: <dl> <dt id="constant.eio-sync-file-range-wait-before"> <span class="term"> <strong><code>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-sync-file-range-write"> <span class="term"> <strong><code>EIO_SYNC_FILE_RANGE_WRITE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> <dt id="constant.eio-sync-file-range-wait-after"> <span class="term"> <strong><code>EIO_SYNC_FILE_RANGE_WAIT_AFTER</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> <p class="para"> <span class="function"><a href="function.eio-fallocate.html" class="function">eio_fallocate()</a></span> flags: <dl> <dt id="constant.eio-falloc-fl-keep-size"> <span class="term"> <strong><code>EIO_FALLOC_FL_KEEP_SIZE</code></strong> (<span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>) </span> <dd> <span class="simpara"> </span> </dd> </dt> </dl> </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> <em class="emphasis">EIO_S_I*</em> constants have the same meaning as their <em class="emphasis">S_I*</em> POSIX counterparts. </p> </p></blockquote> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> <em class="emphasis">EIO_SYNC_FILE_*</em> constants have the same meaning as their <em class="emphasis">SYNC_FILE_**</em> counterparts. </p> </p></blockquote> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> <em class="emphasis">EIO_O_*</em> constants have the same meaning as their <em class="emphasis">O_*</em> POSIX counterparts. </p> </p></blockquote> </div> <hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="eio.resources.html">Resource Types</a></div> <div class="next" style="text-align: right; float: right;"><a href="eio.examples.html">Examples</a></div> <div class="up"><a href="book.eio.html">Eio</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>