org.vertx.java.core.net.impl

Class DefaultNetClient

java.lang.Object

org.vertx.java.core.net.impl.DefaultNetClient

All Implemented Interfaces:

ClientSSLSupport<NetClient>, NetClient, SSLSupport<NetClient>, TCPSupport<NetClient>

public class DefaultNetClient
extends java.lang.Object
implements NetClient

Constructor Summary

Constructors

Constructor and Description
DefaultNetClient(VertxInternal vertx)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the client.
NetClient	connect(int port, Handler<AsyncResult<NetSocket>> connectCallback) Attempt to open a connection to a server at the specific port and host localhost The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance
NetClient	connect(int port, java.lang.String host, Handler<AsyncResult<NetSocket>> connectHandler) Attempt to open a connection to a server at the specific port and host.
int	getConnectTimeout()
java.lang.String	getKeyStorePassword()
java.lang.String	getKeyStorePath()
int	getReceiveBufferSize()
int	getReconnectAttempts() Get the number of reconnect attempts
long	getReconnectInterval() Get the reconnect interval, in milliseconds.
int	getSendBufferSize()
int	getSoLinger()
int	getTrafficClass()
java.lang.String	getTrustStorePassword()
java.lang.String	getTrustStorePath()
boolean	isReuseAddress()
boolean	isSSL()
boolean	isTCPKeepAlive()
boolean	isTCPNoDelay()
boolean	isTrustAll()
boolean	isUsePooledBuffers()
NetClient	setConnectTimeout(int timeout) Set the connect timeout in milliseconds.
NetClient	setKeyStorePassword(java.lang.String pwd) Set the password for the SSL key store.
NetClient	setKeyStorePath(java.lang.String path) Set the path to the SSL key store.
NetClient	setReceiveBufferSize(int size) Set the TCP receive buffer size for connections created by this instance to size in bytes.
NetClient	setReconnectAttempts(int attempts) Set the number of reconnection attempts.
NetClient	setReconnectInterval(long interval) Set the reconnect interval, in milliseconds
NetClient	setReuseAddress(boolean reuse) Set the TCP reuseAddress setting for connections created by this instance to reuse.
NetClient	setSendBufferSize(int size) Set the TCP send buffer size for connections created by this instance to size in bytes.
NetClient	setSoLinger(int linger) Set the TCP soLinger setting for connections created by this instance to linger.
NetClient	setSSL(boolean ssl) If ssl is true, this signifies that any connections will be SSL connections.
NetClient	setTCPKeepAlive(boolean keepAlive) Set the TCP keepAlive setting for connections created by this instance to keepAlive.
NetClient	setTCPNoDelay(boolean tcpNoDelay) If tcpNoDelay is set to true then Nagle's algorithm will turned off for the TCP connections created by this instance.
NetClient	setTrafficClass(int trafficClass) Set the TCP trafficClass setting for connections created by this instance to trafficClass.
NetClient	setTrustAll(boolean trustAll) If you want an SSL client to trust *all* server certificates rather than match them against those in its trust store, you can set this to true.
NetClient	setTrustStorePassword(java.lang.String pwd) Set the password for the SSL trust store.
NetClient	setTrustStorePath(java.lang.String path) Set the path to the SSL trust store.
NetClient	setUsePooledBuffers(boolean pooledBuffers) Set if vertx should use pooled buffers for performance reasons.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultNetClient

public DefaultNetClient(VertxInternal vertx)

Method Detail

connect

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

Description copied from interface: NetClient

Attempt to 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

Specified by:

connect in interface NetClient

Returns:

a reference to this so multiple method calls can be chained together

connect

public NetClient connect(int port,
                Handler<AsyncResult<NetSocket>> connectCallback)

Description copied from interface: NetClient

Attempt to open a connection to a server at the specific port and host localhost The connect is done asynchronously and on success, a NetSocket instance is supplied via the connectHandler instance

Specified by:

connect in interface NetClient

Returns:

a reference to this so multiple method calls can be chained together

close

public void close()

Description copied from interface: NetClient

Close the client. Any sockets which have not been closed manually will be closed here.

Specified by:

close in interface NetClient

setReconnectAttempts

public NetClient setReconnectAttempts(int attempts)

Description copied from interface: NetClient

Set the number of reconnection attempts. In the event a connection attempt fails, the client will attempt to connect a further number of times, before it fails. Default value is zero.

Specified by:

setReconnectAttempts in interface NetClient

getReconnectAttempts

public int getReconnectAttempts()

Description copied from interface: NetClient

Get the number of reconnect attempts

Specified by:

getReconnectAttempts in interface NetClient

setReconnectInterval

public NetClient setReconnectInterval(long interval)

Description copied from interface: NetClient

Set the reconnect interval, in milliseconds

Specified by:

setReconnectInterval in interface NetClient

getReconnectInterval

public long getReconnectInterval()

Description copied from interface: NetClient

Get the reconnect interval, in milliseconds.

Specified by:

getReconnectInterval in interface NetClient

isTCPNoDelay

public boolean isTCPNoDelay()

Specified by:

isTCPNoDelay in interface TCPSupport<NetClient>

Returns:

true if Nagle's algorithm is disabled.

getSendBufferSize

public int getSendBufferSize()

Specified by:

getSendBufferSize in interface TCPSupport<NetClient>

Returns:

The TCP send buffer size

getReceiveBufferSize

public int getReceiveBufferSize()

Specified by:

getReceiveBufferSize in interface TCPSupport<NetClient>

Returns:

The TCP receive buffer size

isTCPKeepAlive

public boolean isTCPKeepAlive()

Specified by:

isTCPKeepAlive in interface TCPSupport<NetClient>

Returns:

true if TCP keep alive is enabled

isReuseAddress

public boolean isReuseAddress()

Specified by:

isReuseAddress in interface TCPSupport<NetClient>

Returns:

The value of TCP reuse address

getSoLinger

public int getSoLinger()

Specified by:

getSoLinger in interface TCPSupport<NetClient>

Returns:

the value of TCP so linger

getTrafficClass

public int getTrafficClass()

Specified by:

getTrafficClass in interface TCPSupport<NetClient>

Returns:

the value of TCP traffic class

getConnectTimeout

public int getConnectTimeout()

Specified by:

getConnectTimeout in interface NetClient

Returns:

The connect timeout in milliseconds

setTCPNoDelay

public NetClient setTCPNoDelay(boolean tcpNoDelay)

Description copied from interface: TCPSupport

If tcpNoDelay is set to true then Nagle's algorithm will turned off for the TCP connections created by this instance.

Specified by:

setTCPNoDelay in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setSendBufferSize

public NetClient setSendBufferSize(int size)

Description copied from interface: TCPSupport

Set the TCP send buffer size for connections created by this instance to size in bytes.

Specified by:

setSendBufferSize in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setReceiveBufferSize

public NetClient setReceiveBufferSize(int size)

Description copied from interface: TCPSupport

Set the TCP receive buffer size for connections created by this instance to size in bytes.

Specified by:

setReceiveBufferSize in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setTCPKeepAlive

public NetClient setTCPKeepAlive(boolean keepAlive)

Description copied from interface: TCPSupport

Set the TCP keepAlive setting for connections created by this instance to keepAlive.

Specified by:

setTCPKeepAlive in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setReuseAddress

public NetClient setReuseAddress(boolean reuse)

Description copied from interface: TCPSupport

Set the TCP reuseAddress setting for connections created by this instance to reuse.

Specified by:

setReuseAddress in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setSoLinger

public NetClient setSoLinger(int linger)

Description copied from interface: TCPSupport

Set the TCP soLinger setting for connections created by this instance to linger. Using a negative value will disable soLinger.

Specified by:

setSoLinger in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setTrafficClass

public NetClient setTrafficClass(int trafficClass)

Description copied from interface: TCPSupport

Set the TCP trafficClass setting for connections created by this instance to trafficClass.

Specified by:

setTrafficClass in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

setConnectTimeout

public NetClient setConnectTimeout(int timeout)

Description copied from interface: NetClient

Set the connect timeout in milliseconds.

Specified by:

setConnectTimeout in interface NetClient

Returns:

