php-doc-en/reference/ftp/functions/ftp-nb-put.xml
2003-12-15 16:55:22 +00:00

112 lines
3.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.7 $ -->
<refentry id="function.ftp-nb-put">
<refnamediv>
<refname>ftp_nb_put</refname>
<refpurpose>Stores a file on the FTP server (non-blocking)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>ftp_nb_put</methodname>
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
<methodparam><type>string</type><parameter>local_file</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>startpos</parameter></methodparam>
</methodsynopsis>
<para>
<function>ftp_nb_put</function> stores <parameter>local_file</parameter>
on the FTP server, as <parameter>remote_file</parameter>. The transfer
<parameter>mode</parameter> specified must be either
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>.
The difference between this function and the <function>ftp_put</function>
is that this function uploads the file asynchronously, so your program can
perform other operations while the file is being uploaded.
</para>
<para>
Returns <constant>FTP_FAILED</constant>, <constant>FTP_FINISHED</constant>, or
<constant>FTP_MOREDATA</constant>.
</para>
<para>
<example>
<title><function>ftp_nb_put</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Initiate the Upload
$ret = ftp_nb_put($my_connection, "test.remote", "test.local", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue uploading...
$ret = ftp_nb_continue($my_connection);
}
if ($ret != FTP_FINISHED) {
echo "There was an error uploading the file...";
exit(1);
}
?>
]]>
</programlisting>
</example>
<example>
<title>Resuming an upload with <function>ftp_nb_put</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Initiate
$ret = ftp_nb_put($my_connection, "test.remote", "test.local",
FTP_BINARY, ftp_size("test.remote"));
// OR: $ret = ftp_nb_put($my_connection, "test.remote", "test.local",
// FTP_BINARY, FTP_AUTORESUME);
while ($ret == FTP_MOREDATA) {
// Do whatever you want
echo ".";
// Continue uploading...
$ret = ftp_nb_continue($my_connection);
}
if ($ret != FTP_FINISHED) {
echo "There was an error uploading the file...";
exit(1);
}
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>ftp_nb_fput</function>,
<function>ftp_nb_continue</function>, <function>ftp_put</function>,
and <function>ftp_fput</function>.
</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:"../../../../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
-->