Ruby

Set FTP Connection and Read Timeouts

Demonstrates the timeout properties ConnectTimeout, ReadTimeout, and IdleTimeoutMs.

Background: The three timeouts guard different phases: ConnectTimeout (in seconds) bounds how long a connection attempt blocks so an unreachable server fails promptly; ReadTimeout (seconds) limits how long a data connection may stall without new data; and IdleTimeoutMs (milliseconds) caps a lack of forward progress overall. Tuning them prevents a hung server or flaky link from freezing an automated job indefinitely.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

ftp = Chilkat::CkFtp2.new()

ftp.put_Hostname("ftp.example.com")
ftp.put_Username("myFtpLogin")

#  Maximum seconds to wait for the TCP connection to be accepted.
ftp.put_ConnectTimeout(15)

#  Maximum seconds a data connection may go without receiving more data before timing out.
ftp.put_ReadTimeout(30)

#  Maximum milliseconds without a control-channel response or forward progress before failing.
ftp.put_IdleTimeoutMs(20000)

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
ftp.put_Password("myPassword")

success = ftp.Connect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end

print "Connected with custom timeouts." + "\n";

success = ftp.Disconnect()
if (success == false)
    print ftp.lastErrorText() + "\n";
    exit
end