Android™

Check Whether SSH Channel EOF Was Received

Demonstrates the Chilkat Ssh.ChannelReceivedEof method, which reports whether an SSH EOF message has been received for a channel. The only argument is the channel number. EOF means the server will send no more ordinary channel data, but it does not close the channel.

Background: EOF and CLOSE are separate events, and the distinction matters when deciding whether a command has truly finished. A server commonly sends EOF first and CLOSE afterward; in that interval this method is true while ChannelReceivedClose is still false, and the channel remains open and counted. EOF is the signal that all output has been produced — useful when you want to stop reading without waiting for the full close handshake. It returns false for an invalid, released, or locally closed channel.

Chilkat Android™ Downloads

Download Chilkat for Android™

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 Ssh.ChannelReceivedEof method, which reports whether an SSH EOF message has
    //  been received for a channel.  The only argument is the channel number.  EOF means the server
    //  will send no more ordinary channel data, but it does not close the channel.

    CkSsh ssh = new CkSsh();

    int sshPort = 22;
    success = ssh.Connect("ssh.example.com",sshPort);
    if (success == false) {
        Log.i(TAG, 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) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    success = ssh.SendReqExec(channelNum,"ls -l /tmp");
    if (success == false) {
        Log.i(TAG, 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) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    if (ssh.ChannelReceivedEof(channelNum)) {
        Log.i(TAG, "EOF was received -- no more ordinary channel data will arrive.");
        }
    else {
        Log.i(TAG, "No EOF has been received.");
        }

    ssh.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."
  }
}