Node.js

Get the Byte Count of the Last SFTP Read

Demonstrates the Chilkat SFtp.LastReadNumBytes method, which returns the number of bytes received by the most recent read for a handle. The only argument is the handle.

Background: SFTP reads may return fewer bytes than requested even before the end of the file, so knowing the actual count is useful for tracking progress and for advancing an explicit offset by the right amount. Both a normal EOF read and a failed read report 0, so pair this with Eof and LastReadFailed to interpret a zero-byte result correctly.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates the SFtp.LastReadNumBytes method, which returns the number of bytes received by
    //  the most recent read for a handle.  The only argument is the handle.

    var sftp = new chilkat.SFtp();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    var port = 22;
    success = sftp.Connect("sftp.example.com",port);
    if (success == false) {
        console.log(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 = "mySshPassword";

    success = sftp.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    success = sftp.InitializeSftp();
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    var handle = sftp.OpenFile("subdir/data.txt","readOnly","openExisting");
    if (sftp.LastMethodSuccess == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    var bd = new chilkat.BinData();
    var chunkSize = 4096;
    var reading = true;
    while (reading) {
        success = sftp.ReadFileBd(handle,chunkSize,bd);
        if (sftp.LastReadFailed(handle)) {
            console.log(sftp.LastErrorText);
            return;
        }

        //  Report how many bytes the last read actually returned.  A normal EOF read reports 0.
        var lastCount = sftp.LastReadNumBytes(handle);
        console.log("Last read returned " + lastCount + " bytes.");

        reading = !sftp.Eof(handle);
    }

    success = sftp.CloseHandle(handle);
    if (success == false) {
        console.log(sftp.LastErrorText);
        return;
    }

    console.log("Total: " + bd.NumBytes + " bytes.");

    sftp.Disconnect();

}

chilkatExample();