public class ShellServer extends Object
registerTermServer(io.vertx.rxjava.ext.shell.term.TermServer)
method registers a term server. Term servers life cycle are managed by this server.
When a receives an incoming connection, a instance is created and
associated with this connection.
The createShell(io.vertx.rxjava.ext.shell.term.Term)
method can be used to create instance for testing purposes.
NOTE: This class has been automatically generated from the original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<ShellServer> |
__TYPE_ARG |
Constructor and Description |
---|
ShellServer(Object delegate) |
ShellServer(ShellServer delegate) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the shell server, this is an asynchronous close.
|
void |
close(Handler<AsyncResult<Void>> completionHandler)
Close the shell server, this is an asynchronous close.
|
static ShellServer |
create(Vertx vertx)
Create a new shell server with specific options.
|
static ShellServer |
create(Vertx vertx,
ShellServerOptions options)
Create a new shell server with default options.
|
Shell |
createShell()
Create a new shell, the returned shell should be closed explicitely.
|
Shell |
createShell(Term term)
Create a new shell, the returned shell should be closed explicitely.
|
boolean |
equals(Object o) |
ShellServer |
getDelegate() |
int |
hashCode() |
ShellServer |
listen()
Start the shell service, this is an asynchronous start.
|
ShellServer |
listen(Handler<AsyncResult<Void>> listenHandler)
Start the shell service, this is an asynchronous start.
|
static ShellServer |
newInstance(ShellServer arg) |
ShellServer |
registerCommandResolver(CommandResolver resolver)
Register a command resolver for this server.
|
ShellServer |
registerTermServer(TermServer termServer)
Register a term server to this shell server, the term server lifecycle methods are managed by this shell server.
|
Single<Void> |
rxClose()
Close the shell server, this is an asynchronous close.
|
Single<Void> |
rxListen()
Start the shell service, this is an asynchronous start.
|
void |
shellHandler(Handler<Shell> shellHandler)
Called when a new shell is created.
|
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<ShellServer> __TYPE_ARG
public ShellServer(ShellServer delegate)
public ShellServer(Object delegate)
public ShellServer getDelegate()
public static ShellServer create(Vertx vertx, ShellServerOptions options)
vertx
- the vertxoptions
- the optionspublic static ShellServer create(Vertx vertx)
vertx
- the vertxpublic ShellServer registerCommandResolver(CommandResolver resolver)
resolver
- the resolverpublic ShellServer registerTermServer(TermServer termServer)
termServer
- the term server to addpublic Shell createShell(Term term)
term
- the shell associated terminalpublic Shell createShell()
public ShellServer listen(Handler<AsyncResult<Void>> listenHandler)
listenHandler
- handler for getting notified when service is startedpublic ShellServer listen()
public Single<Void> rxListen()
public void close(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- handler for getting notified when service is stoppedpublic void close()
public Single<Void> rxClose()
public void shellHandler(Handler<Shell> shellHandler)
shellHandler
- handler for getting notified when the server creates a new shell.public static ShellServer newInstance(ShellServer arg)
Copyright © 2023 Eclipse. All rights reserved.