<!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>Retrieves a file from the FTP server and writes it to a local file (non-blocking)</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-fput.html">ftp_nb_fput</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nb-put.html">ftp_nb_put</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ftp-nb-get" class="refentry">
<div class="refnamediv">
<h1 class="refname">ftp_nb_get</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5)</p><p class="refpurpose"><span class="refname">ftp_nb_get</span> — <span class="dc-title">Retrieves a file from the FTP server and writes it to a local file (non-blocking)</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ftp-nb-get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>ftp_nb_get</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ftp_stream</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$local_file</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$remote_file</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$mode</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$resumepos</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>ftp_nb_get()</strong></span> retrieves a remote file from the FTP server,
and saves it into a local file.
</p>
<p class="para">
The difference between this function and <span class="function"><a href="function.ftp-get.html" class="function">ftp_get()</a></span> is that
this function retrieves the file asynchronously, so your program can perform
other operations while the file is being downloaded.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ftp-nb-get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">ftp_stream</code></em></span>
<dd>
<p class="para">
The link identifier of the FTP connection.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">local_file</code></em></span>
<dd>
<p class="para">
The local file path (will be overwritten if the file already exists).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">remote_file</code></em></span>
<dd>
<p class="para">
The remote file path.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">mode</code></em></span>
<dd>
<p class="para">
The transfer mode. Must be either <strong><code>FTP_ASCII</code></strong> or
<strong><code>FTP_BINARY</code></strong>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">resumepos</code></em></span>
<dd>
<p class="para">The position in the remote file to start downloading from.</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ftp-nb-get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>FTP_FAILED</code></strong> or <strong><code>FTP_FINISHED</code></strong>
or <strong><code>FTP_MOREDATA</code></strong>.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ftp-nb-get-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4292">
<p><strong>Example #1 <span class="function"><strong>ftp_nb_get()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// Initate the download<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"README"</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /> <br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue downloading...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error downloading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-4293">
<p><strong>Example #2 Resuming a download with <span class="function"><strong>ftp_nb_get()</strong></span></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// Initate <br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #DD0000">"test"</span><span style="color: #007700">, </span><span style="color: #DD0000">"README"</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">, <br /> </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #DD0000">"test"</span><span style="color: #007700">));<br /></span><span style="color: #FF8000">// OR: $ret = ftp_nb_get($my_connection, "test", "README", <br />// FTP_BINARY, FTP_AUTORESUME);<br /></span><span style="color: #007700">while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /> <br /> </span><span style="color: #FF8000">// Do whatever you want<br /> </span><span style="color: #007700">echo </span><span style="color: #DD0000">"."</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// Continue downloading...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">);<br />}<br />if (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">!= </span><span style="color: #0000BB">FTP_FINISHED</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"There was an error downloading the file..."</span><span style="color: #007700">;<br /> exit(</span><span style="color: #0000BB">1</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-4294">
<p><strong>Example #3
Resuming a download at position 100 to a new
file with <span class="function"><strong>ftp_nb_get()</strong></span>
</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #FF8000">// Disable Autoseek<br /></span><span style="color: #0000BB">ftp_set_option</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_AUTOSEEK</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Initiate<br /></span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_get</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">, </span><span style="color: #DD0000">"newfile"</span><span style="color: #007700">, </span><span style="color: #DD0000">"README"</span><span style="color: #007700">, </span><span style="color: #0000BB">FTP_BINARY</span><span style="color: #007700">, </span><span style="color: #0000BB">100</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">$ret </span><span style="color: #007700">== </span><span style="color: #0000BB">FTP_MOREDATA</span><span style="color: #007700">) {<br /><br /> </span><span style="color: #FF8000">/* ... */<br /> <br /> // Continue downloading...<br /> </span><span style="color: #0000BB">$ret </span><span style="color: #007700">= </span><span style="color: #0000BB">ftp_nb_continue</span><span style="color: #007700">(</span><span style="color: #0000BB">$my_connection</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
In the example above, <var class="filename">newfile</var> is 100 bytes smaller
than <var class="filename">README</var> on the FTP server because we started
reading at offset 100. If we didn't disable
<strong><code>FTP_AUTOSEEK</code></strong>, the first 100 bytes of
<var class="filename">newfile</var> would be <em>'\0'</em>.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ftp-nb-get-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ftp-nb-fget.html" class="function" rel="rdfs-seeAlso">ftp_nb_fget()</a> - Retrieves a file from the FTP server and writes it to an open file (non-blocking)</span></li>
<li class="member"> <span class="function"><a href="function.ftp-nb-continue.html" class="function" rel="rdfs-seeAlso">ftp_nb_continue()</a> - Continues retrieving/sending a file (non-blocking)</span></li>
<li class="member"> <span class="function"><a href="function.ftp-fget.html" class="function" rel="rdfs-seeAlso">ftp_fget()</a> - Downloads a file from the FTP server and saves to an open file</span></li>
<li class="member"> <span class="function"><a href="function.ftp-get.html" class="function" rel="rdfs-seeAlso">ftp_get()</a> - Downloads a file from the FTP server</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ftp-nb-fput.html">ftp_nb_fput</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ftp-nb-put.html">ftp_nb_put</a></div>
<div class="up"><a href="ref.ftp.html">FTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
