<!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>Sync a file segment with disk</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.eio-symlink.html">eio_symlink</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-sync.html">eio_sync</a></div> <div class="up"><a href="ref.eio.html">Eio Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.eio-sync-file-range" class="refentry"> <div class="refnamediv"> <h1 class="refname">eio_sync_file_range</h1> <p class="verinfo">(PECL eio >= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_sync_file_range</span> — <span class="dc-title">Sync a file segment with disk</span></p> </div> <div class="refsect1 description" id="refsect1-function.eio-sync-file-range-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">resource</span> <span class="methodname"><strong>eio_sync_file_range</strong></span> ( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$fd</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$offset</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$nbytes</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$pri</code><span class="initializer"> = EIO_PRI_DEFAULT</span></span> [, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code><span class="initializer"> = NULL</span></span> [, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span> ]]] )</div> <p class="para rdfs-comment"> <span class="function"><strong>eio_sync_file_range()</strong></span> permits fine control when synchronizing the open file referred to by the file descriptor <em><code class="parameter">fd</code></em> with disk. </p> </div> <div class="refsect1 parameters" id="refsect1-function.eio-sync-file-range-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <span class="term"><em><code class="parameter">fd</code></em></span> <dd> <p class="para"> File descriptor </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">offset</code></em></span> <dd> <p class="para"> The starting byte of the file range to be synchronized </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">nbytes</code></em></span> <dd> <p class="para"> Specifies the length of the range to be synchronized, in bytes. If <em><code class="parameter">nbytes</code></em> is zero, then all bytes from <em><code class="parameter">offset</code></em> through to the end of file are synchronized. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">flags</code></em></span> <dd> <p class="para"> A bit-mask. Can include any of the following values: <strong><code>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</code></strong>, <strong><code>EIO_SYNC_FILE_RANGE_WRITE</code></strong>, <strong><code>EIO_SYNC_FILE_RANGE_WAIT_AFTER</code></strong>. These flags have the same meaning as their <em class="emphasis">SYNC_FILE_RANGE_*</em> counterparts(see <em>SYNC_FILE_RANGE(2)</em> man page). </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">pri</code></em></span> <dd> <p class="para">The request priority: <strong><code>EIO_PRI_DEFAULT</code></strong>, <strong><code>EIO_PRI_MIN</code></strong>, <strong><code>EIO_PRI_MAX</code></strong>, or <strong><code>NULL</code></strong>. If <strong><code>NULL</code></strong> passed, <em><code class="parameter">pri</code></em> internally is set to <strong><code>EIO_PRI_DEFAULT</code></strong>. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">callback</code></em></span> <dd> <p class="para"> <em><code class="parameter">callback</code></em> function is called when the request is done. It should match the following prototype: <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"> void callback(mixed $data, int $result[, resource $req]);</span> </code></div></div> <dl> <dt> <span class="term"><em><code class="parameter">data</code></em></span> <dd> <p class="para">is custom data passed to the request.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">result</code></em></span> <dd> <p class="para">request-specific result value; basically, the value returned by corresponding system call.</p></dd> </dt> <dt> <span class="term"><em><code class="parameter">req</code></em></span> <dd> <p class="para">is optional request resource which can be used with functions like <span class="function"><a href="function.eio-get-last-error.html" class="function">eio_get_last_error()</a></span></p></dd> </dt> </dl> </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">data</code></em></span> <dd> <p class="para"> Arbitrary variable passed to <em><code class="parameter">callback</code></em>. </p> </dd> </dt> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-function.eio-sync-file-range-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> <span class="function"><strong>eio_sync_file_range()</strong></span> returns request resource on success or <strong><code>FALSE</code></strong> on error. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.eio-symlink.html">eio_symlink</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.eio-sync.html">eio_sync</a></div> <div class="up"><a href="ref.eio.html">Eio Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>