a reference to this so multiple method calls can be chained together

isSSL

public boolean isSSL()

Specified by:

isSSL in interface SSLSupport<NetClient>

Returns:

Is SSL enabled?

getKeyStorePath

public java.lang.String getKeyStorePath()

Specified by:

getKeyStorePath in interface SSLSupport<NetClient>

Returns:

Get the key store path

getKeyStorePassword

public java.lang.String getKeyStorePassword()

Specified by:

getKeyStorePassword in interface SSLSupport<NetClient>

Returns:

Get the key store password

getTrustStorePath

public java.lang.String getTrustStorePath()

Specified by:

getTrustStorePath in interface SSLSupport<NetClient>

Returns:

Get the trust store path

getTrustStorePassword

public java.lang.String getTrustStorePassword()

Specified by:

getTrustStorePassword in interface SSLSupport<NetClient>

Returns:

Get trust store password

isTrustAll

public boolean isTrustAll()

Specified by:

isTrustAll in interface ClientSSLSupport<NetClient>

Returns:

true if this client will trust all server certificates.

setSSL

public NetClient setSSL(boolean ssl)

Description copied from interface: SSLSupport

If ssl is true, this signifies that any connections will be SSL connections.

Specified by:

setSSL in interface SSLSupport<NetClient>

Returns:

A reference to this, so multiple invocations can be chained together.

setKeyStorePath

public NetClient setKeyStorePath(java.lang.String path)

Description copied from interface: SSLSupport

Set the path to the SSL key store. This method should only be used in SSL mode, i.e. after SSLSupport.setSSL(boolean) has been set to true.

The SSL key store is a standard Java Key Store, and will contain the client certificate. Client certificates are only required if the server requests client authentication.

Specified by:

setKeyStorePath in interface SSLSupport<NetClient>

Returns:

A reference to this, so multiple invocations can be chained together.

setKeyStorePassword

public NetClient setKeyStorePassword(java.lang.String pwd)

Description copied from interface: SSLSupport

Set the password for the SSL key store. This method should only be used in SSL mode, i.e. after SSLSupport.setSSL(boolean) has been set to true.

Specified by:

setKeyStorePassword in interface SSLSupport<NetClient>

Returns:

A reference to this, so multiple invocations can be chained together.

setTrustStorePath

public NetClient setTrustStorePath(java.lang.String path)

Description copied from interface: SSLSupport

Set the path to the SSL trust store. This method should only be used in SSL mode, i.e. after SSLSupport.setSSL(boolean) has been set to true.

The trust store is a standard Java Key Store, and should contain the certificates of any servers that the client trusts.

Specified by:

setTrustStorePath in interface SSLSupport<NetClient>

Returns:

A reference to this, so multiple invocations can be chained together.

setTrustStorePassword

public NetClient setTrustStorePassword(java.lang.String pwd)

Description copied from interface: SSLSupport

Set the password for the SSL trust store. This method should only be used in SSL mode, i.e. after SSLSupport.setSSL(boolean) has been set to true.

Specified by:

setTrustStorePassword in interface SSLSupport<NetClient>

Returns:

A reference to this, so multiple invocations can be chained together.

setTrustAll

public NetClient setTrustAll(boolean trustAll)

Description copied from interface: ClientSSLSupport

If you want an SSL client to trust *all* server certificates rather than match them against those in its trust store, you can set this to true.

Use this with caution as you may be exposed to "main in the middle" attacks

Specified by:

setTrustAll in interface ClientSSLSupport<NetClient>

Parameters:

trustAll - Set to true if you want to trust all server certificates

setUsePooledBuffers

public NetClient setUsePooledBuffers(boolean pooledBuffers)

Description copied from interface: TCPSupport

Set if vertx should use pooled buffers for performance reasons. Doing so will give the best throughput but may need a bit higher memory footprint.

Specified by:

setUsePooledBuffers in interface TCPSupport<NetClient>

Returns:

a reference to this so multiple method calls can be chained together

isUsePooledBuffers

public boolean isUsePooledBuffers()

Specified by:

isUsePooledBuffers in interface TCPSupport<NetClient>

Returns:

true if pooled buffers are used