Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<TermServer> |
__TYPE_ARG |
Constructor and Description |
---|
TermServer(Object delegate) |
TermServer(TermServer delegate) |
Modifier and Type | Method and Description |
---|---|
int |
actualPort()
The actual port the server is listening on.
|
TermServer |
authProvider(AuthProvider provider)
Set an auth provider to use, any provider configured in options will override this provider.
|
void |
close()
Like
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete. |
void |
close(Handler<AsyncResult<Void>> completionHandler)
Like
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete. |
static TermServer |
createHttpTermServer(Vertx vertx)
Create a term server for the HTTP protocol.
|
static TermServer |
createHttpTermServer(Vertx vertx,
HttpTermOptions options)
Create a term server for the HTTP protocol.
|
static TermServer |
createHttpTermServer(Vertx vertx,
Router router)
Create a term server for the HTTP protocol, using an existing router.
|
static TermServer |
createHttpTermServer(Vertx vertx,
Router router,
HttpTermOptions options)
Create a term server for the HTTP protocol, using an existing router.
|
static TermServer |
createSSHTermServer(Vertx vertx)
Create a term server for the SSH protocol.
|
static TermServer |
createSSHTermServer(Vertx vertx,
SSHTermOptions options)
Create a term server for the SSH protocol.
|
static TermServer |
createTelnetTermServer(Vertx vertx)
Create a term server for the Telnet protocol.
|
static TermServer |
createTelnetTermServer(Vertx vertx,
TelnetTermOptions options)
Create a term server for the Telnet protocol.
|
boolean |
equals(Object o) |
TermServer |
getDelegate() |
int |
hashCode() |
TermServer |
listen()
Bind the term server, the
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>) must be set before. |
TermServer |
listen(Handler<AsyncResult<Void>> listenHandler)
Bind the term server, the
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>) must be set before. |
static TermServer |
newInstance(TermServer arg) |
Single<Void> |
rxClose()
Like
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete. |
Single<Void> |
rxListen()
Bind the term server, the
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>) must be set before. |
TermServer |
termHandler(Handler<Term> handler)
Set the term handler that will receive incoming client connections.
|
String |
toString() |
public static final io.vertx.lang.rx.TypeArg<TermServer> __TYPE_ARG
public TermServer(TermServer delegate)
public TermServer(Object delegate)
public TermServer getDelegate()
public static TermServer createSSHTermServer(Vertx vertx)
vertx
- the vertx instancepublic static TermServer createSSHTermServer(Vertx vertx, SSHTermOptions options)
vertx
- the vertx instanceoptions
- the ssh optionspublic static TermServer createTelnetTermServer(Vertx vertx)
vertx
- the vertx instancepublic static TermServer createTelnetTermServer(Vertx vertx, TelnetTermOptions options)
vertx
- the vertx instanceoptions
- the term optionspublic static TermServer createHttpTermServer(Vertx vertx)
vertx
- the vertx instancepublic static TermServer createHttpTermServer(Vertx vertx, HttpTermOptions options)
vertx
- the vertx instanceoptions
- the term optionspublic static TermServer createHttpTermServer(Vertx vertx, Router router)
vertx
- the vertx instancerouter
- the routerpublic static TermServer createHttpTermServer(Vertx vertx, Router router, HttpTermOptions options)
vertx
- the vertx instancerouter
- the routeroptions
- the term optionspublic TermServer termHandler(Handler<Term> handler)
handler
will be called with the Term
which can be used to interact with the remote
terminal.handler
- the term handlerpublic TermServer authProvider(AuthProvider provider)
provider
- the auth to usepublic TermServer listen(Handler<AsyncResult<Void>> listenHandler)
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>)
must be set before.listenHandler
- the listen handlerpublic TermServer listen()
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>)
must be set before.public Single<Void> rxListen()
termHandler(io.vertx.core.Handler<io.vertx.rxjava.ext.shell.term.Term>)
must be set before.public int actualPort()
public void close(Handler<AsyncResult<Void>> completionHandler)
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.completionHandler
- the handler to be notified when the term server is closedpublic void close()
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.public Single<Void> rxClose()
close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>)
but supplying a handler that will be notified when close is complete.public static TermServer newInstance(TermServer arg)
Copyright © 2021 Eclipse. All rights reserved.