php-doc-en/reference/eio/constants.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<appendix xml:id="eio.constants" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 &reftitle.constants;
 &extension.constants;

 <para>Request priority constants:
  <variablelist>
<!--{{{ EIO_PRI_* -->
   <varlistentry xml:id="constant.eio-pri-min">
    <term>
     <constant>EIO_PRI_MIN</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
      Request minimal prioriry
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-pri-default">
    <term>
     <constant>EIO_PRI_DEFAULT</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Request default prioriry
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-pri-max">
    <term>
     <constant>EIO_PRI_MAX</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Request maximal prioriry
     </simpara>
    </listitem>
   </varlistentry>
   <!--}}}-->
  </variablelist>
 </para>

 <para><function>eio_seek</function> <parameter>whence</parameter> argument:
  <variablelist>
   <varlistentry xml:id="constant.eio-seek-set">
    <term>
     <constant>EIO_SEEK_SET</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
      The offset is set to specified number of bytes(<parameter>offset</parameter>).
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-seek-cur">
    <term>
     <constant>EIO_SEEK_CUR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
      The offset is set to its current location plus <parameter>offset</parameter> bytes.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-seek-end">
    <term>
     <constant>EIO_SEEK_END</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
      The offset is set to the size of the file plus <parameter>offset</parameter> bytes.
     </simpara>
    </listitem>
   </varlistentry>
  </variablelist>
 </para>

 <para>
  Flags used with <function>eio_readdir</function>:
  <variablelist>

<!--{{{ EIO_READDIR_* -->
   <varlistentry xml:id="constant.eio-readdir-dents">
    <term>
     <constant>EIO_READDIR_DENTS</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     <function>eio_readdir</function> flag. If specified, the result argument of the callback
     becomes an array with the following keys:
     <literal>'names'</literal> - array of directory names
     <literal>'dents'</literal> - array of <literal>struct eio_dirent</literal>-like
     arrays having the following keys each:
     <literal>'name'</literal> - the directory name;
     <literal>'type'</literal> - one of <emphasis>EIO_DT_*</emphasis>
     constants;
     <literal>'inode'</literal> - the inode number, if available, otherwise
     unspecified;
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-readdir-dirs-first">
    <term>
     <constant>EIO_READDIR_DIRS_FIRST</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     When this flag is specified, the names will be returned in an order
     where likely directories come first, in optimal stat order.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-readdir-stat-order">
    <term>
     <constant>EIO_READDIR_STAT_ORDER</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     When this flag is specified, then the names will be returned in an order
     suitable for <literal>stat</literal>'ing each one. When planning to
     <function>stat</function> all files in the given directory, the
     returned order will likely be
     fastest.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-readdir-found-unknown">
    <term>
     <constant>EIO_READDIR_FOUND_UNKNOWN</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>

     </simpara>
    </listitem>
   </varlistentry>
<!--}}}-->

<!--{{{ EIO_DT_* -->
   <varlistentry xml:id="constant.eio-dt-unknown">
    <term>
     <constant>EIO_DT_UNKNOWN</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Unknown node type(very common). Further <function>stat</function> needed.
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-fifo">
    <term>
     <constant>EIO_DT_FIFO</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     FIFO node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-chr">
    <term>
     <constant>EIO_DT_CHR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-mpc">
    <term>
     <constant>EIO_DT_MPC</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Multiplexed char device (v7+coherent) node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-dir">
    <term>
     <constant>EIO_DT_DIR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Directory node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-nam">
    <term>
     <constant>EIO_DT_NAM</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Xenix special named file node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-blk">
    <term>
     <constant>EIO_DT_BLK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-mpb">
    <term>
     <constant>EIO_DT_MPB</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Multiplexed block device (v7+coherent)
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-reg">
    <term>
     <constant>EIO_DT_REG</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-nwk">
    <term>
     <constant>EIO_DT_NWK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-cmp">
    <term>
     <constant>EIO_DT_CMP</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     HP-UX network special node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-lnk">
    <term>
     <constant>EIO_DT_LNK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Link node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-sock">
    <term>
     <constant>EIO_DT_SOCK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Socket node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-door">
    <term>
     <constant>EIO_DT_DOOR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Solaris door node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-wht">
    <term>
     <constant>EIO_DT_WHT</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Node type
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-dt-max">
    <term>
     <constant>EIO_DT_MAX</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     Highest node type value
     </simpara>
    </listitem>
   </varlistentry>

<!--}}}-->

  </variablelist>
 </para>
 <para>
  Access modes for <function>eio_open</function> <parameter>flags</parameter>
  argument:
  <variablelist>

