React Native

Clear Accumulated SSH TTY Modes

Demonstrates the Chilkat Ssh.ClearTtyModes method, which clears all TTY modes previously added with SetTtyMode. It takes no arguments. The next SendReqPty will not include the cleared modes.

Background: Because TTY modes accumulate on the Ssh object, they would otherwise carry over into every later PTY request on that object. ClearTtyModes resets that state — useful when one Ssh object opens several channels and each needs different terminal settings, or when you want a PTY created with the server's defaults.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

import { Ssh } from '@chilkat/react-native'

async function chilkatExample() {
  // Demonstrates the Ssh.ClearTtyModes method, which clears all TTY modes previously added with
  // SetTtyMode.  It takes no arguments.

  const ssh = new Ssh();

  const sshPort = 22;
  try {
    await ssh.connectAsync('ssh.example.com', sshPort);
  } catch {
    console.log(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.
  const password = 'mySshPassword';

  try {
    await ssh.authenticatePwAsync('mySshLogin', password);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // Add a TTY mode, then discard it before requesting the PTY.
  try {
    ssh.setTtyMode('ECHO', 0);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // Clear the accumulated TTY modes.  The next SendReqPty will not include them.
  ssh.clearTtyModes();

  // Open a session channel.  A negative return value indicates failure.
  const channelNum = await ssh.openSessionChannelAsync();
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  // This PTY request carries no custom TTY modes.
  try {
    await ssh.sendReqPtyAsync(channelNum, 'xterm', 80, 24, 0, 0);
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  ssh.disconnect();
}