Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TermServer

A server for terminal based applications.

Hierarchy

  • TermServer

Index

Methods

actualPort

  • actualPort(): number
  • 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

    Returns number

authProvider

  • 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.

    Parameters

    • provider: AuthProvider

    Returns TermServer

close

  • close(): PromiseLike<void>
  • close(completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void
  • Like {@link TermServer#close} but supplying a handler that will be notified when close is complete.

    Returns PromiseLike<void>

  • Like {@link TermServer#close} but supplying a handler that will be notified when close is complete.

    Parameters

    • completionHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

listen

  • listen(): PromiseLike<void>
  • listen(listenHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): TermServer
  • Bind the term server, the {@link TermServer#termHandler} must be set before.

    Returns PromiseLike<void>

  • Bind the term server, the {@link TermServer#termHandler} must be set before.

    Parameters

    • listenHandler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns TermServer

termHandler

  • Set the term handler that will receive incoming client connections. When a remote terminal connects the handler will be called with the Term which can be used to interact with the remote terminal.

    Parameters

    • handler: ((res: Term) => void) | Handler<Term>

    Returns TermServer

Static createHttpTermServer

  • Create a term server for the HTTP protocol.

    Parameters

    • vertx: Vertx

    Returns TermServer

  • Create a term server for the HTTP protocol.

    Parameters

    Returns TermServer

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

    Parameters

    • vertx: Vertx
    • router: Router

    Returns TermServer

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

    Parameters

    Returns TermServer

Static createSSHTermServer

  • Create a term server for the SSH protocol.

    Parameters

    • vertx: Vertx

    Returns TermServer

  • Create a term server for the SSH protocol.

    Parameters

    Returns TermServer

Static createTelnetTermServer

  • Create a term server for the Telnet protocol.

    Parameters

    • vertx: Vertx

    Returns TermServer

  • Create a term server for the Telnet protocol.

    Parameters

    Returns TermServer

Generated using TypeDoc