Package io.vertx.rxjava.core.net

Class NetServer

java.lang.Object

io.vertx.rxjava.core.net.NetServer

All Implemented Interfaces:

RxDelegate, Measured

public class NetServer
extends Object
implements 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 Summary

Fields

Modifier and Type	Field	Description
static TypeArg<NetServer>	__TYPE_ARG

Constructor Summary

Constructors

Constructor	Description
NetServer(NetServer delegate)
NetServer(Object delegate)

Method Summary

Modifier and Type	Method	Description
int	actualPort()	The actual port the server is listening on.
void	close()	Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete.
void	close(Handler<AsyncResult<Void>> completionHandler)	Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) 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
NetServer	listen()	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(int port)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(int port, Handler<AsyncResult<NetServer>> listenHandler)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(int port, String host)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(int port, String host, Handler<AsyncResult<NetServer>> listenHandler)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(Handler<AsyncResult<NetServer>> listenHandler)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(SocketAddress localAddress)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
NetServer	listen(SocketAddress localAddress, Handler<AsyncResult<NetServer>> listenHandler)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
static NetServer	newInstance(NetServer arg)
rx.Single<Void>	rxClose()	Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete.
rx.Single<NetServer>	rxListen()	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
rx.Single<NetServer>	rxListen(int port)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
rx.Single<NetServer>	rxListen(int port, String host)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
rx.Single<NetServer>	rxListen(SocketAddress localAddress)	Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.
rx.Single<Boolean>	rxUpdateSSLOptions(SSLOptions options)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).
rx.Single<Boolean>	rxUpdateSSLOptions(SSLOptions options, boolean force)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).
String	toString()
void	updateSSLOptions(SSLOptions options)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).
void	updateSSLOptions(SSLOptions options, boolean force)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).
void	updateSSLOptions(SSLOptions options, boolean force, Handler<AsyncResult<Boolean>> handler)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).
void	updateSSLOptions(SSLOptions options, Handler<AsyncResult<Boolean>> handler)	Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) 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

Field Detail

__TYPE_ARG

public static final 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

Specified by:

getDelegate in interface 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

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 NetServer listen(Handler<AsyncResult<NetServer>> listenHandler)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.

Parameters:

listenHandler - handler that will be notified when listening or failed

Returns:

a reference to this, so the API can be used fluently

listen

public NetServer listen()

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 rx.Single<NetServer> rxListen()

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 NetServer listen(int port,
                        String host,
                        Handler<AsyncResult<NetServer>> listenHandler)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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

listenHandler - handler that will be notified when listening or failed

Returns:

a reference to this, so the API can be used fluently

listen

public NetServer listen(int port,
                        String host)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 rx.Single<NetServer> rxListen(int port,
                                     String host)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 NetServer listen(int port,
                        Handler<AsyncResult<NetServer>> listenHandler)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.

Parameters:

port - the port to listen on

listenHandler - handler that will be notified when listening or failed

Returns:

a reference to this, so the API can be used fluently

listen

public NetServer listen(int port)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 rx.Single<NetServer> rxListen(int port)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 NetServer listen(SocketAddress localAddress,
                        Handler<AsyncResult<NetServer>> listenHandler)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) but providing a handler that will be notified when the server is listening, or fails.

Parameters:

localAddress - the local address to listen on

listenHandler - handler that will be notified when listening or failed

Returns:

a reference to this, so the API can be used fluently

listen

public NetServer listen(SocketAddress localAddress)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 rx.Single<NetServer> rxListen(SocketAddress localAddress)

Like listen(io.vertx.core.Handler<io.vertx.core.AsyncResult<io.vertx.rxjava.core.net.NetServer>>) 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 void close(Handler<AsyncResult<Void>> completionHandler)

Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete.

Parameters:

completionHandler - the handler

close

public void close()

Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) but supplying a handler that will be notified when close is complete.

rxClose

public rx.Single<Void> rxClose()

Like close(io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Void>>) 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 void updateSSLOptions(SSLOptions options,
                             Handler<AsyncResult<Boolean>> handler)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).

Parameters:

options - the new SSL options

handler - the update handler

updateSSLOptions

public void updateSSLOptions(SSLOptions options)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).

Parameters:

options - the new SSL options

rxUpdateSSLOptions

public rx.Single<Boolean> rxUpdateSSLOptions(SSLOptions options)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) but supplying a handler that will be called when the update happened (or has failed).

Parameters:

options - the new SSL options

Returns:

updateSSLOptions

public void updateSSLOptions(SSLOptions options,
                             boolean force,
                             Handler<AsyncResult<Boolean>> handler)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) 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

handler - the update handler

updateSSLOptions

public void updateSSLOptions(SSLOptions options,
                             boolean force)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) 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

rxUpdateSSLOptions

public rx.Single<Boolean> rxUpdateSSLOptions(SSLOptions options,
                                             boolean force)

Like updateSSLOptions(io.vertx.core.net.SSLOptions, io.vertx.core.Handler<io.vertx.core.AsyncResult<java.lang.Boolean>>) 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)