ftp-nb-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ce3f60dc2f3ef847d44a08d84506464acff45bb6 Maintainer: Avenger Status: ready -->
<!-- CREDITS: mowangjuanzi, Luffy -->
<refentry xml:id="function.ftp-nb-get" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_nb_get</refname>
  <refpurpose>从 FTP 服务器上获取文件并写入本地文件（non-blocking）</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>int</type><type>false</type></type><methodname>ftp_nb_get</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>string</type><parameter>local_filename</parameter></methodparam>
   <methodparam><type>string</type><parameter>remote_filename</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>FTP_BINARY</constant></initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>ftp_nb_get</function> 在 FTP 服务器上获取指定的远程文件，并保存到本地。
  </para>
  <para>
    和 <function>ftp_get</function> 不同之处，在于此函数是通过异步的方式来获取文件，这意味着，你的程序可以在下载文件的同时，同步进行其它操作。
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp</parameter></term>
     <listitem>
       &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>local_filename</parameter></term>
     <listitem>
      <para>
        保存到的本地文件路径（如果文件已存在会被覆盖）。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>remote_filename</parameter></term>
     <listitem>
      <para>
        远程文件路径。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
        指定传输模式。必须是 <constant>FTP_ASCII</constant> 或 <constant>FTP_BINARY</constant>。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>开始下载文件的起始位置。</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   返回 <constant>FTP_FAILED</constant> 或 <constant>FTP_FINISHED</constant>
   或 <constant>FTP_MOREDATA</constant>，或者在无法打开本地文件的情况下返回 &false; 
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &ftp.changelog.ftp-param;
     <row>
      <entry>7.3.0</entry>
      <entry>
       <parameter>mode</parameter> 参数变为可选，之前是强制性的。
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ftp_nb_get</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php

// 初始化
$ret = ftp_nb_get($ftp, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
   
   // 可以同步干其它事
   echo ".";

   // 继续下载...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "下载文件出错...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>通过 <function>ftp_nb_get</function> 恢复下载一个文件</title>
    <programlisting role="php">
<![CDATA[
<?php

// 初始化 
$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) {
   
   // 做你爱做的事
   echo ".";

   // 继续下载Ing...
   $ret = ftp_nb_continue($ftp);
}
if ($ret != FTP_FINISHED) {
   echo "下载文件出错...";
   exit(1);
}
?>
]]>
    </programlisting>
   </example>
   <example>
    <title>
      使用 <function>ftp_nb_get</function> 从指定位置恢复下载文件
    </title>
    <programlisting role="php">
<![CDATA[
<?php

// 禁止 Autoseek
ftp_set_option($ftp, FTP_AUTOSEEK, false);

// 初始化
$ret = ftp_nb_get($ftp, "newfile", "README", FTP_BINARY, 100);
while ($ret == FTP_MOREDATA) {

   /* ... */
   
   // 继续下载...
   $ret = ftp_nb_continue($ftp);
}
?>
]]>
    </programlisting>
   </example>
  </para>
  <para>
    在上面的示例中，<filename>newfile</filename> 会比 FTP 服务器上的
    <filename>README</filename> 文件小 100 bytes，因为开始下载的时候设置了偏移量为 100。如果我们不禁止
    <constant>FTP_AUTOSEEK</constant>，则 <filename>newfile</filename> 文件前面的 100 bytes 会变成
    <literal>'\0'</literal>。
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_nb_fget</function></member>
    <member><function>ftp_nb_continue</function></member>
    <member><function>ftp_fget</function></member>
    <member><function>ftp_get</function></member>
   </simplelist>
  </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
-->