1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id="function.ftp-nb-put" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_nb_put</refname>
<refpurpose>Stores a file on the FTP server (non-blocking)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>ftp_nb_put</function> stores a local file on the FTP server.
</para>
<para>
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>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp_stream</parameter></term>
<listitem>
<para>
The link identifier of the FTP connection.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remote_file</parameter></term>
<listitem>
<para>
The remote file path.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local_file</parameter></term>
<listitem>
<para>
The local file path.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
The transfer mode. Must be either <constant>FTP_ASCII</constant> or
<constant>FTP_BINARY</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>startpos</parameter></term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <constant>FTP_FAILED</constant> or <constant>FTP_FINISHED</constant>
or <constant>FTP_MOREDATA</constant>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<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>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_nb_fput</function></member>
<member><function>ftp_nb_continue</function></member>
<member><function>ftp_put</function></member>
<member><function>ftp_fput</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
-->
|