Class NetServer

  • All Implemented Interfaces:
    Measured

    public class NetServer
    extends Object
    implements Measured
    Represents a TCP server

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

    • Constructor Detail

      • NetServer

        public NetServer​(io.vertx.core.net.NetServer delegate)
      • NetServer

        public NetServer​(Object delegate)
    • Method Detail

      • getDelegate

        public io.vertx.core.net.NetServer getDelegate()
        Specified by:
        getDelegate in interface Measured
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • isMetricsEnabled

        public boolean isMetricsEnabled()
        Specified by:
        isMetricsEnabled in interface Measured
        Returns:
        true if metrics are enabled
      • listen

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<NetServer> listen()
        Like listen() but providing a handler that will be notified when the server is listening, or fails.

        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 NetServer 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 NetServer instance produced by the operation.
      • listenAndForget

        public NetServer 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 NetServer to chain method calls.
      • listen

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<NetServer> listen​(int port,
                                                        String host)
        Like listen() but providing a handler that will be notified when the server is listening, or fails.

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

        Parameters:
        port - the port to listen on
        host - the host to listen on
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • listenAndAwait

        public NetServer listenAndAwait​(int port,
                                        String host)
        Blocking variant of listen(int,String).

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

        Parameters:
        port - the port to listen on
        host - the host to listen on
        Returns:
        the NetServer instance produced by the operation.
      • listenAndForget

        public NetServer listenAndForget​(int port,
                                         String host)
        Variant of listen(int,String) that ignores the result of the operation.

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

        Parameters:
        port - the port to listen on
        host - the host to listen on
        Returns:
        the instance of NetServer to chain method calls.
      • listen

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<NetServer> listen​(int port)
        Like listen() but providing a handler that will be notified when the server is listening, or fails.

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

        Parameters:
        port - the port to listen on
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • listenAndAwait

        public NetServer listenAndAwait​(int port)
        Blocking variant of listen(int).

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

        Parameters:
        port - the port to listen on
        Returns:
        the NetServer instance produced by the operation.
      • listenAndForget

        public NetServer listenAndForget​(int port)
        Variant of listen(int) that ignores the result of the operation.

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

        Parameters:
        port - the port to listen on
        Returns:
        the instance of NetServer to chain method calls.
      • listen

        @CheckReturnValue
        public io.smallrye.mutiny.Uni<NetServer> listen​(SocketAddress localAddress)
        Like listen() but providing a handler that will be notified when the server is listening, or fails.

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

        Parameters:
        localAddress - the local address to listen on
        Returns:
        the uni firing the result of the operation when completed, or a failure if the operation failed.
      • listenAndAwait

        public NetServer listenAndAwait​(SocketAddress localAddress)
        Blocking variant of listen(io.vertx.mutiny.core.net.SocketAddress).

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

        Parameters:
        localAddress - the local address to listen on
        Returns:
        the NetServer instance produced by the operation.
      • 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.

      • actualPort

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

        public static NetServer newInstance​(io.vertx.core.net.NetServer arg)