vertx / io.vertx.ext.shell / ShellService

ShellService

interface ShellService

The shell service, provides a remotely accessible shell available via Telnet or SSH according to the io.vertx.ext.shell.ShellServiceOptions configuration. The shell service will expose commands using io.vertx.ext.shell.command.CommandResolver on the classpath and the shared command registry for the Vert.x instance.

Author
Julien Viet

Functions

create

open static fun create(vertx: Vertx): ShellService

Like #create(Vertx, ShellServiceOptions), with default options.

open static fun create(vertx: Vertx, options: ShellServiceOptions): ShellService

Create a new shell service.

server

abstract fun server(): ShellServer

start

open fun start(): Unit
abstract fun start(startHandler: Handler<AsyncResult<Void>>): Unit

Start the shell service, this is an asynchronous start.

stop

open fun stop(): Unit

Stop the shell service, this is an asynchronous stop.

abstract fun stop(stopHandler: Handler<AsyncResult<Void>>): Unit

Stop the shell service, this is an asynchronous start.