Request a Pseudo-Terminal (PTY) over SSH

See more SSH Examples

Demonstrates the Chilkat Ssh.SendReqPty method, which requests a pseudo-terminal for a session channel. The arguments are the channel number, the terminal type, the character width and height, and the pixel width and height. It must be sent before the primary exec or shell request.

// 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.SendReqPty method, which requests a pseudo-terminal for a session
    //  channel.  The 1st argument is the channel number, the 2nd is the terminal type, the 3rd and
    //  4th are the character width and height, and the 5th and 6th are the pixel width and height.
    //  It must be sent before the primary exec or shell request.

    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;
        }

    //  Open a session channel.  A negative return value indicates failure.
    int channelNum = ssh.OpenSessionChannel();
    if (channelNum < 0) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  Request an 80x24 xterm.  Pixel dimensions of 0 mean unspecified.
    String termType = "xterm";
    int widthInChars = 80;
    int heightInChars = 24;
    int widthInPixels = 0;
    int heightInPixels = 0;
    success = ssh.SendReqPty(channelNum,termType,widthInChars,heightInChars,widthInPixels,heightInPixels);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

    //  Start the shell now that the PTY is allocated.
    success = ssh.SendReqShell(channelNum);
    if (success == false) {
        Log.i(TAG, ssh.lastErrorText());
        return;
        }

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