Lua

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 Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

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

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.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.password = "myPassword"

local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:change_remote_dir("public_html")
if not success then
    print(ftp.last_error_text)
    return
end

-- The first GetDirCount caches the listing.
local n = ftp:get_dir_count()
print("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.
ftp:clear_dir_cache()

n = ftp:get_dir_count()
print("Entries after refresh: " .. n)

success = ftp:disconnect()
if not success then
    print(ftp.last_error_text)
    return
end