Package io.vertx.mutiny.ext.shell

Class ShellService

  • public class ShellService
extends Object
    The shell service, provides a remotely accessible shell available via Telnet or SSH according to the ShellServiceOptions configuration.

    The shell service will expose commands using CommandResolver on the classpath and the shared command registry for the Vert.x instance.

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

    • Constructor Detail

      • ShellService

        public ShellService​(io.vertx.ext.shell.ShellService delegate)

      • ShellService

        public ShellService​(Object delegate)

    • Method Detail

      • getDelegate

        public io.vertx.ext.shell.ShellService getDelegate()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • create

        public static ShellService create​(Vertx vertx)
        Parameters:
        vertx -
        Returns:

      • create

        public static ShellService create​(Vertx vertx,
                                  io.vertx.ext.shell.ShellServiceOptions options)
        Parameters:
        vertx - the Vert.x instance
        options - the service config options
        Returns:
        the shell service

      • start

        public io.smallrye.mutiny.Uni<Void> start()
        Start the shell service, this is an asynchronous start.

        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.

      • startAndAwait

        public Void startAndAwait()
        Blocking variant of start().

        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.

      • startAndForget

        public void startAndForget()
        Variant of start() that ignores the result of the operation.

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

      • server

        public ShellServer server()
        Returns:
        the shell server

      • stop

        public io.smallrye.mutiny.Uni<Void> stop()
        Stop the shell service, this is an asynchronous start.

        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.

      • stopAndAwait

        public Void stopAndAwait()
        Blocking variant of stop().

        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.

      • stopAndForget

        public void stopAndForget()
        Variant of stop() that ignores the result of the operation.

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

      • newInstance

        public static ShellService newInstance​(io.vertx.ext.shell.ShellService arg)