Package io.vertx.mutiny.ext.shell.term

Class TermServer

java.lang.Object
io.vertx.mutiny.ext.shell.term.TermServer
All Implemented Interfaces:
MutinyDelegate
public class TermServer extends Object implements MutinyDelegate
A server for terminal based applications.

NOTE: This class has been automatically generated from the original non Mutiny-ified interface using Vert.x codegen.

  • Field Details

  • Constructor Details

    • TermServer

      public TermServer(io.vertx.ext.shell.term.TermServer delegate)

    • TermServer

      public TermServer(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.ext.shell.term.TermServer getDelegate()
      Specified by:
      getDelegate in interface MutinyDelegate
      Returns:
      the delegate used by this Mutiny object of generated type

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • createSSHTermServer

      public static TermServer createSSHTermServer(Vertx vertx)
      Parameters:
      vertx - the vertx instance
      Returns:
      the term server

    • createSSHTermServer

      public static TermServer createSSHTermServer(Vertx vertx, io.vertx.ext.shell.term.SSHTermOptions options)
      Parameters:
      vertx - the vertx instance
      options - the ssh options
      Returns:
      the term server

    • createTelnetTermServer

      public static TermServer createTelnetTermServer(Vertx vertx)
      Parameters:
      vertx - the vertx instance
      Returns:
      the term server

    • createTelnetTermServer

      public static TermServer createTelnetTermServer(Vertx vertx, io.vertx.ext.shell.term.TelnetTermOptions options)
      Parameters:
      vertx - the vertx instance
      options - the term options
      Returns:
      the term server

    • createHttpTermServer

      public static TermServer createHttpTermServer(Vertx vertx)
      Parameters:
      vertx - the vertx instance
      Returns:
      the term server

    • createHttpTermServer

      public static TermServer createHttpTermServer(Vertx vertx, io.vertx.ext.shell.term.HttpTermOptions options)
      Parameters:
      vertx - the vertx instance
      options - the term options
      Returns:
      the term server

    • createHttpTermServer

      public static TermServer createHttpTermServer(Vertx vertx, Router router)
      Parameters:
      vertx - the vertx instance
      router - the router
      Returns:
      the term server

    • createHttpTermServer

      public static TermServer createHttpTermServer(Vertx vertx, Router router, io.vertx.ext.shell.term.HttpTermOptions options)
      Parameters:
      vertx - the vertx instance
      router - the router
      options - the term options
      Returns:
      the term server

    • termHandler

      public TermServer termHandler(Consumer<Term> handler)
      Parameters:
      handler - the term handler
      Returns:

    • authProvider

      @Deprecated public TermServer authProvider(AuthProvider provider)
      Deprecated.
      See authenticationProvider(AuthenticationProvider) 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 - the auth to use
      Returns:
      this object

    • authenticationProvider

      public TermServer authenticationProvider(AuthenticationProvider provider)
      Parameters:
      provider - the auth to use
      Returns:
      this object

    • listen

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> listen()
      Bind the term server, the termHandler(java.util.function.Consumer<io.vertx.mutiny.ext.shell.term.Term>) must be set before.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • listenAndAwait

      public Void listenAndAwait()
      Blocking variant of listen().

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      the Void instance produced by the operation.

    • listenAndForget

      public TermServer listenAndForget()
      Variant of listen() that ignores the result of the operation.

      This method subscribes on the result of listen(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from listen() but you don't need to compose it with other operations.

      Returns:
      the instance of TermServer to chain method calls.

    • actualPort

      public int actualPort()
      Returns:
      the actual port the server is listening on.

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Like close() but supplying a handler that will be notified when close is complete.

      Unlike the bare Vert.x variant, this method returns a Uni. Don't forget to subscribe on it to trigger the operation.

      Returns:
      the uni firing the result of the operation when completed, or a failure if the operation failed.

    • closeAndAwait

      public Void closeAndAwait()
      Blocking variant of close().

      This method waits for the completion of the underlying asynchronous operation. If the operation completes successfully, the result is returned, otherwise the failure is thrown (potentially wrapped in a RuntimeException).

      Returns:
      the Void instance produced by the operation.

    • closeAndForget

      public void closeAndForget()
      Variant of close() that ignores the result of the operation.

      This method subscribes on the result of close(), but discards the outcome (item or failure). This method is useful to trigger the asynchronous operation from close() but you don't need to compose it with other operations.

    • newInstance

      public static TermServer newInstance(io.vertx.ext.shell.term.TermServer arg)