ftp_nb_get
Retrieves a file from the FTP server and writes it to a local file (non-blocking)
Description
intfalse ftp_nb_get(
FTP\Connection $ftp,
string $local_filename,
string $remote_filename,
int $mode = FTP_BINARY,
int $offset = 0
)
The difference between this function and ftp_get is that
this function retrieves the file asynchronously, so your program can perform
other operations while the file is being downloaded.
Parameters
-
ftp
-
An FTP\Connection instance.
-
local_filename
-
The local file path (will be overwritten if the file already exists).
-
remote_filename
-
The remote file path.
-
mode
-
The transfer mode. Must be either FTP_ASCII or
FTP_BINARY.
-
offset
-
The position in the remote file to start downloading from.
Return Values
Returns FTP_FAILED or FTP_FINISHED
or FTP_MOREDATA, or false on failure to open the local file.
Examples
Example #1 ftp_nb_get example
<?php
// Initiate the download
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue downloading...
$ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
echo "There was an error downloading the file...";
exit(1);
}
?>
Example #2 Resuming a download with ftp_nb_get
<?php
// Initiate
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY,
filesize("test"));
// OR: $ret = ftp_nb_get($ftp, "test", "README",
// FTP_BINARY, FTP_AUTORESUME);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue downloading...
$ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
echo "There was an error downloading the file...";
exit(1);
}
?>
Example #3
Resuming a download at position 100 to a new
file with ftp_nb_get
<?php
// Disable Autoseek
ftp_set_option($ftp, FTP_AUTOSEEK, false);
// Initiate
$ret = ftp_nb_get($ftp, "newfile", "README", FTP_BINARY, 100);
while ($ret == FTP_MOREDATA) {
/* ... */
// Continue downloading...
$ret = ftp_nb_continue($ftp);
}
?>
In the example above, newfile is 100 bytes smaller
than README on the FTP server because we started
reading at offset 100. If we didn't disable
FTP_AUTOSEEK, the first 100 bytes of
newfile would be '\0'.
See Also
- ftp_nb_fget
- ftp_nb_continue
- ftp_fget
- ftp_get