Packages

class ShellServer extends AnyRef

The shell server.

A shell server is associated with a collection of : the io.vertx.scala.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.scala.ext.shell.ShellServer#createShell method can be used to create instance for testing purposes.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ShellServer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ShellServer(_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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava: AnyRef
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def close(completionHandler: Handler[AsyncResult[Unit]]): Unit

    Close the shell server, this is an asynchronous close.

    Close the shell server, this is an asynchronous close. * @param completionHandler handler for getting notified when service is stopped

  8. def close(): Unit

    Close the shell server, this is an asynchronous close.

  9. def closeFuture(): Future[Unit]

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

  10. def createShell(): Shell

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

    Create a new shell, the returned shell should be closed explicitely. * @return the created shell

  11. def createShell(term: Term): Shell

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

    Create a new shell, the returned shell should be closed explicitely. * @param term the shell associated terminal

    returns

    the created shell

  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[Unit]]): ShellServer

    Start the shell service, this is an asynchronous start.

    Start the shell service, this is an asynchronous start. * @param listenHandler handler for getting notified when service is started

  19. def listen(): ShellServer

    Start the shell service, this is an asynchronous start.

  20. def listenFuture(): Future[Unit]

    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. def registerCommandResolver(resolver: CommandResolver): ShellServer

    Register a command resolver for this server.

    Register a command resolver for this server. * @param resolver the resolver

    returns

    a reference to this, so the API can be used fluently

  25. def registerTermServer(termServer: TermServer): ShellServer

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

    Register a term server to this shell server, the term server lifecycle methods are managed by this shell server. * @param termServer the term server to add

    returns

    a reference to this, so the API can be used fluently

  26. def shellHandler(shellHandler: Handler[Shell]): Unit

    Called when a new shell is created.

    Called when a new shell is created. Can be used to prepopulate the shell session with objects or set the prompt. * @param shellHandler handler for getting notified when the server creates a new shell.

  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped