PHP

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

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\SFtp;

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

$sftp = new SFtp();

// Connect, authenticate, and initialize the SFTP subsystem.
$port = 22;
try {
    $sftp->Connect('sftp.example.com', $port);

    // 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.
    $password = 'mySshPassword';

    $sftp->AuthenticatePw('mySshLogin', $password);

    $sftp->InitializeSftp();

    // Open a remote file, obtaining a handle.
    $handle = $sftp->OpenFile('subdir/data.txt', 'readOnly', 'openExisting');

    // ... use the handle ...

    // Close the handle to release the server-side resource.  A handle should not be used after it
    // is closed.
    $sftp->CloseHandle($handle);
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Handle closed.\n";

$sftp->Disconnect();