vertx / io.vertx.kotlin.ext.shell / shellServiceOptionsOf

shellServiceOptionsOf

fun shellServiceOptionsOf(httpOptions: HttpTermOptions? = null, reaperInterval: Long? = null, sessionTimeout: Long? = null, sshOptions: SSHTermOptions? = null, telnetOptions: TelnetTermOptions? = null, welcomeMessage: String? = null): ShellServiceOptions

A function providing a DSL for building io.vertx.ext.shell.ShellServiceOptions objects.

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

Parameters

httpOptions -

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

sessionTimeout - Set the session timeout.

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

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

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