interface TermServer
A server for terminal based applications.
Author
Julien Viet
abstract fun actualPort(): Int
The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port |
|
abstract fun authProvider(provider: AuthProvider): TermServer
Set an auth provider to use, any provider configured in options will override this provider. This should be used when a custom auth provider should be used. |
|
abstract fun close(): Unit
Close the server. This will close any currently open connections. The close may not complete until after this method has returned. abstract fun close(completionHandler: Handler<AsyncResult<Void>>): Unit
Like |
|
open static fun createHttpTermServer(vertx: Vertx): TermServeropen static fun createHttpTermServer(vertx: Vertx, options: HttpTermOptions): TermServer
Create a term server for the HTTP protocol. open static fun createHttpTermServer(vertx: Vertx, router: Router): TermServeropen static fun createHttpTermServer(vertx: Vertx, router: Router, options: HttpTermOptions): TermServer
Create a term server for the HTTP protocol, using an existing router. |
|
open static fun createSSHTermServer(vertx: Vertx): TermServeropen static fun createSSHTermServer(vertx: Vertx, options: SSHTermOptions): TermServer
Create a term server for the SSH protocol. |
|
open static fun createTelnetTermServer(vertx: Vertx): TermServeropen static fun createTelnetTermServer(vertx: Vertx, options: TelnetTermOptions): TermServer
Create a term server for the Telnet protocol. |
|
open fun listen(): TermServerabstract fun listen(listenHandler: Handler<AsyncResult<TermServer>>): TermServer
Bind the term server, the |
|
abstract fun termHandler(handler: Handler<Term>): TermServer
Set the term handler that will receive incoming client connections. When a remote terminal connects the |