The shell server.<p/>
A shell server is associated with a collection of : the @see \io\vertx\jphp\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 @see \io\vertx\jphp\ext\shell\ShellServer::createShell method can be used to create instance for testing purposes.
| package |
Default |
|---|
__construct()
close( $arg0 = null) : void
close()
Close the shell server, this is an asynchronous close.
param $completionHandler [callable] handler for getting notified when service is stopped close($completionHandler)
callable
create( $arg0, $arg1 = null) : \io\vertx\jphp\ext\shell\ShellServer
param $vertx [Vertx] the vertx create($vertx)
Create a new shell server with default options.
param $vertx [Vertx] the vertx param $options [ShellServerOptions | array] the options create($vertx, $options)
Vertx
array | ShellServerOptions
\io\vertx\jphp\ext\shell\ShellServerthe created shell server
createShell( $arg0 = null) : \io\vertx\jphp\ext\shell\Shell
createShell()
Create a new shell, the returned shell should be closed explicitely.
param $term [Term] the shell associated terminal createShell($term)
Term
\io\vertx\jphp\ext\shell\Shellthe created shell
listen( $arg0 = null) : $this
listen()
Start the shell service, this is an asynchronous start.
param $listenHandler [callable] handler for getting notified when service is started listen($listenHandler)
callable
$this
registerCommandResolver( $arg0) : $this
CommandResolver
$thisa reference to this, so the API can be used fluently
registerTermServer( $arg0) : $this
TermServer
$thisa reference to this, so the API can be used fluently
shellHandler( $arg0) : void
callable