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
|
<html><head>
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
<link title="Http_client" rel="Chapter" href="Http_client.html">
<link title="Http_client_mt" rel="Chapter" href="Http_client_mt.html">
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html"><title>The Netclient Manual : Ftp_client</title>
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
<span class="keyword">exception</span> <span class="constructor">FTP_protocol_error</span> <span class="keyword">of</span> exn<br>
<span class="keyword">exception</span> <span class="constructor">FTP_protocol_violation</span> <span class="keyword">of</span> string<br>
<span class="keyword">type</span> cmd_state =<br>
[ <span class="keywordsign">`</span><span class="constructor">Failure</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Init</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Pass_acct_seq</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Preliminary</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Proto_error</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Rename_seq</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Restart_seq</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Success</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">User_acct_seq</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">User_pass_seq</span> ]<br>
<span class="keyword">type</span> port =<br>
[ <span class="keywordsign">`</span><span class="constructor">Active</span> <span class="keyword">of</span> string * int * <span class="constructor">Unix</span>.file_descr<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Passive</span> <span class="keyword">of</span> string * int<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Unspecified</span> ]<br>
<span class="keyword">type</span> form_code = [ <span class="keywordsign">`</span><span class="constructor">ASA</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Non_print</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Telnet</span> ]<br>
<span class="keyword">type</span> representation =<br>
[ <span class="keywordsign">`</span><span class="constructor">ASCII</span> <span class="keyword">of</span> <span class="constructor">Ftp_client</span>.form_code option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">EBCDIC</span> <span class="keyword">of</span> <span class="constructor">Ftp_client</span>.form_code option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Image</span> ]<br>
<span class="keyword">type</span> structure = [ <span class="keywordsign">`</span><span class="constructor">File_structure</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Record_structure</span> ]<br>
<span class="keyword">type</span> transmission_mode = [ <span class="keywordsign">`</span><span class="constructor">Block_mode</span> <span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Stream_mode</span> ]<br>
<span class="keyword">type</span> state = {<br>
cmd_state : <span class="constructor">Ftp_client</span>.cmd_state;<br>
ftp_connected : bool;<br>
ftp_data_conn : bool;<br>
ftp_user : string option;<br>
ftp_password : string option;<br>
ftp_account : string option;<br>
ftp_logged_in : bool;<br>
ftp_port : <span class="constructor">Ftp_client</span>.port;<br>
ftp_repr : <span class="constructor">Ftp_client</span>.representation;<br>
ftp_structure : <span class="constructor">Ftp_client</span>.structure;<br>
ftp_trans : <span class="constructor">Ftp_client</span>.transmission_mode;<br>
ftp_dir : string list;<br>
}<br>
<span class="keyword">type</span> cmd =<br>
[ <span class="keywordsign">`</span><span class="constructor">ACCT</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">ALLO</span> <span class="keyword">of</span> int * int option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">APPE</span> <span class="keyword">of</span> string * (<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_sender)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">CDUP</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">CWD</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">Connect</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">DELE</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">HELP</span> <span class="keyword">of</span> string option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">LIST</span> <span class="keyword">of</span><br>
string option *<br>
(<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_receiver)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">MKD</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">MODE</span> <span class="keyword">of</span> <span class="constructor">Ftp_client</span>.transmission_mode<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">NLST</span> <span class="keyword">of</span><br>
string option *<br>
(<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_receiver)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">NOOP</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">PASS</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">PASV</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">PORT</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">PWD</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">QUIT</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">REIN</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">REST</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">RETR</span> <span class="keyword">of</span><br>
string * (<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_receiver)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">RMD</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">RNFR</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">RNTO</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">SITE</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">SMNT</span> <span class="keyword">of</span> string<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">STAT</span> <span class="keyword">of</span> string option<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">STOR</span> <span class="keyword">of</span> string * (<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_sender)<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">STOU</span> <span class="keyword">of</span> unit <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_sender<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">STRU</span> <span class="keyword">of</span> <span class="constructor">Ftp_client</span>.structure<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">SYST</span><br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">TYPE</span> <span class="keyword">of</span> <span class="constructor">Ftp_client</span>.representation<br>
<span class="keywordsign">|</span> <span class="keywordsign">`</span><span class="constructor">USER</span> <span class="keyword">of</span> string ]<br>
<span class="keyword">type</span> reply = int * string<br>
<span class="keyword">class</span> ftp_client_pi :<br>
?event_system:<span class="constructor">Unixqueue</span>.event_system <span class="keywordsign">-></span><br>
?onempty:(<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br>
?onclose:(unit <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br>
<span class="constructor">Unix</span>.file_descr <span class="keywordsign">-></span><br>
<span class="keyword">object</span><br>
<span class="keyword">method</span> add_cmd :<br>
?onreply:(<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_client</span>.reply <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br>
<span class="constructor">Ftp_client</span>.cmd <span class="keywordsign">-></span> unit<br>
<span class="keyword">method</span> run : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">method</span> send_abort : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">method</span> state : <span class="constructor">Ftp_client</span>.state<br>
<span class="keyword">end</span><br>
<span class="keyword">class</span> <span class="keyword">type</span> ftp_method =<br>
<span class="keyword">object</span><br>
<span class="keyword">method</span> connect : (string * int) option<br>
<span class="keyword">method</span> execute : <span class="constructor">Ftp_client</span>.ftp_client_pi <span class="keywordsign">-></span> <span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> unit<br>
<span class="keyword">end</span><br>
<span class="keyword">exception</span> <span class="constructor">FTP_method_failure</span> <span class="keyword">of</span> int * string<br>
<span class="keyword">class</span> connect_method : host:string <span class="keywordsign">-></span> ?port:int <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> ftp_method<br>
<span class="keyword">class</span> login_method :<br>
user:string <span class="keywordsign">-></span><br>
get_password:(unit <span class="keywordsign">-></span> string) <span class="keywordsign">-></span><br>
get_account:(unit <span class="keywordsign">-></span> string) <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> ftp_method<br>
<span class="keyword">class</span> get_method :<br>
file:string <span class="keywordsign">-></span><br>
representation:<span class="constructor">Ftp_client</span>.representation <span class="keywordsign">-></span><br>
store:(<span class="constructor">Ftp_client</span>.state <span class="keywordsign">-></span> <span class="constructor">Ftp_data_endpoint</span>.local_receiver) <span class="keywordsign">-></span><br>
unit <span class="keywordsign">-></span> ftp_method<br>
<span class="keyword">class</span> ftp_client :<br>
?event_system:<span class="constructor">Unixqueue</span>.event_system <span class="keywordsign">-></span><br>
?onempty:(unit <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br>
unit <span class="keywordsign">-></span><br>
<span class="keyword">object</span><br>
<span class="keyword">method</span> add :<br>
?onsuccess:(unit <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span><br>
?onerror:(exn <span class="keywordsign">-></span> unit) <span class="keywordsign">-></span> <span class="constructor">Ftp_client</span>.ftp_method <span class="keywordsign">-></span> unit<br>
<span class="keyword">method</span> run : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">end</span><br>
<span class="keyword">end</span></code></body></html>
|