React Native

Send a Signal to a Remote SSH Process

Demonstrates the Chilkat Ssh.SendReqSignal method, which requests delivery of a signal to the remote process running on a channel. The first argument is the channel number and the second is the signal name. Send it after the process has started.

Background: This is the SSH equivalent of pressing Ctrl+C or running kill — it lets a client interrupt or terminate a long-running remote command without tearing down the connection. Signal names are given without the SIG prefix (INT, TERM, KILL, and so on). Note that some servers, including common OpenSSH builds, do not implement signal delivery.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the Ssh.SendReqSignal method, which requests delivery of a signal to the remote
  // process running on a channel.  The 1st argument is the channel number and the 2nd is the
  // signal name.  Send it after the process has started.

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

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

  // Start a long-running command.
  try {
    await ssh.sendReqExecAsync(channelNum, 'sleep 60');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  // Send an interrupt signal to the remote process.  The name omits the "SIG" prefix.
  try {
    await ssh.sendReqSignalAsync(channelNum, 'INT');
  } catch {
    console.log(ssh.lastErrorText);
    return;
  }

  console.log('Signal sent.');

  ssh.disconnect();
}