View source code Display the source code in std/net/curl.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

Struct std.net.curl.FTP

FTP client functionality.

Properties

Name Type Description
connectTimeout [set] Duration Set timeout for connecting.
contentLength [set] ulong The content length in bytes of the ftp data.
dataTimeout [set] Duration Set timeout for activity on connection.
dnsTimeout [set] Duration DNS lookup timeout.
encoding [get, set] string Connection encoding. Defaults to ISO-8859-1.
isStopped [get] bool True if the instance is stopped. A stopped instance is not usable.
localPort [set] ushort Set the local outgoing port to use.
localPortRange [set] ushort Set the local outgoing port range to use. This can be used together with the localPort property.
netInterface [set] const(char)[] The network interface to use in form of the the IP of the interface.
onProgress [set] int delegate(ulong, ulong, ulong, ulong) The event handler that gets called to inform of upload/download progress.
onReceive [set] ulong delegate(ubyte[]) The event handler that receives incoming data. Be sure to copy the incoming ubyte[] since it is not guaranteed to be valid after the callback returns.
onSend [set] ulong delegate(void[]) The event handler that gets called when data is needed for sending. The length of the void[] specifies the maximum number of bytes that can be sent.
operationTimeout [set] Duration Set maximum time an operation is allowed to take. This includes dns resolution, connecting, data transfer, etc.
proxy [set] const(char)[] Proxy
proxyPort [set] ushort Proxy port
proxyType [set] CurlProxy Proxy type
tcpNoDelay [set] bool Set the tcp no-delay socket option on or off.
url [set] const(char)[] The URL to specify the location of the resource.
verbose [set] bool Set verbose. This will print request information to stderr.

Methods

Name Description
addCommand Add a command to send to ftp server.
clearCommands Clear all commands send to ftp server.
opCall FTP access to the specified url.
perform Performs the ftp request as it has been configured.
setAuthentication Set the user name, password and optionally domain for authentication purposes.
setProxyAuthentication Set the user name and password for proxy authentication.
shutdown Stop and invalidate this instance.

Aliases

Name Description
CurlProxy Type of proxy
requestAbort Value to return from onSend delegate in order to abort a request
requestPause Value to return from onSend/onReceive delegates in order to

See Also

RFC959

Authors

Jonas Drewsen. Some of the SMTP code contributed by Jimmy Cao.

License

Boost License 1.0.

Comments