Tcl

Clear the FTP Directory Listing Cache

Demonstrates the Chilkat Ftp2.ClearDirCache method, which clears the cached listing for the current remote directory. It takes no arguments; the next indexed-listing call fetches a fresh listing from the server.

Background: The index-based directory API caches the listing the first time you read it, so repeated accessor calls avoid extra round trips. The trade-off is staleness: if the directory changes — files added or removed, whether by your own operations or another process — the cache still reflects the old state. ClearDirCache discards it so the next GetDirCount queries the server again.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the Ftp2.ClearDirCache method, which clears the cached listing for the current
#  remote directory.  It takes no arguments and is a void method.

set ftp [new_CkFtp2]

CkFtp2_put_Hostname $ftp "ftp.example.com"
CkFtp2_put_Username $ftp "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.
CkFtp2_put_Password $ftp "myPassword"

set success [CkFtp2_Connect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

set success [CkFtp2_ChangeRemoteDir $ftp "public_html"]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}

#  The first GetDirCount caches the listing.
set n [CkFtp2_GetDirCount $ftp]
puts "Entries: $n"

#  ... the remote directory changes (files added or removed by another process) ...

#  Discard the cache so the next listing call fetches fresh data from the server.
CkFtp2_ClearDirCache $ftp

set n [CkFtp2_GetDirCount $ftp]
puts "Entries after refresh: $n"

set success [CkFtp2_Disconnect $ftp]
if {$success == 0} then {
    puts [CkFtp2_lastErrorText $ftp]
    delete_CkFtp2 $ftp
    exit
}


delete_CkFtp2 $ftp