Class QuicServer

java.lang.Object
io.vertx.rxjava3.core.net.QuicEndpoint
io.vertx.rxjava3.core.net.QuicServer
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate, Measured
public class QuicServer extends QuicEndpoint implements io.vertx.lang.rx.RxDelegate
A Quic server.

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

  • Field Details

    • __TYPE_ARG

      public static final io.vertx.lang.rx.TypeArg<QuicServer> __TYPE_ARG

  • Constructor Details

    • QuicServer

      public QuicServer(QuicServer delegate)

    • QuicServer

      public QuicServer(Object delegate)

  • Method Details

    • toString

      public String toString()
      Overrides:
      toString in class QuicEndpoint

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class QuicEndpoint

    • getDelegate

      public QuicServer getDelegate()
      Specified by:
      getDelegate in interface Measured
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate
      Overrides:
      getDelegate in class QuicEndpoint

    • 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

    • connectHandler

      public QuicServer connectHandler(Handler<QuicConnection> handler)
      Set the handler processing QuicConnection, the handler must be set before the server is bound.
      Parameters:
      handler - the connection handler
      Returns:
      this object instance

    • streamHandler

      public QuicServer streamHandler(Handler<QuicStream> handler)
      Set a handler processing incoming Quic streams, this is a short-cut of server.connectHandler(connection -> connection.streamHandler(stream)).
      Parameters:
      handler - the handler processing streams
      Returns:
      this object instance

    • exceptionHandler

      public QuicServer exceptionHandler(Handler<Throwable> handler)
      Set an exception handler called for socket errors happening before the QUIC connection is established, e.g. during the TLS handshake.
      Parameters:
      handler - the handler to set
      Returns:
      a reference to this, so the API can be used fluently

    • listen

      public Single<SocketAddress> listen()
      Start listening on the port and host as configured in the QuicServerConfig used when creating the server.
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • rxListen

      public Single<SocketAddress> rxListen()
      Start listening on the port and host as configured in the QuicServerConfig used when creating the server.
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • listen

      public Single<SocketAddress> listen(int port, String host)
      Start listening on the specified port and host.

      Port 0 can be specified meaning "choose a random port".

      Host 0.0.0.0 can be specified meaning "listen on all available interfaces".

      Parameters:
      port -
      host -
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • rxListen

      public Single<SocketAddress> rxListen(int port, String host)
      Start listening on the specified port and host.

      Port 0 can be specified meaning "choose a random port".

      Host 0.0.0.0 can be specified meaning "listen on all available interfaces".

      Parameters:
      port -
      host -
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • listen

      public Single<SocketAddress> listen(int port)
      Start listening on the specified port and host "0.0.0.0".

      Port 0 can be specified meaning "choose an random port".

      Parameters:
      port -
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • rxListen

      public Single<SocketAddress> rxListen(int port)
      Start listening on the specified port and host "0.0.0.0".

      Port 0 can be specified meaning "choose an random port".

      Parameters:
      port -
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • listen

      public Single<SocketAddress> listen(SocketAddress localAddress)
      Start listening on the specified local address.
      Parameters:
      localAddress - the local address to listen on
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • rxListen

      public Single<SocketAddress> rxListen(SocketAddress localAddress)
      Start listening on the specified local address.
      Parameters:
      localAddress - the local address to listen on
      Returns:
      a future signaling the success or failure of the listen operation, the result is socket address this endpoint is bound to

    • updateSSLOptions

      public Single<Boolean> updateSSLOptions(ServerSSLOptions options)

      Update the server with new SSL options, the update happens if the options object is valid and different from the existing options object.

      The boolean succeeded future result indicates whether the update occurred.

      Parameters:
      options - the new SSL options
      Returns:
      a future signaling the update success

    • rxUpdateSSLOptions

      public Single<Boolean> rxUpdateSSLOptions(ServerSSLOptions options)

      Update the server with new SSL options, the update happens if the options object is valid and different from the existing options object.

      The boolean succeeded future result indicates whether the update occurred.

      Parameters:
      options - the new SSL options
      Returns:
      a future signaling the update success

    • updateSSLOptions

      public Single<Boolean> updateSSLOptions(ServerSSLOptions options, boolean force)

      Update the server with new SSL options, the update happens if the options object is valid and different from the existing options object.

      The options object is compared using its equals method against the existing options to prevent an update when the objects are equals since loading options can be costly, this can happen for share TCP servers. When object are equals, setting force to true forces the update.

      The boolean succeeded future result indicates whether the update occurred.

      Parameters:
      options - the new SSL options
      force - force the update when options are equals
      Returns:
      a future signaling the update success

    • rxUpdateSSLOptions

      public Single<Boolean> rxUpdateSSLOptions(ServerSSLOptions options, boolean force)

      Update the server with new SSL options, the update happens if the options object is valid and different from the existing options object.

      The options object is compared using its equals method against the existing options to prevent an update when the objects are equals since loading options can be costly, this can happen for share TCP servers. When object are equals, setting force to true forces the update.

      The boolean succeeded future result indicates whether the update occurred.

      Parameters:
      options - the new SSL options
      force - force the update when options are equals
      Returns:
      a future signaling the update success

    • newInstance

      public static QuicServer newInstance(QuicServer arg)