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.| Constructor and Description |
|---|
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.
|
Observable<Void> |
closeObservable()
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.
|
Object |
getDelegate() |
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.
|
Observable<Void> |
listenObservable()
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.
|
public ShellServer(ShellServer delegate)
public Object 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()
public ShellServer listen(Handler<AsyncResult<Void>> listenHandler)
listenHandler - handler for getting notified when service is startedpublic Observable<Void> listenObservable()
public void close()
public void close(Handler<AsyncResult<Void>> completionHandler)
completionHandler - handler for getting notified when service is stoppedpublic Observable<Void> closeObservable()
public static ShellServer newInstance(ShellServer arg)
Copyright © 2016. All rights reserved.