Sample code for 30+ languages & platforms
Android™

Get the Byte Count of the Last SFTP Read

See more SFTP Examples

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 Android™ Downloads

Android™
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean 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.

    CkSFtp sftp = new CkSFtp();

    //  Connect, authenticate, and initialize the SFTP subsystem.
    int port = 22;
    success = sftp.Connect("sftp.example.com",port);
    if (success == false) {
        Log.i(TAG, 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.
    String password = "mySshPassword";

    success = sftp.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    success = sftp.InitializeSftp();
    if (success == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    String handle = sftp.openFile("subdir/data.txt","readOnly","openExisting");
    if (sftp.get_LastMethodSuccess() == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    CkBinData bd = new CkBinData();
    int chunkSize = 4096;
    boolean reading = true;
    while (reading) {
        success = sftp.ReadFileBd(handle,chunkSize,bd);
        if (sftp.LastReadFailed(handle)) {
            Log.i(TAG, sftp.lastErrorText());
            return;
            }

        //  Report how many bytes the last read actually returned.  A normal EOF read reports 0.
        int lastCount = sftp.LastReadNumBytes(handle);
        Log.i(TAG, "Last read returned " + String.valueOf(lastCount) + " bytes.");

        reading = !sftp.Eof(handle);
        }

    success = sftp.CloseHandle(handle);
    if (success == false) {
        Log.i(TAG, sftp.lastErrorText());
        return;
        }

    Log.i(TAG, "Total: " + String.valueOf(bd.get_NumBytes()) + " bytes.");

    sftp.Disconnect();

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}