Swift

Close a Remote SFTP File or Directory Handle

Demonstrates the Chilkat SFtp.CloseHandle method, which closes a remote file or directory handle previously returned by OpenFile or OpenDir. The only argument is the handle.

Background: Every opened handle corresponds to state the server holds, and servers cap how many a session may keep open at once, so a long-running program that forgets to close handles will eventually start failing to open new ones. Closing also ensures buffered writes are committed. Once closed, a handle is invalid and must not be reused.

Chilkat Swift Downloads

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = false

    //  Demonstrates the SFtp.CloseHandle method, which closes a remote file or directory handle.  The
    //  only argument is the handle returned by OpenFile or OpenDir.

    let sftp = CkoSFtp()!

    //  Connect, authenticate, and initialize the SFTP subsystem.
    var port: Int = 22
    success = sftp.connect(hostname: "sftp.example.com", port: port)
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    //  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.
    var password: String? = "mySshPassword"

    success = sftp.authenticatePw(login: "mySshLogin", password: password)
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    success = sftp.initializeSftp()
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    //  Open a remote file, obtaining a handle.
    var handle: String? = sftp.openFile(filename: "subdir/data.txt", access: "readOnly", createDisp: "openExisting")
    if sftp.lastMethodSuccess == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    //  ... use the handle ...

    //  Close the handle to release the server-side resource.  A handle should not be used after it
    //  is closed.
    success = sftp.closeHandle(sftpHandle: handle)
    if success == false {
        print("\(sftp.lastErrorText!)")
        return
    }

    print("Handle closed.")

    sftp.disconnect()

}