Java

Get the Number of Bytes Buffered on an SSH Channel

Demonstrates the Chilkat Ssh.GetReceivedNumBytes method, which returns how many bytes are currently available in a channel's normal receive buffer. The only argument is the channel number. It returns -1 when the channel number is invalid or its retained resources have been released.

Background: This is a non-consuming look at how much is waiting, useful for deciding whether to retrieve now or keep reading, and for reporting progress on a large transfer. It counts only the normal receive buffer — bytes in the separate stderr buffer are excluded when StderrToStdout is false. Note that data received earlier can remain available even after a disconnect, so a positive count does not imply the connection is still up.

Chilkat Java Downloads

Download Chilkat for Java

Java

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    boolean success = false;

    //  Demonstrates the Ssh.GetReceivedNumBytes method, which returns the number of bytes currently
    //  available in a channel's normal receive buffer.  The only argument is the channel number.
    //  It returns -1 for an invalid channel or one whose resources have been released.

    CkSsh ssh = new CkSsh();

    int sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        System.out.println(ssh.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 = ssh.AuthenticatePw("mySshLogin",password);
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    success = ssh.SendReqExec(channelNum,"ls -l /tmp");
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    //  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
    //  it, this call waits forever if the server never sends channel close.
    ssh.put_ReadTimeoutMs(15000);

    success = ssh.ChannelReceiveToClose(channelNum);
    if (success == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    //  Find out how much is waiting before retrieving it.
    int numBytes = ssh.GetReceivedNumBytes(channelNum);
    if (numBytes < 0) {
        System.out.println("Invalid channel, or its resources were already released.");
        return;
        }

    System.out.println("Bytes available: " + numBytes);

    String output = ssh.getReceivedText(channelNum,"utf-8");
    if (ssh.get_LastMethodSuccess() == false) {
        System.out.println(ssh.lastErrorText());
        return;
        }

    System.out.println(output);

    ssh.Disconnect();
  }
}