React Native

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the Ssh.GetChannelType method, which returns the type of the channel at a
  // zero-based enumeration index.  The only argument is the index, which is an enumeration
  // position and not a channel number.  Values include "session" and "direct-tcpip".

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

  const channelNum = await ssh.openSessionChannelAsync();
  if (channelNum < 0) {
    console.log(ssh.lastErrorText);
    return;
  }

  // Enumerate the active channels and report each one's number and type.
  const n = ssh.numOpenChannels;
  for (let i = 0; i < n; i++) {
    const chNum = ssh.getChannelNumber(i);
    let chType: string;
    try {
      chType = ssh.getChannelType(i);
    } catch {
      console.log(ssh.lastErrorText);
      return;
    }

    console.log(`Channel ${chNum} is of type ${chType}`);
  }

  ssh.disconnect();
}