Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShellServiceOptions

The configurations options for the shell service, the shell connectors can be configured with , and .

Hierarchy

  • ShellServiceOptions

Index

Constructors

constructor

Methods

getHttpOptions

  • Returns HttpTermOptions

getReaperInterval

  • getReaperInterval(): number
  • Set the repear interval, i.e the period at which session eviction is performed.

    Returns number

getSSHOptions

  • Set the SSH options, if the option is null, SSH will not be started.

    Returns SSHTermOptions

getSessionTimeout

  • getSessionTimeout(): number
  • Set the session timeout.

    Returns number

getTelnetOptions

  • Set the Telnet options, if the option is null, Telnet will not be started.

    Returns TelnetTermOptions

getWelcomeMessage

  • getWelcomeMessage(): string
  • Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    Returns string

setHttpOptions

setReaperInterval

  • Set the repear interval, i.e the period at which session eviction is performed.

    Parameters

    • reaperInterval: number

    Returns ShellServiceOptions

setSSHOptions

  • Set the SSH options, if the option is null, SSH will not be started.

    Parameters

    Returns ShellServiceOptions

setSessionTimeout

  • Set the session timeout.

    Parameters

    • sessionTimeout: number

    Returns ShellServiceOptions

setTelnetOptions

  • Set the Telnet options, if the option is null, Telnet will not be started.

    Parameters

    Returns ShellServiceOptions

setWelcomeMessage

  • Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    Parameters

    • welcomeMessage: string

    Returns ShellServiceOptions

Generated using TypeDoc