vertx / io.vertx.reactivex.ext.shell.term / TermServer

# TermServer

`open class TermServer`

A server for terminal based applications. NOTE: This class has been automatically generated from the io.vertx.ext.shell.term.TermServer non RX-ified interface using Vert.x codegen.

### Constructors

<init> | `TermServer(delegate: TermServer)`

### Properties

__TYPE_ARG | `static val __TYPE_ARG: TypeArg<TermServer>`

### Functions

actualPort | `open 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
authProvider | `open 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.
close | `open fun close(): Unit` Close the server. This will close any currently open connections. The close may not complete until after this method has returned. `open fun close(completionHandler: Handler<AsyncResult<Void>>): Unit` Like `io.vertx.reactivex.ext.shell.term.TermServer#close` but supplying a handler that will be notified when close is complete.
createHttpTermServer | `open static fun createHttpTermServer(vertx: Vertx): TermServer` `open static fun createHttpTermServer(vertx: Vertx, options: HttpTermOptions): TermServer` Create a term server for the HTTP protocol. `open static fun createHttpTermServer(vertx: Vertx, router: Router): TermServer` `open static fun createHttpTermServer(vertx: Vertx, router: Router, options: HttpTermOptions): TermServer` Create a term server for the HTTP protocol, using an existing router.
createSSHTermServer | `open static fun createSSHTermServer(vertx: Vertx): TermServer` `open static fun createSSHTermServer(vertx: Vertx, options: SSHTermOptions): TermServer` Create a term server for the SSH protocol.
createTelnetTermServer | `open static fun createTelnetTermServer(vertx: Vertx): TermServer` `open static fun createTelnetTermServer(vertx: Vertx, options: TelnetTermOptions): TermServer` Create a term server for the Telnet protocol.
equals | `open fun equals(other: Any?): Boolean`
getDelegate | `open fun getDelegate(): TermServer`
hashCode | `open fun hashCode(): Int`
listen | `open fun listen(): TermServer` `open fun listen(listenHandler: Handler<AsyncResult<TermServer>>): TermServer` Bind the term server, the `io.vertx.reactivex.ext.shell.term.TermServer#termHandler` must be set before.
newInstance | `open static fun newInstance(arg: TermServer): TermServer`
rxClose | `open fun rxClose(): Completable` Like `io.vertx.reactivex.ext.shell.term.TermServer#close` but supplying a handler that will be notified when close is complete.
rxListen | `open fun rxListen(): Single<TermServer>` Bind the term server, the `io.vertx.reactivex.ext.shell.term.TermServer#termHandler` must be set before.
termHandler | `open fun termHandler(handler: Handler<Term>): TermServer` Set the term handler that will receive incoming client connections. When a remote terminal connects the `handler` will be called with the io.vertx.reactivex.ext.shell.term.Term which can be used to interact with the remote terminal.
toString | `open fun toString(): String`