Package io.vertx.ext.shell
Interface ShellService
-
public interface ShellServiceThe shell service, provides a remotely accessible shell available via Telnet or SSH according to theShellServiceOptionsconfiguration. The shell service will expose commands usingCommandResolveron 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 ShellServicecreate(Vertx vertx)Likecreate(Vertx, ShellServiceOptions), with default options.static ShellServicecreate(Vertx vertx, ShellServiceOptions options)Create a new shell service.ShellServerserver()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)
Likecreate(Vertx, ShellServiceOptions), with default options.
-
create
static ShellService create(Vertx vertx, ShellServiceOptions options)
Create a new shell service.- Parameters:
vertx- the Vert.x instanceoptions- the service config options- Returns:
- the shell service
-
server
ShellServer server()
- Returns:
- the shell server
-
-