Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShellService

The shell service, provides a remotely accessible shell available via Telnet or SSH according to the ShellServiceOptions configuration.

The shell service will expose commands using CommandResolver on the classpath and the shared command registry for the Vert.x instance.

Hierarchy

  • ShellService

Index

Methods

server

  • Returns ShellServer

start

  • start(): PromiseLike<void>
  • start(startHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
  • Start the shell service, this is an asynchronous start.

    Returns PromiseLike<void>

  • Start the shell service, this is an asynchronous start.

    Parameters

    • startHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

stop

  • stop(): PromiseLike<void>
  • stop(stopHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
  • Stop the shell service, this is an asynchronous start.

    Returns PromiseLike<void>

  • Stop the shell service, this is an asynchronous start.

    Parameters

    • stopHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

Static create

  • Like {@link ShellService#create}, with default options.

    Parameters

    • vertx: Vertx

    Returns ShellService

  • Create a new shell service.

    Parameters

    Returns ShellService

Generated using TypeDoc