io.vertx.reactivex.core.net

Class NetClient

java.lang.Object

io.vertx.reactivex.core.net.NetClient

All Implemented Interfaces:

Measured

public class NetClient
extends Object
implements Measured

A TCP client.

Multiple connections to different servers can be made using the same instance.

This client supports a configurable number of connection attempts and a configurable delay between attempts.

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<NetClient>	__TYPE_ARG

Constructor Summary

Constructors

Constructor and Description
NetClient(NetClient delegate)
NetClient(Object delegate)

Method Summary

Modifier and Type	Method and Description
void	close() Close the client.
void	close(Handler<AsyncResult<Void>> handler) Close the client.
NetClient	connect(int port, String host) Open a connection to a server at the specific port and host.
NetClient	connect(int port, String host, Handler<AsyncResult<NetSocket>> connectHandler) Open a connection to a server at the specific port and host.
NetClient	connect(int port, String host, String serverName) Open a connection to a server at the specific port and host.
NetClient	connect(int port, String host, String serverName, Handler<AsyncResult<NetSocket>> connectHandler) Open a connection to a server at the specific port and host.
NetClient	connect(SocketAddress remoteAddress) Open a connection to a server at the specific remoteAddress.
NetClient	connect(SocketAddress remoteAddress, Handler<AsyncResult<NetSocket>> connectHandler) Open a connection to a server at the specific remoteAddress.
NetClient	connect(SocketAddress remoteAddress, String serverName) Open a connection to a server at the specific remoteAddress.
NetClient	connect(SocketAddress remoteAddress, String serverName, Handler<AsyncResult<NetSocket>> connectHandler) Open a connection to a server at the specific remoteAddress.
boolean	equals(Object o)
NetClient	getDelegate()
int	hashCode()
boolean	isMetricsEnabled() Whether the metrics are enabled for this measured object
static NetClient	newInstance(NetClient arg)
Completable	rxClose() Close the client.
Single<NetSocket>	rxConnect(int port, String host) Open a connection to a server at the specific port and host.
Single<NetSocket>	rxConnect(int port, String host, String serverName) Open a connection to a server at the specific port and host.
Single<NetSocket>	rxConnect(SocketAddress remoteAddress) Open a connection to a server at the specific remoteAddress.
Single<NetSocket>	rxConnect(SocketAddress remoteAddress, String serverName) Open a connection to a server at the specific remoteAddress.
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).
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).

Methods inherited from class java.lang.Object

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

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

newInstance

Field Detail

__TYPE_ARG

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

Constructor Detail

NetClient

public NetClient(NetClient delegate)

NetClient

public NetClient(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 NetClient 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

connect

public NetClient connect(int port,
                         String host,
                         Handler<AsyncResult<NetSocket>> connectHandler)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

connectHandler -

Returns:

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

connect

public NetClient connect(int port,
                         String host)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

Returns:

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

rxConnect

public Single<NetSocket> rxConnect(int port,
                                   String host)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

Returns:

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

connect

public NetClient connect(int port,
                         String host,
                         String serverName,
                         Handler<AsyncResult<NetSocket>> connectHandler)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

serverName - the SNI server name

connectHandler -

Returns:

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

connect

public NetClient connect(int port,
                         String host,
                         String serverName)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

serverName - the SNI server name

Returns:

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

rxConnect

public Single<NetSocket> rxConnect(int port,
                                   String host,
                                   String serverName)

Open a connection to a server at the specific port and host.

host can be a valid host name or IP address. The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

port - the port

host - the host

serverName - the SNI server name

Returns:

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

connect

public NetClient connect(SocketAddress remoteAddress,
                         Handler<AsyncResult<NetSocket>> connectHandler)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

connectHandler -

Returns:

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

connect

public NetClient connect(SocketAddress remoteAddress)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

Returns:

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

rxConnect

public Single<NetSocket> rxConnect(SocketAddress remoteAddress)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

Returns:

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

connect

public NetClient connect(SocketAddress remoteAddress,
                         String serverName,
                         Handler<AsyncResult<NetSocket>> connectHandler)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

serverName - the SNI server name

connectHandler -

Returns:

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

connect

public NetClient connect(SocketAddress remoteAddress,
                         String serverName)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

serverName - the SNI server name

Returns:

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

rxConnect

public Single<NetSocket> rxConnect(SocketAddress remoteAddress,
                                   String serverName)

Open a connection to a server at the specific remoteAddress.

The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Parameters:

remoteAddress - the remote address

serverName - the SNI server name

Returns:

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

close

public void close(Handler<AsyncResult<Void>> handler)

Close the client.

Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

Parameters:

handler -

close

public void close()

Close the client.

Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

rxClose

public Completable rxClose()

Close the client.

Any sockets which have not been closed manually will be closed here. The close is asynchronous and may not complete until some time after the method has returned.

Returns:

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 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 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:

newInstance

public static NetClient newInstance(NetClient arg)