Vert.x 4.5.13 · io.vertx.core.net.impl.NetClientImpl

Modifier and Type	Field and Description
private final ChannelGroup	channelGroup
private final CloseFuture	closeFuture
protected final int	idleTimeout
private final TimeUnit	idleTimeoutUnit
private static final Logger	log
protected final boolean	logEnabled
private final TCPMetrics<S>	metrics
private final NetClientOptions	options
private final Predicate<SocketAddress>	proxyFilter
protected final int	readIdleTimeout
private Future<SslContextUpdate>	sslChannelProvider
private final SSLHelper	sslHelper
private final VertxInternal	vertx
protected final int	writeIdleTimeout

Access	Constructor and Description
public	NetClientImpl(VertxInternal vertx, TCPMetrics<S> metrics, NetClientOptions options, CloseFuture closeFuture)

Method Summary

Modifier and Type	Method and Description
public void	close(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetClient.close. Close the client.
public Future<Void>	close() Implements io.vertx.core.net.NetClient.close. Like `close(Handler)` but returns a `Future` of the asynchronous result
public void	close(Promise<Void> the promise to signal when close has completed completion) Implements io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed.
public Future<NetSocket>	connect(int port, String host) Implements io.vertx.core.net.NetClient.connect. Like `connect(int, String, Handler)` but returns a `Future` of the asynchronous result
public Future<NetSocket>	connect(int port, String host, String serverName) Implements io.vertx.core.net.NetClient.connect. Like `connect(int, String, String, Handler)` but returns a `Future` of the asynchronous result
public Future<NetSocket>	connect(SocketAddress remoteAddress) Implements io.vertx.core.net.NetClient.connect. Like `connect(SocketAddress, Handler)` but returns a `Future` of the asynchronous result
public Future<NetSocket>	connect(SocketAddress remoteAddress, String serverName) Implements io.vertx.core.net.NetClient.connect. Like `connect(SocketAddress, String, Handler)` but returns a `Future` of the asynchronous result
public Future<NetSocket>	connect(ContextInternal context, SocketAddress remoteAddress, String serverName)
public NetClient	connect(int the port port, String the host host, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Open a connection to a server at the specific `port` and `host`.
public NetClient	connect(int the port port, String the host host, String the SNI server name serverName, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Open a connection to a server at the specific `port` and `host`.
public NetClient	connect(SocketAddress the remote address remoteAddress, String the SNI server name serverName, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Open a connection to a server at the specific `remoteAddress`.
public NetClient	connect(SocketAddress the remote address remoteAddress, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Open a connection to a server at the specific `remoteAddress`.
private void	connect(SocketAddress remoteAddress, String serverName, Promise<NetSocket> connectHandler, ContextInternal ctx)
private void	connected(ContextInternal context, Channel ch, Promise<NetSocket> connectHandler, SocketAddress remoteAddress, SslChannelProvider sslChannelProvider, String applicationLayerProtocol, boolean registerWriteHandlers)
public void	connectInternal(ProxyOptions optional proxy configuration proxyOptions, SocketAddress the server address remoteAddress, SocketAddress the peer address (along with SSL) peerAddress, String the SNI server name (along with SSL) serverName, boolean whether to use SSL ssl, boolean wether to use ALPN (along with SSL) useAlpn, boolean whether to register event-bus write handlers registerWriteHandlers, Promise<NetSocket> the promise to resolve with the connect result connectHandler, ContextInternal the socket context context, int how many times reconnection is reattempted remainingAttempts) Open a socket to the `remoteAddress` server.
private void	connectInternal2(ProxyOptions proxyOptions, SocketAddress remoteAddress, SocketAddress peerAddress, SslChannelProvider sslChannelProvider, String serverName, boolean ssl, boolean useAlpn, boolean registerWriteHandlers, Promise<NetSocket> connectHandler, ContextInternal context, int remainingAttempts)
private void	failed(ContextInternal context, Channel ch, Throwable th, Promise<NetSocket> connectHandler)
public Metrics	getMetrics() Implements io.vertx.core.spi.metrics.MetricsProvider.getMetrics. Returns the metrics implementation.
protected void	initChannel(ChannelPipeline pipeline)
public boolean	isMetricsEnabled() Overrides default io.vertx.core.metrics.Measured.isMetricsEnabled. Whether the metrics are enabled for this measured object
public Future<Boolean>	updateSSLOptions(SSLOptions the new SSL options options, boolean force the update when options are equals force) Implements io.vertx.core.net.NetClient.updateSSLOptions. Update the client with new SSL `options`, the update happens if the options object is valid and different from the existing options object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

channelGroup	back to summary
private final ChannelGroup channelGroup

closeFuture	back to summary
private final CloseFuture closeFuture

idleTimeout	back to summary
protected final int idleTimeout

idleTimeoutUnit	back to summary
private final TimeUnit idleTimeoutUnit

log	back to summary
private static final Logger log

logEnabled	back to summary
protected final boolean logEnabled

metrics	back to summary
private final TCPMetrics<S> metrics

options	back to summary
private final NetClientOptions options

proxyFilter	back to summary
private final Predicate<SocketAddress> proxyFilter

readIdleTimeout	back to summary
protected final int readIdleTimeout

sslChannelProvider	back to summary
private Future<SslContextUpdate> sslChannelProvider

sslHelper	back to summary
private final SSLHelper sslHelper

vertx	back to summary
private final VertxInternal vertx

writeIdleTimeout	back to summary
protected final int writeIdleTimeout

NetClientImpl	back to summary
public NetClientImpl(VertxInternal vertx, TCPMetrics<S> metrics, NetClientOptions options, CloseFuture closeFuture)

Method Detail

close	back to summary
public void close(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.net.NetClient.close. Doc from io.vertx.core.net.NetClient.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. Annotations @Override

back to summary

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

Implements io.vertx.core.net.NetClient.close.

Doc from io.vertx.core.net.NetClient.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.

Annotations

@Override

close back to summary

close	back to summary
public Future<Void> close() Implements io.vertx.core.net.NetClient.close. Doc from io.vertx.core.net.NetClient.close. Like `close(Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<Void> close()

Implements io.vertx.core.net.NetClient.close.

Doc from io.vertx.core.net.NetClient.close.

Like close(Handler) but returns a Future of the asynchronous result

Annotations

@Override

close back to summary

close	back to summary
public void close(Promise<Void> completion) Implements io.vertx.core.Closeable.close. Doc from io.vertx.core.Closeable.close. Close this resource, the `completion` promise must be notified when the operation has completed. Parameters completion:Promise<Void> the promise to signal when close has completed Annotations @Override

public void close(Promise<Void> completion)

Implements io.vertx.core.Closeable.close.

Doc from io.vertx.core.Closeable.close.

Close this resource, the completion promise must be notified when the operation has completed.

Parameters

completion:Promise<Void>: the promise to signal when close has completed

Annotations

@Override

connect back to summary

connect	back to summary
public Future<NetSocket> connect(int port, String host) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. Like `connect(int, String, Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<NetSocket> connect(int port, String host)

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

Like connect(int, String, Handler) but returns a Future of the asynchronous result

Annotations

@Override

connect back to summary

connect	back to summary
public Future<NetSocket> connect(int port, String host, String serverName) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. Like `connect(int, String, String, Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<NetSocket> connect(int port, String host, String serverName)

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

Like connect(int, String, String, Handler) but returns a Future of the asynchronous result

Annotations

@Override

connect back to summary

connect	back to summary
public Future<NetSocket> connect(SocketAddress remoteAddress) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. Like `connect(SocketAddress, Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<NetSocket> connect(SocketAddress remoteAddress)

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

Like connect(SocketAddress, Handler) but returns a Future of the asynchronous result

Annotations

@Override

connect back to summary

connect	back to summary
public Future<NetSocket> connect(SocketAddress remoteAddress, String serverName) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. Like `connect(SocketAddress, String, Handler)` but returns a `Future` of the asynchronous result Annotations @Override

public Future<NetSocket> connect(SocketAddress remoteAddress, String serverName)

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

Like connect(SocketAddress, String, Handler) but returns a Future of the asynchronous result

Annotations

@Override

connect	back to summary
public Future<NetSocket> connect(ContextInternal context, SocketAddress remoteAddress, String serverName)

connect back to summary

connect	back to summary
public NetClient connect(int port, String host, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. 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:int the port host:String the host Returns:NetClient a reference to this, so the API can be used fluently

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

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

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:int: the port
host:String: the host

Returns:NetClient

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

connect back to summary

connect	back to summary
public NetClient connect(int port, String host, String serverName, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. 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:int the port host:String the host serverName:String the SNI server name Returns:NetClient a reference to this, so the API can be used fluently Annotations @Override

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

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

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:int: the port
host:String: the host
serverName:String: the SNI server name

Returns:NetClient

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

Annotations

@Override

connect back to summary

connect	back to summary
public NetClient connect(SocketAddress remoteAddress, String serverName, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. 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:SocketAddress the remote address serverName:String the SNI server name Returns:NetClient a reference to this, so the API can be used fluently Annotations @Override

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

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

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:SocketAddress: the remote address
serverName:String: the SNI server name

Returns:NetClient

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

Annotations

@Override

connect back to summary

connect	back to summary
public NetClient connect(SocketAddress remoteAddress, Handler<AsyncResult<NetSocket>> connectHandler) Implements io.vertx.core.net.NetClient.connect. Doc from io.vertx.core.net.NetClient.connect. 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:SocketAddress the remote address Returns:NetClient a reference to this, so the API can be used fluently Annotations @Override

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

Implements io.vertx.core.net.NetClient.connect.

Doc from io.vertx.core.net.NetClient.connect.

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:SocketAddress: the remote address

Returns:NetClient

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

Annotations

@Override

connect	back to summary
private void connect(SocketAddress remoteAddress, String serverName, Promise<NetSocket> connectHandler, ContextInternal ctx)

connected	back to summary
private void connected(ContextInternal context, Channel ch, Promise<NetSocket> connectHandler, SocketAddress remoteAddress, SslChannelProvider sslChannelProvider, String applicationLayerProtocol, boolean registerWriteHandlers)

connectInternal back to summary

connectInternal	back to summary
public void connectInternal(ProxyOptions proxyOptions, SocketAddress remoteAddress, SocketAddress peerAddress, String serverName, boolean ssl, boolean useAlpn, boolean registerWriteHandlers, Promise<NetSocket> connectHandler, ContextInternal context, int remainingAttempts) Open a socket to the `remoteAddress` server. Parameters proxyOptions:ProxyOptions optional proxy configuration remoteAddress:SocketAddress the server address peerAddress:SocketAddress the peer address (along with SSL) serverName:String the SNI server name (along with SSL) ssl:boolean whether to use SSL useAlpn:boolean wether to use ALPN (along with SSL) registerWriteHandlers:boolean whether to register event-bus write handlers connectHandler:Promise<NetSocket> the promise to resolve with the connect result context:ContextInternal the socket context remainingAttempts:int how many times reconnection is reattempted

public void connectInternal(ProxyOptions proxyOptions, SocketAddress remoteAddress, SocketAddress peerAddress, String serverName, boolean ssl, boolean useAlpn, boolean registerWriteHandlers, Promise<NetSocket> connectHandler, ContextInternal context, int remainingAttempts)

Open a socket to the remoteAddress server.

Parameters

proxyOptions:ProxyOptions: optional proxy configuration
remoteAddress:SocketAddress: the server address
peerAddress:SocketAddress: the peer address (along with SSL)
serverName:String: the SNI server name (along with SSL)
ssl:boolean: whether to use SSL
useAlpn:boolean: wether to use ALPN (along with SSL)
registerWriteHandlers:boolean: whether to register event-bus write handlers
connectHandler:Promise<NetSocket>: the promise to resolve with the connect result
context:ContextInternal: the socket context
remainingAttempts:int: how many times reconnection is reattempted

connectInternal2	back to summary
private void connectInternal2(ProxyOptions proxyOptions, SocketAddress remoteAddress, SocketAddress peerAddress, SslChannelProvider sslChannelProvider, String serverName, boolean ssl, boolean useAlpn, boolean registerWriteHandlers, Promise<NetSocket> connectHandler, ContextInternal context, int remainingAttempts)

failed	back to summary
private void failed(ContextInternal context, Channel ch, Throwable th, Promise<NetSocket> connectHandler)

getMetrics	back to summary
public Metrics getMetrics() Implements io.vertx.core.spi.metrics.MetricsProvider.getMetrics. Doc from io.vertx.core.spi.metrics.MetricsProvider.getMetrics. Returns the metrics implementation. Returns:Metrics the metrics Annotations @Override

getMetrics

back to summary

public Metrics getMetrics()

Implements io.vertx.core.spi.metrics.MetricsProvider.getMetrics.

Doc from io.vertx.core.spi.metrics.MetricsProvider.getMetrics.

Returns the metrics implementation.

Returns:Metrics

the metrics

Annotations

@Override

initChannel	back to summary
protected void initChannel(ChannelPipeline pipeline)

isMetricsEnabled back to summary

isMetricsEnabled	back to summary
public boolean isMetricsEnabled() Overrides default io.vertx.core.metrics.Measured.isMetricsEnabled. Doc from io.vertx.core.metrics.Measured.isMetricsEnabled. Whether the metrics are enabled for this measured object Returns:boolean `true` if metrics are enabled Annotations @Override

public boolean isMetricsEnabled()

Overrides default io.vertx.core.metrics.Measured.isMetricsEnabled.

Doc from io.vertx.core.metrics.Measured.isMetricsEnabled.

Whether the metrics are enabled for this measured object

Returns:boolean

true if metrics are enabled

Annotations

@Override

updateSSLOptions back to summary

updateSSLOptions	back to summary
public Future<Boolean> updateSSLOptions(SSLOptions options, boolean force) Implements io.vertx.core.net.NetClient.updateSSLOptions. Doc from io.vertx.core.net.NetClient.updateSSLOptions. Update the client 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:SSLOptions the new SSL options force:boolean force the update when options are equals Returns:Future<Boolean> a future signaling the update success Annotations @Override

public Future<Boolean> updateSSLOptions(SSLOptions options, boolean force)

Implements io.vertx.core.net.NetClient.updateSSLOptions.

Doc from io.vertx.core.net.NetClient.updateSSLOptions.

Update the client 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:SSLOptions: the new SSL options
force:boolean: force the update when options are equals

Returns:Future<Boolean>

a future signaling the update success

Annotations

@Override

public Class NetClientImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail