| Package | Description | 
|---|---|
| io.vertx.ext.shell | |
| io.vertx.reactivex.ext.shell | |
| io.vertx.rxjava.ext.shell | |
| io.vertx.rxjava3.ext.shell | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ShellServiceOptions
The configurations options for the shell service, the shell connectors can be configured
 with  
TelnetTermOptions, SSHTermOptions and HttpTermOptions. | 
| Modifier and Type | Method and Description | 
|---|---|
ShellServerOptions | 
ShellServerOptions.setReaperInterval(long reaperInterval)
Set the repear interval, i.e the period at which session eviction is performed. 
 | 
ShellServerOptions | 
ShellServerOptions.setSessionTimeout(long sessionTimeout)
Set the session timeout. 
 | 
ShellServerOptions | 
ShellServerOptions.setWelcomeMessage(String welcomeMessage)
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ShellServer | 
ShellServer.create(Vertx vertx,
      ShellServerOptions options)
Create a new shell server with default options. 
 | 
static void | 
ShellServerOptionsConverter.fromJson(Iterable<Map.Entry<String,Object>> json,
        ShellServerOptions obj)  | 
static void | 
ShellServerOptionsConverter.toJson(ShellServerOptions obj,
      JsonObject json)  | 
static void | 
ShellServerOptionsConverter.toJson(ShellServerOptions obj,
      Map<String,Object> json)  | 
| Constructor and Description | 
|---|
ShellServerOptions(ShellServerOptions that)  | 
| Modifier and Type | Method and Description | 
|---|---|
static ShellServer | 
ShellServer.create(Vertx vertx,
      ShellServerOptions options)
Create a new shell server with default options. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ShellServer | 
ShellServer.create(Vertx vertx,
      ShellServerOptions options)
Create a new shell server with default options. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static ShellServer | 
ShellServer.create(Vertx vertx,
      ShellServerOptions options)
Create a new shell server with default options. 
 | 
Copyright © 2021 Eclipse. All rights reserved.