Ruby

Clear the FTP Session Log

Demonstrates the Chilkat Ftp2.ClearSessionLog method, which clears the in-memory FTP protocol log collected while KeepSessionLog is enabled. It takes no arguments.

Background: With session logging on, the SessionLog accumulates the full FTP command/reply conversation, which is invaluable for diagnosing a failed transfer. Over a long-lived session it grows unbounded, so clearing it frees memory — and, more usefully, lets you capture the log for one specific operation in isolation by clearing just before and reading just after.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Ftp2.ClearSessionLog method, which clears the in-memory FTP protocol log.  It
#  takes no arguments and is a void method.

ftp = Chilkat::CkFtp2.new()

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

#  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

#  The SessionLog accumulates the FTP protocol conversation when KeepSessionLog is enabled, which
#  is useful for debugging.
ftp.put_KeepSessionLog(true)

#  ... perform some operations ...

#  Clear the log, for example before starting a new logical operation whose log you want to
#  capture in isolation.
ftp.ClearSessionLog()
print "Session log cleared." + "\n";

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