← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ocamlnet/trusty

« back to all changes in this revision

Viewing changes to doc/html-main/Ftp_client.ftp_client.html

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu
  • Date: 2011-09-02 14:12:33 UTC
  • mfrom: (18.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110902141233-zbj0ygxb92u6gy4z
Tags: 3.4-1
http://bugs.debian.org/637147
* New upstream release
  - add a new NetcgiRequire directive to ease dependency management
    (Closes: #637147)
  - remove patches that were applied upstream:
    + Added-missing-shebang-lines-in-example-shell-scripts
    + Try-also-ocamlc-for-POSIX-threads

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html-main/Ftp_client.ftp_client.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<link rel="stylesheet" href="style.css" type="text/css">
5
 
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6
 
<link rel="Start" href="index.html">
7
 
<link rel="previous" href="Ftp_client.mdtm_method.html">
8
 
<link rel="Up" href="Ftp_client.html">
9
 
<link title="Index of types" rel=Appendix href="index_types.html">
10
 
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
11
 
<link title="Index of values" rel=Appendix href="index_values.html">
12
 
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
13
 
<link title="Index of class methods" rel=Appendix href="index_methods.html">
14
 
<link title="Index of classes" rel=Appendix href="index_classes.html">
15
 
<link title="Index of class types" rel=Appendix href="index_class_types.html">
16
 
<link title="Index of modules" rel=Appendix href="index_modules.html">
17
 
<link title="Index of module types" rel=Appendix href="index_module_types.html">
18
 
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
19
 
<link title="Equeue" rel="Chapter" href="Equeue.html">
20
 
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
21
 
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
22
 
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
23
 
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
24
 
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
25
 
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
26
 
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
27
 
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
28
 
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
29
 
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
30
 
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
31
 
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
32
 
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
33
 
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
34
 
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
35
 
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
36
 
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
37
 
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
38
 
<link title="Http_client" rel="Chapter" href="Http_client.html">
39
 
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
40
 
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
41
 
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
42
 
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
43
 
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
44
 
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
45
 
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
46
 
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
47
 
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
48
 
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
49
 
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
50
 
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
51
 
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
52
 
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
53
 
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
54
 
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
55
 
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
56
 
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
57
 
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
58
 
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
59
 
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
60
 
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
61
 
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
62
 
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
63
 
<link title="Netshm" rel="Chapter" href="Netshm.html">
64
 
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
65
 
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
66
 
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
67
 
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
68
 
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
69
 
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
70
 
<link title="Netstream" rel="Chapter" href="Netstream.html">
71
 
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
72
 
<link title="Netmime" rel="Chapter" href="Netmime.html">
73
 
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
74
 
<link title="Neturl" rel="Chapter" href="Neturl.html">
75
 
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
76
 
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
77
 
<link title="Netdate" rel="Chapter" href="Netdate.html">
78
 
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
79
 
<link title="Netulex" rel="Chapter" href="Netulex.html">
80
 
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
81
 
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
82
 
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
83
 
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
84
 
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
85
 
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
86
 
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
87
 
<link title="Netaux" rel="Chapter" href="Netaux.html">
88
 
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
89
 
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
90
 
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
91
 
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
92
 
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
93
 
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
94
 
<link title="Netsys" rel="Chapter" href="Netsys.html">
95
 
<link title="Netpop" rel="Chapter" href="Netpop.html">
96
 
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
97
 
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
98
 
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
99
 
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
100
 
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
101
 
<link title="Xdr" rel="Chapter" href="Xdr.html">
102
 
<link title="Rpc" rel="Chapter" href="Rpc.html">
103
 
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
104
 
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
105
 
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
106
 
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
107
 
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
108
 
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
109
 
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
110
 
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
111
 
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
112
 
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
113
 
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
114
 
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
115
 
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
116
 
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
117
 
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
118
 
<link title="Shell" rel="Chapter" href="Shell.html">
119
 
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
120
 
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
121
 
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
122
 
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><title>Ocamlnet 2 Reference Manual : Ftp_client.ftp_client</title>
123
 
</head>
124
 
<body>
125
 
<div class="navbar"><a href="Ftp_client.mdtm_method.html">Previous</a>
126
 
&nbsp;<a href="Ftp_client.html">Up</a>
127
 
&nbsp;</div>
128
 
<center><h1>Class <a href="type_Ftp_client.ftp_client.html">Ftp_client.ftp_client</a></h1></center>
129
 
<br>
130
 
<pre><span class="keyword">class</span> <a name="TYPEftp_client"></a>ftp_client : <code class="type">?event_system:<a href="Unixqueue.event_system.html">Unixqueue.event_system</a> -> ?onempty:unit -> unit -> unit -> </code><code class="code">object</code> <a href="Ftp_client.ftp_client.html">..</a> <code class="code">end</code></pre>The ftp client is a user session that may even span several connections.
131
 
 However, only one server is connected at once.<br>
132
 
<b>Inherits</b><ul>
133
 
<li><a href="Uq_engines.engine.html"><code class="code">Uq_engines.engine</code></a>    The FTP client is also an engine. The engine can be in one of four
134
 
 states:<ul>
135
 
<li><code class="code">`Working _</code>: The client is still active. The <code class="code">int</code>
136
 
   argument is currently meaningless.</li>
137
 
<li><code class="code">`Done()</code>: The client has been terminated.</li>
138
 
<li><code class="code">`Error e</code>: A violation of the FTP protocol happened, or another
139
 
   exception <code class="code">e</code> occurred</li>
140
 
<li><code class="code">`Aborted</code>: The <code class="code">abort</code> method was called</li>
141
 
</ul>
142
 
</li>
143
 
</ul>
144
 
<hr width="100%">
145
 
<pre><span class="keyword">method</span> <a name="METHODadd"></a>add : <code class="type">?onsuccess:(unit -> unit) -><br>       ?onerror:(exn -> unit) -> <a href="Ftp_client.ftp_method.html">ftp_method</a> -> unit</code></pre><div class="info">
146
 
Adds an FTP method to the queue of methods to execute. It is no
147
 
 problem to add the same method twice.
148
 
<p>
149
 
 
150
 
 When the method could be executed successfully, the function
151
 
 <code class="code">onsuccess</code> is called. (By default, this function does nothing.)
152
 
<p>
153
 
 
154
 
 If the FTP server indicates an error, the 
155
 
 function <code class="code">onerror</code> is called instead. The exception is either
156
 
 <code class="code">FTP_method_temp_failure</code> or <code class="code">FTP_method_perm_failure</code>.  
157
 
 The default for <code class="code">onerror</code> is to raise the exception again,
158
 
 which has the effect of setting the engine state to <code class="code">`Error</code>.
159
 
 This effectively stops the FTP client. (Hard errors
160
 
 like socket problems or protocol violations are not reported this
161
 
 way, but by directly setting the engine state to <code class="code">`Error</code>.)<br>
162
 
</div>
163
 
<pre><span class="keyword">method</span> <a name="METHODrun"></a>run : <code class="type">unit -> unit</code></pre><div class="info">
164
 
Starts the event system; same as <code class="code">Unixqueue.run</code><br>
165
 
</div>
166
 
</body></html>
 
 
b'\\ No newline at end of file'