vertx-lang-scala-docs_2.12 3.5.2.CR2 API < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package io
  Definition Classes
    root
-  package vertx
  Definition Classes
    io
-  package scala
  Definition Classes
    vertx
-  package ext
  Definition Classes
    scala
-  package shell
  Definition Classes
    ext
-  package term
  Definition Classes
    shell
- HttpTermOptions
- Pty
- SSHTermOptions
- SignalHandler
- SockJSTermHandler
- TelnetTermOptions
- Term
- TermServer
- Tty

c

io.vertx.scala.ext.shell.term

# TermServer 

###
Companion object TermServer

#### class TermServer extends AnyRef

A server for terminal based applications.

Linear Supertypes
AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. TermServer
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new TermServer(_asJava: AnyRef)

### Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  def actualPort(): Int

   The actual port the server is listening on.

   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

     the actual port the server is listening on.

5.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
6.  def asJava: AnyRef
7.  def authProvider(provider: AuthProvider): TermServer

   Set an auth provider to use, any provider configured in options will override this provider.

   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.

   provider

     the auth to use

   returns

     this object

8.  def clone(): AnyRef
   Attributes
     protected[java.lang]
   Definition Classes
     AnyRef
   Annotations
     @native() @throws( ... )
9.  def close(completionHandler: Handler[AsyncResult[Unit]]): Unit

   Like io.vertx.scala.ext.shell.term.TermServer#close but supplying a handler that will be notified when close is complete.

   Like io.vertx.scala.ext.shell.term.TermServer#close but supplying a handler that will be notified when close is complete.

   completionHandler

     the handler to be notified when the term server is closed

10.  def close(): Unit

    Close the server.

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

11.  def closeFuture(): Future[Unit]

    Like close but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

12.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  def equals(arg0: Any): Boolean
    Definition Classes
      AnyRef → Any
14.  def finalize(): Unit
    Attributes
      protected[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws( classOf[java.lang.Throwable] )
15.  final def getClass(): Class[_]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
16.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
18.  def listen(listenHandler: Handler[AsyncResult[TermServer]]): TermServer

    Bind the term server, the io.vertx.scala.ext.shell.term.TermServer#termHandler must be set before.

    Bind the term server, the io.vertx.scala.ext.shell.term.TermServer#termHandler must be set before.

    listenHandler

      the listen handler

    returns

      this object

19.  def listen(): TermServer

    Bind the term server, the io.vertx.scala.ext.shell.term.TermServer#termHandler must be set before.

    Bind the term server, the io.vertx.scala.ext.shell.term.TermServer#termHandler must be set before.

    returns

      this object

20.  def listenFuture(): Future[TermServer]

    Like listen but returns a scala.concurrent.Future instead of taking an AsyncResultHandler.

21.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
22.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
23.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
24.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
25.  def termHandler(handler: Handler[Term]): TermServer

    Set the term handler that will receive incoming client connections.

    Set the term handler that will receive incoming client connections. When a remote terminal connects the `handler` will be called with the io.vertx.scala.ext.shell.term.Term which can be used to interact with the remote terminal.

    handler

      the term handler

    returns

      this object

26.  def toString(): String
    Definition Classes
      AnyRef → Any
27.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
28.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
29.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @throws( ... )

### Inherited from AnyRef

### Inherited from Any

### Ungrouped