API Documentation
Back to top  

TermServer

A server for terminal based applications.

package

Default

Methods

__construct

__construct()

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

actualPort() : integer

Response

integer

the actual port the server is listening on.

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.

authProvider( $arg0) : $this

Arguments

$arg0

AuthProvider

Response

$this

this object

Close the server. This will close any currently open connections. The close may not complete until after this method has returned.

close( $arg0 = null) : void

close()

Like @see \io\vertx\jphp\ext\shell\term\TermServer::close but supplying a handler that will be notified when close is complete.

param $completionHandler [callable] the handler to be notified when the term server is closed close($completionHandler)

Arguments

$arg0

callable

Create a term server for the HTTP protocol.

createHttpTermServer( $arg0,  $arg1 = null,  $arg2 = null) : \io\vertx\jphp\ext\shell\term\TermServer
static

param $vertx [Vertx] the vertx instance createHttpTermServer($vertx)

Create a term server for the HTTP protocol.

param $vertx [Vertx] the vertx instance param $options [HttpTermOptions | array] the term options createHttpTermServer($vertx, $options)

Create a term server for the HTTP protocol, using an existing router.

param $vertx [Vertx] the vertx instance param $router [Router] the router createHttpTermServer($vertx, $router)

Create a term server for the HTTP protocol, using an existing router.

param $vertx [Vertx] the vertx instance param $router [Router] the router param $options [HttpTermOptions | array] the term options createHttpTermServer($vertx, $router, $options)

Arguments

$arg0

Vertx

$arg1

HttpTermOptions | array | Router

$arg2

HttpTermOptions | array

Response

\io\vertx\jphp\ext\shell\term\TermServer

the term server

Create a term server for the SSH protocol.

createSSHTermServer( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\shell\term\TermServer
static

param $vertx [Vertx] the vertx instance createSSHTermServer($vertx)

Create a term server for the SSH protocol.

param $vertx [Vertx] the vertx instance param $options [SSHTermOptions | array] the ssh options createSSHTermServer($vertx, $options)

Arguments

$arg0

Vertx

$arg1

array | SSHTermOptions

Response

\io\vertx\jphp\ext\shell\term\TermServer

the term server

Create a term server for the Telnet protocol.

createTelnetTermServer( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\shell\term\TermServer
static

param $vertx [Vertx] the vertx instance createTelnetTermServer($vertx)

Create a term server for the Telnet protocol.

param $vertx [Vertx] the vertx instance param $options [TelnetTermOptions | array] the term options createTelnetTermServer($vertx, $options)

Arguments

$arg0

Vertx

$arg1

TelnetTermOptions | array

Response

\io\vertx\jphp\ext\shell\term\TermServer

the term server

Bind the term server, the @see \io\vertx\jphp\ext\shell\term\TermServer::termHandler must be set before.

listen( $arg0 = null) : $this

listen()

Bind the term server, the @see \io\vertx\jphp\ext\shell\term\TermServer::termHandler must be set before.

param $listenHandler [callable] the listen handler listen($listenHandler)

Arguments

$arg0

callable

Response

$this

this object

Set the term handler that will receive incoming client connections. When a remote terminal connects the <code>handler</code> will be called with the @see \io\vertx\jphp\ext\shell\term\Term which can be used to interact with the remote terminal.

termHandler( $arg0) : $this

Arguments

$arg0

callable

Response

$this

this object