Class NetServer

java.lang.Object
io.vertx.reactivex.core.net.NetServer
All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate, Measured
public class NetServer extends Object implements io.vertx.lang.rx.RxDelegate, Measured
Represents a TCP 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<NetServer> __TYPE_ARG

  • Constructor Details

    • NetServer

      public NetServer(NetServer delegate)

    • NetServer

      public NetServer(Object delegate)

  • Method Details

    • 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

    • getDelegate

      public NetServer getDelegate()
      Specified by:
      getDelegate in interface Measured
      Specified by:
      getDelegate in interface io.vertx.lang.rx.RxDelegate

    • isMetricsEnabled

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

    • connectHandler

      public NetServer connectHandler(Handler<NetSocket> handler)
      Supply a connect handler for this server. The server can only have at most one connect handler at any one time. As the server accepts TCP or SSL connections it creates an instance of NetSocket and passes it to the connect handler.
      Parameters:
      handler -
      Returns:
      a reference to this, so the API can be used fluently

    • listen

      public Future<NetServer> listen()
      Start listening on the port and host as configured in the NetServerOptions used when creating the server.

      The server may not be listening until some time after the call to listen has returned.

      Returns:
      a future completed with the listen operation result

    • rxListen

      public Single<NetServer> rxListen()
      Start listening on the port and host as configured in the NetServerOptions used when creating the server.

      The server may not be listening until some time after the call to listen has returned.

      Returns:
      a future completed with the listen operation result

    • listen

      public Future<NetServer> listen(int port, String host)
      Start listening on the specified port and host, ignoring port and host configured in the NetServerOptions used when creating the server.

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

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

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      port -
      host -
      Returns:
      a future completed with the listen operation result

    • rxListen

      public Single<NetServer> rxListen(int port, String host)
      Start listening on the specified port and host, ignoring port and host configured in the NetServerOptions used when creating the server.

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

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

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      port -
      host -
      Returns:
      a future completed with the listen operation result

    • listen

      public Future<NetServer> listen(int port)
      Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the NetServerOptions used when creating the server.

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

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      port -
      Returns:
      a future completed with the listen operation result

    • rxListen

      public Single<NetServer> rxListen(int port)
      Start listening on the specified port and host "0.0.0.0", ignoring port and host configured in the NetServerOptions used when creating the server.

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

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      port -
      Returns:
      a future completed with the listen operation result

    • listen

      public Future<NetServer> listen(SocketAddress localAddress)
      Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      localAddress - the local address to listen on
      Returns:
      a future completed with the listen operation result

    • rxListen

      public Single<NetServer> rxListen(SocketAddress localAddress)
      Start listening on the specified local address, ignoring port and host configured in the NetServerOptions used when creating the server.

      The server may not be listening until some time after the call to listen has returned.

      Parameters:
      localAddress - the local address to listen on
      Returns:
      a future completed with the listen operation result

    • close

      public Future<Void> close()
      Close the server. This will close any currently open connections. The close may not complete until after this method has returned.
      Returns:
      a future completed with the listen operation result

    • rxClose

      public Completable rxClose()
      Close the server. This will close any currently open connections. The close may not complete until after this method has returned.
      Returns:
      a future completed with the listen operation result

    • shutdown

      public Future<Void> shutdown()
      Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
      Returns:
      a future completed when shutdown has completed

    • rxShutdown

      public Completable rxShutdown()
      Shutdown with a 30 seconds timeout (shutdown(30, TimeUnit.SECONDS)).
      Returns:
      a future completed when shutdown has completed

    • shutdown

      public Future<Void> shutdown(long timeout, TimeUnit unit)
      Calls shutdown().
      Parameters:
      timeout -
      unit -
      Returns:

    • rxShutdown

      public Completable rxShutdown(long timeout, TimeUnit unit)
      Calls shutdown().
      Parameters:
      timeout -
      unit -
      Returns:

    • actualPort

      public int actualPort()
      The actual port the server is listening on. This is useful if you bound the server specifying 0 as port number signifying an ephemeral port
      Returns:
      the actual port the server is listening on.

    • updateSSLOptions

      public Future<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 Future<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

    • updateTrafficShapingOptions

      public Future<Boolean> updateTrafficShapingOptions(TrafficShapingOptions options)

      Update the server with new traffic 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 traffic shaping options
      Returns:
      a future signaling the update success

    • rxUpdateTrafficShapingOptions

      public Single<Boolean> rxUpdateTrafficShapingOptions(TrafficShapingOptions options)

      Update the server with new traffic 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 traffic shaping options
      Returns:
      a future signaling the update success

    • shutdown

      public Future<Void> shutdown(Duration timeout)
      Initiate the server shutdown sequence.

      Connections are taken out of service and notified the close sequence has started through NetSocket.shutdownHandler(Handler). When all connections are closed the client is closed. When the timeout expires, all unclosed connections are immediately closed.

      Parameters:
      timeout - the amount of time after which all resources are forcibly closed
      Returns:
      a future notified when the client is closed

    • rxShutdown

      public Completable rxShutdown(Duration timeout)
      Initiate the server shutdown sequence.

      Connections are taken out of service and notified the close sequence has started through NetSocket.shutdownHandler(Handler). When all connections are closed the client is closed. When the timeout expires, all unclosed connections are immediately closed.

      Parameters:
      timeout - the amount of time after which all resources are forcibly closed
      Returns:
      a future notified when the client is closed

    • newInstance

      public static NetServer newInstance(NetServer arg)