Package io.vertx.mutiny.core.net

Class QuicClient

java.lang.Object
io.vertx.mutiny.core.net.QuicEndpoint
io.vertx.mutiny.core.net.QuicClient
All Implemented Interfaces:
MutinyDelegate, Measured
public class QuicClient extends QuicEndpoint implements MutinyDelegate
A Quic client.

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

Author:
Julien Viet
See Also:
  • QuicClient

  • Nested Class Summary

    Nested classes/interfaces inherited from interface io.vertx.mutiny.core.metrics.Measured

    Measured.MeasuredImpl

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final TypeArg<QuicClient>
    __TYPE_ARG
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    QuicClient(io.vertx.core.net.QuicClient delegate)
    Create a new instance of QuicClient delegating to the given (non-null) instance of QuicClient.
    QuicClient(Object delegate)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress>
    bind(io.vertx.core.net.SocketAddress arg0)
    Binds a UDP socket at the given address.
    io.vertx.core.net.SocketAddress
    bindAndAwait(io.vertx.core.net.SocketAddress arg0)
    Binds a UDP socket at the given address.
    QuicClient
    bindAndForget(io.vertx.core.net.SocketAddress arg0)
    Binds a UDP socket at the given address.
    io.smallrye.mutiny.Uni<Void>
    close()
    Close the endpoint and release all associated resources.
    void
    closeAndAwait()
    Close the endpoint and release all associated resources.
    QuicClient
    closeAndForget()
    Close the endpoint and release all associated resources.
    io.smallrye.mutiny.Uni<QuicConnection>
    connect(int port, String host)
    Connect to a Quic server at the specific port and host.
    io.smallrye.mutiny.Uni<QuicConnection>
    connect(int port, String host, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server at the specific port and host, with specific options.
    io.smallrye.mutiny.Uni<QuicConnection>
    connect(io.vertx.core.net.SocketAddress address)
    Connect to a Quic server.
    io.smallrye.mutiny.Uni<QuicConnection>
    connect(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server with specific options.
    QuicConnection
    connectAndAwait(int port, String host)
    Connect to a Quic server at the specific port and host.
    QuicConnection
    connectAndAwait(int port, String host, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server at the specific port and host, with specific options.
    QuicConnection
    connectAndAwait(io.vertx.core.net.SocketAddress address)
    Connect to a Quic server.
    QuicConnection
    connectAndAwait(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server with specific options.
    QuicClient
    connectAndForget(int port, String host)
    Connect to a Quic server at the specific port and host.
    QuicClient
    connectAndForget(int port, String host, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server at the specific port and host, with specific options.
    QuicClient
    connectAndForget(io.vertx.core.net.SocketAddress address)
    Connect to a Quic server.
    QuicClient
    connectAndForget(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
    Connect to a Quic server with specific options.
    boolean
    equals(Object o)
     
    io.vertx.core.net.QuicClient
    getDelegate()
    Get the delegate instance.
    int
    hashCode()
     
    boolean
    isMetricsEnabled()
    Whether the metrics are enabled for this measured object
    static QuicClient
    newInstance(io.vertx.core.net.QuicClient delegate)
    Creates a new instance of the QuicClient.
    io.smallrye.mutiny.Uni<Void>
    shutdown()
    Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).
    io.smallrye.mutiny.Uni<Void>
    shutdown(Duration arg0)
    Initiate the endpoint shutdown sequence.
    void
    shutdownAndAwait()
    Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).
    void
    shutdownAndAwait(Duration arg0)
    Initiate the endpoint shutdown sequence.
    QuicClient
    shutdownAndForget()
    Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).
    QuicClient
    shutdownAndForget(Duration arg0)
    Initiate the endpoint shutdown sequence.
    String
    toString()
     

    Methods inherited from class io.vertx.mutiny.core.net.QuicEndpoint

    newInstance

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • QuicClient

      public QuicClient(io.vertx.core.net.QuicClient delegate)
      Create a new instance of QuicClient delegating to the given (non-null) instance of QuicClient.

    • QuicClient

      public QuicClient(Object delegate)

  • Method Details

    • getDelegate

      public io.vertx.core.net.QuicClient getDelegate()
      Get the delegate instance.

      This method returns the instance on which this shim is delegating the calls. And so, give you access to the bare API.

      Specified by:
      getDelegate in interface Measured
      Specified by:
      getDelegate in interface MutinyDelegate
      Overrides:
      getDelegate in class QuicEndpoint
      Returns:
      the delegate instance

    • connect

      @CheckReturnValue public io.smallrye.mutiny.Uni<QuicConnection> connect(int port, String host)
      Connect to a Quic server at the specific port and host.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      port - the port
      host - the host
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicClient.connect(int, String)

    • connectAndAwait

      public QuicConnection connectAndAwait(int port, String host)
      Connect to a Quic server at the specific port and host.

      Unlike the bare Vert.x variant, this method returns a QuicConnection. This method awaits indefinitely 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
      host - the host
      Returns:
      The operation result
      See Also:
      • QuicClient.connect(int, String)

    • connectAndForget

      public QuicClient connectAndForget(int port, String host)
      Connect to a Quic server at the specific port and host.

      Unlike the bare Vert.x variant, this method ignores the QuicConnection result or any failure.

      Parameters:
      port - the port
      host - the host
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicClient.connect(int, String)

    • connect

      @CheckReturnValue public io.smallrye.mutiny.Uni<QuicConnection> connect(int port, String host, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server at the specific port and host, with specific options.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      port - the port
      host - the host
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicClient.connect(int, String, QuicConnectOptions)

    • connectAndAwait

      public QuicConnection connectAndAwait(int port, String host, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server at the specific port and host, with specific options.

      Unlike the bare Vert.x variant, this method returns a QuicConnection. This method awaits indefinitely 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
      host - the host
      Returns:
      The operation result
      See Also:
      • QuicClient.connect(int, String, QuicConnectOptions)

    • connectAndForget

      public QuicClient connectAndForget(int port, String host, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server at the specific port and host, with specific options.

      Unlike the bare Vert.x variant, this method ignores the QuicConnection result or any failure.

      Parameters:
      port - the port
      host - the host
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicClient.connect(int, String, QuicConnectOptions)

    • connect

      @CheckReturnValue public io.smallrye.mutiny.Uni<QuicConnection> connect(io.vertx.core.net.SocketAddress address)
      Connect to a Quic server.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      address - the server address
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicClient.connect(SocketAddress)

    • connectAndAwait

      public QuicConnection connectAndAwait(io.vertx.core.net.SocketAddress address)
      Connect to a Quic server.

      Unlike the bare Vert.x variant, this method returns a QuicConnection. This method awaits indefinitely 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:
      address - the server address
      Returns:
      The operation result
      See Also:
      • QuicClient.connect(SocketAddress)

    • connectAndForget

      public QuicClient connectAndForget(io.vertx.core.net.SocketAddress address)
      Connect to a Quic server.

      Unlike the bare Vert.x variant, this method ignores the QuicConnection result or any failure.

      Parameters:
      address - the server address
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicClient.connect(SocketAddress)

    • connect

      @CheckReturnValue public io.smallrye.mutiny.Uni<QuicConnection> connect(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server with specific options.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Parameters:
      address - the server address
      options - the connect options
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicClient.connect(SocketAddress, QuicConnectOptions)

    • connectAndAwait

      public QuicConnection connectAndAwait(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server with specific options.

      Unlike the bare Vert.x variant, this method returns a QuicConnection. This method awaits indefinitely 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:
      address - the server address
      options - the connect options
      Returns:
      The operation result
      See Also:
      • QuicClient.connect(SocketAddress, QuicConnectOptions)

    • connectAndForget

      public QuicClient connectAndForget(io.vertx.core.net.SocketAddress address, io.vertx.core.net.QuicConnectOptions options)
      Connect to a Quic server with specific options.

      Unlike the bare Vert.x variant, this method ignores the QuicConnection result or any failure.

      Parameters:
      address - the server address
      options - the connect options
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicClient.connect(SocketAddress, QuicConnectOptions)

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown()
      Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Overrides:
      shutdown in class QuicEndpoint
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicEndpoint.shutdown()

    • shutdownAndAwait

      public void shutdownAndAwait()
      Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Overrides:
      shutdownAndAwait in class QuicEndpoint
      See Also:
      • QuicEndpoint.shutdown()

    • shutdownAndForget

      public QuicClient shutdownAndForget()
      Shutdown the endpoint with a 30 seconds grace period (shutdown(30, TimeUnit.SECONDS)).

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Overrides:
      shutdownAndForget in class QuicEndpoint
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicEndpoint.shutdown()

    • shutdown

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> shutdown(Duration arg0)
      Initiate the endpoint shutdown sequence.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Overrides:
      shutdown in class QuicEndpoint
      Parameters:
      timeout - the amount of time after which all resources are forcibly closed
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicEndpoint.shutdown(Duration)

    • shutdownAndAwait

      public void shutdownAndAwait(Duration arg0)
      Initiate the endpoint shutdown sequence.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Overrides:
      shutdownAndAwait in class QuicEndpoint
      Parameters:
      timeout - the amount of time after which all resources are forcibly closed
      See Also:
      • QuicEndpoint.shutdown(Duration)

    • shutdownAndForget

      public QuicClient shutdownAndForget(Duration arg0)
      Initiate the endpoint shutdown sequence.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Overrides:
      shutdownAndForget in class QuicEndpoint
      Parameters:
      timeout - the amount of time after which all resources are forcibly closed
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicEndpoint.shutdown(Duration)

    • bind

      @CheckReturnValue public io.smallrye.mutiny.Uni<io.vertx.core.net.SocketAddress> bind(io.vertx.core.net.SocketAddress arg0)
      Binds a UDP socket at the given address.

      >When the endpoint is successfully bound, a</p

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Overrides:
      bind in class QuicEndpoint
      Parameters:
      address - the bind address
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicEndpoint.bind(SocketAddress)

    • bindAndAwait

      public io.vertx.core.net.SocketAddress bindAndAwait(io.vertx.core.net.SocketAddress arg0)
      Binds a UDP socket at the given address.

      >When the endpoint is successfully bound, a</p

      Unlike the bare Vert.x variant, this method returns a SocketAddress. This method awaits indefinitely 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).

      Overrides:
      bindAndAwait in class QuicEndpoint
      Parameters:
      address - the bind address
      Returns:
      The operation result
      See Also:
      • QuicEndpoint.bind(SocketAddress)

    • bindAndForget

      public QuicClient bindAndForget(io.vertx.core.net.SocketAddress arg0)
      Binds a UDP socket at the given address.

      >When the endpoint is successfully bound, a</p

      Unlike the bare Vert.x variant, this method ignores the SocketAddress result or any failure.

      Overrides:
      bindAndForget in class QuicEndpoint
      Parameters:
      address - the bind address
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicEndpoint.bind(SocketAddress)

    • close

      @CheckReturnValue public io.smallrye.mutiny.Uni<Void> close()
      Close the endpoint and release all associated resources.

      Unlike the bare Vert.x variant, this method returns a Uni. The uni emits the result of the operation as item. If the operation fails, the uni emits the failure.

      Don't forget to subscribe on it to trigger the operation.

      Overrides:
      close in class QuicEndpoint
      Returns:
      A Uni representing the asynchronous result of this operation.
      See Also:
      • QuicEndpoint.close()

    • closeAndAwait

      public void closeAndAwait()
      Close the endpoint and release all associated resources.

      Unlike the bare Vert.x variant, this method returns a Void. This method awaits indefinitely 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).

      Overrides:
      closeAndAwait in class QuicEndpoint
      See Also:
      • QuicEndpoint.close()

    • closeAndForget

      public QuicClient closeAndForget()
      Close the endpoint and release all associated resources.

      Unlike the bare Vert.x variant, this method ignores the Void result or any failure.

      Overrides:
      closeAndForget in class QuicEndpoint
      Returns:
      The current instance to chain operations if needed.
      See Also:
      • QuicEndpoint.close()

    • isMetricsEnabled

      public boolean isMetricsEnabled()
      Whether the metrics are enabled for this measured object
      Specified by:
      isMetricsEnabled in interface Measured
      Overrides:
      isMetricsEnabled in class QuicEndpoint
      Returns:
      true if metrics are enabled

    • newInstance

      public static QuicClient newInstance(io.vertx.core.net.QuicClient delegate)
      Creates a new instance of the QuicClient.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QuicEndpoint

    • equals

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

    • toString

      public String toString()
      Overrides:
      toString in class QuicEndpoint