<!--{{{ EIO_O_*-->
   <varlistentry xml:id="constant.eio-o-rdonly">
    <term>
     <constant>EIO_O_RDONLY</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-wronly">
    <term>
     <constant>EIO_O_WRONLY</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-rdwr">
    <term>
     <constant>EIO_O_RDWR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-nonblock">
    <term>
     <constant>EIO_O_NONBLOCK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-append">
    <term>
     <constant>EIO_O_APPEND</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-creat">
    <term>
     <constant>EIO_O_CREAT</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-trunc">
    <term>
     <constant>EIO_O_TRUNC</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-excl">
    <term>
     <constant>EIO_O_EXCL</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-o-fsync">
    <term>
     <constant>EIO_O_FSYNC</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
<!--}}}-->

  </variablelist>
 </para>
 <para>
  <parameter>mode</parameter> argument flags for <function>eio_open</function>:
  <variablelist>

<!--{{{ EIO_S_I*-->
   <varlistentry xml:id="constant.eio-s-irusr">
    <term>
     <constant>EIO_S_IRUSR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-iwusr">
    <term>
     <constant>EIO_S_IWUSR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ixusr">
    <term>
     <constant>EIO_S_IXUSR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-irgrp">
    <term>
     <constant>EIO_S_IRGRP</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-iwgrp">
    <term>
     <constant>EIO_S_IWGRP</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ixgrp">
    <term>
     <constant>EIO_S_IXGRP</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-iroth">
    <term>
     <constant>EIO_S_IROTH</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-iwoth">
    <term>
     <constant>EIO_S_IWOTH</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ixoth">
    <term>
     <constant>EIO_S_IXOTH</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ifreg">
    <term>
     <constant>EIO_S_IFREG</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ifchr">
    <term>
     <constant>EIO_S_IFCHR</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ifblk">
    <term>
     <constant>EIO_S_IFBLK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ififo">
    <term>
     <constant>EIO_S_IFIFO</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-s-ifsock">
    <term>
     <constant>EIO_S_IFSOCK</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
<!--}}}-->


  </variablelist>
 </para>
 <para>
  <function>eio_sync_file_range</function> flags:
  <variablelist>

<!--{{{ EIO_SYNC_FILE_*-->
   <varlistentry xml:id="constant.eio-sync-file-range-wait-before">
    <term>
     <constant>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-sync-file-range-write">
    <term>
     <constant>EIO_SYNC_FILE_RANGE_WRITE</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
   <varlistentry xml:id="constant.eio-sync-file-range-wait-after">
    <term>
     <constant>EIO_SYNC_FILE_RANGE_WAIT_AFTER</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>
<!--}}}-->


  </variablelist>
 </para>
 <para>
  <function>eio_fallocate</function> flags:
  <variablelist>

   <varlistentry xml:id="constant.eio-falloc-fl-keep-size">
    <term>
     <constant>EIO_FALLOC_FL_KEEP_SIZE</constant>
     (<type>integer</type>)
    </term>
    <listitem>
     <simpara>
     </simpara>
    </listitem>
   </varlistentry>

  </variablelist>
 </para>

 <note xmlns="http://docbook.org/ns/docbook">
  <para>
   <emphasis>EIO_S_I*</emphasis> constants have the same meaning as their
   <emphasis>S_I*</emphasis> POSIX counterparts.
  </para>
 </note>

 <note xmlns="http://docbook.org/ns/docbook">
  <para>
   <emphasis>EIO_SYNC_FILE_*</emphasis> constants have the same meaning as their
   <emphasis>SYNC_FILE_**</emphasis> counterparts.
  </para>
 </note>

 <note xmlns="http://docbook.org/ns/docbook">
  <para>
   <emphasis>EIO_O_*</emphasis> constants have the same meaning as their
   <emphasis>O_*</emphasis> POSIX counterparts.
  </para>
 </note>
</appendix>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->