vertx / io.vertx.rxjava.ext.shell / ShellServer

ShellServer

open class ShellServer

The shell server. A shell server is associated with a collection of : the io.vertx.rxjava.ext.shell.ShellServer#registerTermServer 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 io.vertx.rxjava.ext.shell.ShellServer#createShell method can be used to create instance for testing purposes. NOTE: This class has been automatically generated from the io.vertx.ext.shell.ShellServer non RX-ified interface using Vert.x codegen.

Constructors

<init>

ShellServer(delegate: ShellServer)

Properties

__TYPE_ARG

static val __TYPE_ARG: TypeArg<ShellServer>

Functions

close

open fun close(): Unit
open fun close(completionHandler: Handler<AsyncResult<Void>>): Unit

Close the shell server, this is an asynchronous close.

create

open static fun create(vertx: Vertx, options: ShellServerOptions): ShellServer

Create a new shell server with default options.

open static fun create(vertx: Vertx): ShellServer

Create a new shell server with specific options.

createShell

open fun createShell(term: Term): Shell
open fun createShell(): Shell

Create a new shell, the returned shell should be closed explicitely.

equals

open fun equals(other: Any?): Boolean

getDelegate

open fun getDelegate(): ShellServer

hashCode

open fun hashCode(): Int

listen

open fun listen(): ShellServer
open fun listen(listenHandler: Handler<AsyncResult<Void>>): ShellServer

Start the shell service, this is an asynchronous start.

newInstance

open static fun newInstance(arg: ShellServer): ShellServer

registerCommandResolver

open fun registerCommandResolver(resolver: CommandResolver): ShellServer

Register a command resolver for this server.

registerTermServer

open fun registerTermServer(termServer: TermServer): ShellServer

Register a term server to this shell server, the term server lifecycle methods are managed by this shell server.

rxClose

open fun rxClose(): Single<Void>

Close the shell server, this is an asynchronous close.

rxListen

open fun rxListen(): Single<Void>

Start the shell service, this is an asynchronous start.

toString

open fun toString(): String