eio-sync-file-range.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.eio-sync-file-range" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>eio_sync_file_range</refname>
  <refpurpose>
   Синхронизирует сегмент файла с данными файла на внешнем хранилище
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>eio_sync_file_range</methodname>
   <methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>nbytes</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam
   choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
   <methodparam
   choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
   <methodparam
   choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>eio_sync_file_range</function> осуществляет необходимые проверки
   и действия при синхронизации открытого файла <parameter>fd</parameter>
   с дисковой подсистемой.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>fd</parameter></term>
    <listitem>
     <para>
      Файловый описатель
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>offset</parameter></term>
    <listitem>
     <para>
      Начальная позиция, с которой будет проводиться синхронизация
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>nbytes</parameter></term>
    <listitem>
     <para>
      Задаёт длину сегмента файла в байтах, которую необходимо синхронизировать.
      Если <parameter>nbytes</parameter> равно нулю, будут синхронизированы все
      данные от <parameter>offset</parameter> до конца файла.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      Битовая маска. Может включать комбинацию из следующих значений:
      <constant>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</constant>,
      <constant>EIO_SYNC_FILE_RANGE_WRITE</constant>,
      <constant>EIO_SYNC_FILE_RANGE_WAIT_AFTER</constant>. Эти флаги имеют то же
      предназначение, что и аналогичные <emphasis>SYNC_FILE_RANGE_*</emphasis>
      константы (смотрите страницу руководства <literal>SYNC_FILE_RANGE(2)</literal>).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pri</parameter></term>
    <listitem>
    &eio.request.pri.values;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     &eio.callback.proto;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
      Данные, которые необходимо передать функции <parameter>callback</parameter>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>eio_sync_file_range</function> возвращает ресурс запроса в случае успешного выполнения&return.falseforfailure;.
  </para>
 </refsect1>

</refentry>
<!-- 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
-->