Streaming SFTP Download

Demonstrates how to download a file chunk by chunk from an SSH server.

 Chilkat Perl Module Downloads for Windows, Linux, and MAC OS X

use chilkat();

#  Important: It is helpful to send the contents of the
#  sftp.LastErrorText property when requesting support.

$sftp = new chilkat::CkSFtp();

#  Any string automatically begins a fully-functional 30-day trial.
$success = $sftp->UnlockComponent("Anything for 30-day trial");
if ($success != 1) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

#  Set some timeouts, in milliseconds:
$sftp->put_ConnectTimeoutMs(5000);
$sftp->put_IdleTimeoutMs(15000);

#  Connect to the SSH server.
#  The standard SSH port = 22
#  The hostname may be a hostname or IP address.

$hostname = "www.my-ssh-server.com";
$port = 22;
$success = $sftp->Connect($hostname,$port);
if ($success != 1) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

#  Authenticate with the SSH server.  Chilkat SFTP supports
#  both password-based authenication as well as public-key
#  authentication.  This example uses password authenication.
$success = $sftp->AuthenticatePw("myLogin","myPassword");
if ($success != 1) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

#  After authenticating, the SFTP subsystem must be initialized:
$success = $sftp->InitializeSftp();
if ($success != 1) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

#  Open a file on the server:

$handle = $sftp->openFile("hamlet.xml","readOnly","openExisting");
if ($handle eq null ) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

$dataChunk = new chilkat::CkByteData();

$bEof = 0;

$chunkSize = 10000;

while (!$bEof) {

    $success = $sftp->ReadFileBytes($handle,$chunkSize,$dataChunk);
    if ($success == 1) {

        #  Do whatever  you wish with the data received...
        #  It is possible that if the EOF is reached, 0 bytes will be returned.
        $numBytesReceived = $dataChunk->getSize();
        $pData = $dataChunk->getData();

        print "numBytesReceived = " . $numBytesReceived . "\r\n";

    }
    else {
        print $sftp->lastErrorText() . "\n";
        last;
    }

    $bEof = $sftp->Eof($handle);
}

#  Close the file.
$success = $sftp->CloseHandle($handle);
if ($success != 1) {
    print $sftp->lastErrorText() . "\n";
    exit;
}

print "Success." . "\n";