Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ssh

[33:14] (extern: com.lehman.aussom.AussomSsh) extends: object

The ssh class implements various SSH functions for managing a remote SSH connection.

Methods

  • ssh (string Host, string UserName, string Password, int Port = 22)

    Constructor creates a new ssh connection object with the provided arguments.

    • @p Host is a string with the host.
    • @p UserName is a string with the user name.
    • @p Password is a string with the password.
    • @p Port is an optional int with the port number.
    • @r This object.
  • newSsh (string Host, string UserName, string Password, int Port = 22)

  • connect ()

    Attempts to connect to the remote host.

    • @r This object.
  • disconnect ()

    Disconnect from the remote host.

    • @r This object.
  • write (string Str)

    Writes the provided string over the ssh connection.

    • @r This object.
  • writeCommand (string Command)

    Writes the provided command on the remote host.

    • @p Command is a string with the command to write.
    • @r This object.
  • getIsConnected ()

    Gets the is connected flag.

    • @r A bool with the flag value.
  • getIsChannelConnected ()

    Gets the is channel connected flag.

    • @r A bool with the flag value.
  • read ()

    Reads a single byte from the remote system and returns it as a string.

    • @r A string with the read byte.
  • readUntil (string UntilStr)

    Reads until the provided string is found.

    • @p UntilStr is a string to match.
    • @r A string with the bytes read.

class: ssh_module

[23:14] static extends: object

Module JAR loader class.

Methods

  • ssh_module ()