Package io.vertx.ext.shell

## Interface ShellService

-     public interface 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.
  Author:
    Julien Viet

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `static ShellService` | `create​(Vertx vertx)` | Like `create(Vertx, ShellServiceOptions)`, with default options.
    `static ShellService` | `create​(Vertx vertx, ShellServiceOptions options)` | Create a new shell service.
    `ShellServer` | `server()` |
    `Future<Void>` | `start()` | Start the shell service, this is an asynchronous start.
    `Future<Void>` | `stop()` | Stop the shell service, this is an asynchronous stop.

- - ### Method Detail

    - #### create

          static ShellService create​(Vertx vertx)

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

    - #### create

          static ShellService create​(Vertx vertx,
                                     ShellServiceOptions options)

      Create a new shell service.
      Parameters:
        `vertx` - the Vert.x instance
        `options` - the service config options
      Returns:
        the shell service

    - #### start

          Future<Void> start()

      Start the shell service, this is an asynchronous start.

    - #### server

          ShellServer server()

      Returns:
        the shell server

    - #### stop

          Future<Void> stop()

      Stop the shell service, this is an asynchronous stop.