NetServer (Vert.x Stack - Docs 4.5.11 API)

java.lang.Object
- io.vertx.rxjava3.core.net.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 RX-ified interface using Vert.x codegen.

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<NetServer> __TYPE_ARG

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<NetServer>`	`__TYPE_ARG`

Constructor Summary

Constructors
Constructor and Description

NetServer(NetServer delegate)

NetServer(Object delegate)

Constructors
Constructor and Description
`NetServer(NetServer delegate)`
`NetServer(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`actualPort()` The actual port the server is listening on.
`Completable`	`close()` Like `close()` but supplying a handler that will be notified when close is complete.
`NetServer`	`connectHandler(Handler<NetSocket> handler)` Supply a connect handler for this server.
`ReadStream<NetSocket>`	`connectStream()` Deprecated.
`boolean`	`equals(Object o)`
`NetServer`	`getDelegate()`
`int`	`hashCode()`
`boolean`	`isMetricsEnabled()` Whether the metrics are enabled for this measured object
`Single<NetServer>`	`listen()` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`listen(int port)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`listen(int port, String host)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`listen(SocketAddress localAddress)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`static NetServer`	`newInstance(NetServer arg)`
`Completable`	`rxClose()` Like `close()` but supplying a handler that will be notified when close is complete.
`Single<NetServer>`	`rxListen()` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`rxListen(int port)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`rxListen(int port, String host)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<NetServer>`	`rxListen(SocketAddress localAddress)` Like `listen()` but providing a handler that will be notified when the server is listening, or fails.
`Single<Boolean>`	`rxUpdateSSLOptions(SSLOptions options)` Like `updateSSLOptions(io.vertx.core.net.SSLOptions)` but supplying a handler that will be called when the update happened (or has failed).
`Single<Boolean>`	`rxUpdateSSLOptions(SSLOptions options, boolean force)` Like `updateSSLOptions(io.vertx.core.net.SSLOptions)` but supplying a handler that will be called when the update happened (or has failed).
`String`	`toString()`
`Single<Boolean>`	`updateSSLOptions(SSLOptions options)` Like `updateSSLOptions(io.vertx.core.net.SSLOptions)` but supplying a handler that will be called when the update happened (or has failed).
`Single<Boolean>`	`updateSSLOptions(SSLOptions options, boolean force)` Like `updateSSLOptions(io.vertx.core.net.SSLOptions)` but supplying a handler that will be called when the update happened (or has failed).
`void`	`updateTrafficShapingOptions(TrafficShapingOptions options)` Update traffic shaping options `options`, the update happens if valid values are passed for traffic shaping options.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.rxjava3.core.metrics.Measured
newInstance

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<NetServer> __TYPE_ARG
```
- Constructor Detail
  - NetServer
```
public NetServer(NetServer delegate)
```
  - NetServer
```
public NetServer(Object delegate)
```
- Method Detail
  - 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
  - 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
  - connectStream
```
@Deprecated
public ReadStream<NetSocket> connectStream()
```
    Deprecated.
    
    Return the connect stream for this server. The server can only have at most one 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 stream .
    
    Returns:
    
    the connect stream
  - 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 Single<NetServer> listen()
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxListen
```
public Single<NetServer> rxListen()
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - listen
```
public Single<NetServer> listen(int port,
                                String host)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    port - the port to listen on
    
    host - the host to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxListen
```
public Single<NetServer> rxListen(int port,
                                  String host)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    port - the port to listen on
    
    host - the host to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - listen
```
public Single<NetServer> listen(int port)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    port - the port to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxListen
```
public Single<NetServer> rxListen(int port)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    port - the port to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - listen
```
public Single<NetServer> listen(SocketAddress localAddress)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    localAddress - the local address to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - rxListen
```
public Single<NetServer> rxListen(SocketAddress localAddress)
```
    Like listen() but providing a handler that will be notified when the server is listening, or fails.
    
    Parameters:
    
    localAddress - the local address to listen on
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - close
```
public Completable close()
```
    Like close() but supplying a handler that will be notified when close is complete.
    
    Returns:
  - rxClose
```
public Completable rxClose()
```
    Like close() but supplying a handler that will be notified when close is complete.
    
    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 Single<Boolean> updateSSLOptions(SSLOptions options)
```
    Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
    
    Parameters:
    
    options - the new SSL options
    
    Returns:
  - rxUpdateSSLOptions
```
public Single<Boolean> rxUpdateSSLOptions(SSLOptions options)
```
    Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
    
    Parameters:
    
    options - the new SSL options
    
    Returns:
  - updateSSLOptions
```
public Single<Boolean> updateSSLOptions(SSLOptions options,
                                        boolean force)
```
    Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
    
    Parameters:
    
    options - the new SSL options
    
    force - force the update when options are equals
    
    Returns:
  - rxUpdateSSLOptions
```
public Single<Boolean> rxUpdateSSLOptions(SSLOptions options,
                                          boolean force)
```
    Like updateSSLOptions(io.vertx.core.net.SSLOptions) but supplying a handler that will be called when the update happened (or has failed).
    
    Parameters:
    
    options - the new SSL options
    
    force - force the update when options are equals
    
    Returns:
  - updateTrafficShapingOptions
```
public void updateTrafficShapingOptions(TrafficShapingOptions options)
```
    Update traffic shaping options options, the update happens if valid values are passed for traffic shaping options. This update happens synchronously and at best effort for rate update to take effect immediately.
    
    Parameters:
    
    options - the new traffic shaping options
  - newInstance
```
public static NetServer newInstance(NetServer arg)
```

Class NetServer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.rxjava3.core.metrics.Measured

Field Detail

__TYPE_ARG

Constructor Detail

NetServer

NetServer

Method Detail

toString

equals

hashCode

getDelegate

isMetricsEnabled

connectStream

connectHandler

listen

rxListen

listen

rxListen

listen

rxListen

listen

rxListen

close

rxClose

actualPort

updateSSLOptions

rxUpdateSSLOptions

updateSSLOptions

rxUpdateSSLOptions

updateTrafficShapingOptions

newInstance