public interface TermServer
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.
|
default Future<Void> |
close()
Close the server.
|
void |
close(Handler<AsyncResult<Void>> completionHandler)
Like
close() 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.
|
default Future<Void> |
listen()
Bind the term server, the
termHandler(Handler) must be set before. |
TermServer |
listen(Handler<AsyncResult<Void>> listenHandler)
Bind the term server, the
termHandler(Handler) must be set before. |
TermServer |
termHandler(Handler<Term> handler)
Set the term handler that will receive incoming client connections.
|
static TermServer createSSHTermServer(Vertx vertx)
vertx
- the vertx instancestatic TermServer createSSHTermServer(Vertx vertx, SSHTermOptions options)
vertx
- the vertx instanceoptions
- the ssh optionsstatic TermServer createTelnetTermServer(Vertx vertx)
vertx
- the vertx instancestatic TermServer createTelnetTermServer(Vertx vertx, TelnetTermOptions options)
vertx
- the vertx instanceoptions
- the term optionsstatic TermServer createHttpTermServer(Vertx vertx)
vertx
- the vertx instancestatic TermServer createHttpTermServer(Vertx vertx, HttpTermOptions options)
vertx
- the vertx instanceoptions
- the term optionsstatic TermServer createHttpTermServer(Vertx vertx, Router router)
vertx
- the vertx instancerouter
- the routerstatic TermServer createHttpTermServer(Vertx vertx, Router router, HttpTermOptions options)
vertx
- the vertx instancerouter
- the routeroptions
- the term optionsTermServer termHandler(Handler<Term> handler)
handler
will be called with the Term
which can be used to interact with the remote
terminal.handler
- the term handlerTermServer authProvider(AuthProvider provider)
provider
- the auth to usedefault Future<Void> listen()
termHandler(Handler)
must be set before.TermServer listen(Handler<AsyncResult<Void>> listenHandler)
termHandler(Handler)
must be set before.listenHandler
- the listen handlerint actualPort()
default Future<Void> close()
void close(Handler<AsyncResult<Void>> completionHandler)
close()
but supplying a handler that will be notified when close is complete.completionHandler
- the handler to be notified when the term server is closedCopyright © 2021 Eclipse. All rights reserved.