org.vertx.java.core.net.impl

Class DefaultNetServer

java.lang.Object

org.vertx.java.core.net.impl.DefaultNetServer

All Implemented Interfaces:

Closeable, NetServer, ServerSSLSupport<NetServer>, ServerTCPSupport<NetServer>, SSLSupport<NetServer>, TCPSupport<NetServer>

public class DefaultNetServer
extends java.lang.Object
implements NetServer, Closeable

Constructor Summary

Constructors

Constructor and Description
DefaultNetServer(VertxInternal vertx)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the server.
void	close(Handler<AsyncResult<java.lang.Void>> done) Close the server.
NetServer	connectHandler(Handler<NetSocket> connectHandler) Supply a connect handler for this server.
int	getAcceptBacklog()
java.lang.String	getKeyStorePassword()
java.lang.String	getKeyStorePath()
int	getReceiveBufferSize()
int	getSendBufferSize()
int	getSoLinger()
int	getTrafficClass()
java.lang.String	getTrustStorePassword()
java.lang.String	getTrustStorePath()
java.lang.String	host() The host
boolean	isClientAuthRequired() Is client auth required?
boolean	isReuseAddress()
boolean	isSSL()
boolean	isTCPKeepAlive()
boolean	isTCPNoDelay()
boolean	isUsePooledBuffers()
NetServer	listen(int port) Tell the server to start listening on all available interfaces and port port.
NetServer	listen(int port, Handler<AsyncResult<NetServer>> listenHandler) Instruct the server to listen for incoming connections on the specified port and all available interfaces.
NetServer	listen(int port, java.lang.String host) Tell the server to start listening on port port and hostname or ip address given by host.
NetServer	listen(int port, java.lang.String host, Handler<AsyncResult<NetServer>> listenHandler) Instruct the server to listen for incoming connections on the specified port and host.
int	port() The actual port the server is listening on.
NetServer	setAcceptBacklog(int backlog) Set the accept backlog
NetServer	setClientAuthRequired(boolean required) Set required to true if you want the server to request client authentication from any connecting clients.
NetServer	setKeyStorePassword(java.lang.String pwd) Set the password for the SSL key store.
NetServer	setKeyStorePath(java.lang.String path) Set the path to the SSL key store.
NetServer	setReceiveBufferSize(int size) Set the TCP receive buffer size for connections created by this instance to size in bytes.
NetServer	setReuseAddress(boolean reuse) Set the TCP reuseAddress setting for connections created by this instance to reuse.
NetServer	setSendBufferSize(int size) Set the TCP send buffer size for connections created by this instance to size in bytes.
NetServer	setSoLinger(int linger) Set the TCP soLinger setting for connections created by this instance to linger.
NetServer	setSSL(boolean ssl) If ssl is true, this signifies that any connections will be SSL connections.
NetServer	setTCPKeepAlive(boolean keepAlive) Set the TCP keepAlive setting for connections created by this instance to keepAlive.
NetServer	setTCPNoDelay(boolean tcpNoDelay) If tcpNoDelay is set to true then Nagle's algorithm will turned off for the TCP connections created by this instance.
NetServer	setTrafficClass(int trafficClass) Set the TCP trafficClass setting for connections created by this instance to trafficClass.
NetServer	setTrustStorePassword(java.lang.String pwd) Set the password for the SSL trust store.
NetServer	setTrustStorePath(java.lang.String path) Set the path to the SSL trust store.
NetServer	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

DefaultNetServer

public DefaultNetServer(VertxInternal vertx)

Method Detail

connectHandler

public NetServer connectHandler(Handler<NetSocket> connectHandler)

Description copied from interface: NetServer

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.

Specified by:

connectHandler in interface NetServer

Returns:

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

listen

public NetServer listen(int port)

Description copied from interface: NetServer

Tell the server to start listening on all available interfaces and port port. Be aware this is an async operation and the server may not bound on return of the method.

Specified by:

listen in interface NetServer

listen

public NetServer listen(int port,
               Handler<AsyncResult<NetServer>> listenHandler)

Description copied from interface: NetServer

Instruct the server to listen for incoming connections on the specified port and all available interfaces.

Specified by:

listen in interface NetServer

listen

public NetServer listen(int port,
               java.lang.String host)

Description copied from interface: NetServer

Tell the server to start listening on port port and hostname or ip address given by host. Be aware this is an async operation and the server may not bound on return of the method.

Specified by:

listen in interface NetServer

listen

public NetServer listen(int port,
               java.lang.String host,
               Handler<AsyncResult<NetServer>> listenHandler)

Description copied from interface: NetServer

Instruct the server to listen for incoming connections on the specified port and host. host can be a host name or an IP address.

Specified by:

listen in interface NetServer

close

public void close()

Description copied from interface: NetServer

Close the server. This will close any currently open connections.

Specified by:

close in interface NetServer

close

public void close(Handler<AsyncResult<java.lang.Void>> done)

Description copied from interface: NetServer

Close the server. This will close any currently open connections. The event handler done will be called when the close is complete.

Specified by:

close in interface Closeable

Specified by:

close in interface NetServer

host

public java.lang.String host()

Description copied from interface: NetServer

The host

Specified by:

host in interface NetServer

port

public int port()

Description copied from interface: NetServer

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

Specified by:

port in interface NetServer

isTCPNoDelay

public boolean isTCPNoDelay()

Specified by:

isTCPNoDelay in interface TCPSupport<NetServer>

Returns:

true if Nagle's algorithm is disabled.

getSendBufferSize

public int getSendBufferSize()

Specified by:

getSendBufferSize in interface TCPSupport<NetServer>

Returns:

The TCP send buffer size

getReceiveBufferSize

public int getReceiveBufferSize()

Specified by:

getReceiveBufferSize in interface TCPSupport<NetServer>

Returns:

The TCP receive buffer size

isTCPKeepAlive

public boolean isTCPKeepAlive()

Specified by:

isTCPKeepAlive in interface TCPSupport<NetServer>

Returns:

true if TCP keep alive is enabled

isReuseAddress

public boolean isReuseAddress()

Specified by:

isReuseAddress in interface TCPSupport<NetServer>

Returns:

The value of TCP reuse address

getSoLinger

public int getSoLinger()

Specified by:

getSoLinger in interface TCPSupport<NetServer>

Returns:

the value of TCP so linger

getTrafficClass

public int getTrafficClass()

Specified by:

getTrafficClass in interface TCPSupport<NetServer>

Returns:

the value of TCP traffic class

getAcceptBacklog

public int getAcceptBacklog()

Specified by:

getAcceptBacklog in interface ServerTCPSupport<NetServer>

Returns:

The accept backlog

setTCPNoDelay

public NetServer 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<NetServer>

Returns:

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

setSendBufferSize

public NetServer 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<NetServer>

Returns:

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

setReceiveBufferSize

public NetServer 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<NetServer>

Returns:

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

setTCPKeepAlive

public NetServer 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<NetServer>

Returns:

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

setReuseAddress

public NetServer 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<NetServer>

Returns:

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

setSoLinger

public NetServer 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<NetServer>

Returns:

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

setTrafficClass

public NetServer 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<NetServer>

Returns:

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

setAcceptBacklog

public NetServer setAcceptBacklog(int backlog)

Description copied from interface: ServerTCPSupport

Set the accept backlog

Specified by:

setAcceptBacklog in interface ServerTCPSupport<NetServer>

Returns:

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

isSSL

public boolean isSSL()

Specified by:

isSSL in interface SSLSupport<NetServer>

Returns:

Is SSL enabled?

getKeyStorePath

public java.lang.String getKeyStorePath()

Specified by:

getKeyStorePath in interface SSLSupport<NetServer>

Returns:

Get the key store path

getKeyStorePassword

public java.lang.String getKeyStorePassword()

Specified by:

getKeyStorePassword in interface SSLSupport<NetServer>

Returns:

Get the key store password

getTrustStorePath

public java.lang.String getTrustStorePath()

Specified by:

getTrustStorePath in interface SSLSupport<NetServer>

Returns:

Get the trust store path

getTrustStorePassword

public java.lang.String getTrustStorePassword()

Specified by:

getTrustStorePassword in interface SSLSupport<NetServer>

Returns:

Get trust store password

isClientAuthRequired

public boolean isClientAuthRequired()

Description copied from interface: ServerSSLSupport

Is client auth required?

Specified by:

isClientAuthRequired in interface ServerSSLSupport<NetServer>

setSSL

public NetServer 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<NetServer>

Returns:

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

setKeyStorePath

public NetServer 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<NetServer>

Returns:

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

setKeyStorePassword

public NetServer 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<NetServer>

Returns:

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

setTrustStorePath

public NetServer 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<NetServer>

Returns:

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

setTrustStorePassword

public NetServer 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<NetServer>

Returns:

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

setClientAuthRequired

public NetServer setClientAuthRequired(boolean required)

Description copied from interface: ServerSSLSupport

Set required to true if you want the server to request client authentication from any connecting clients. This is an extra level of security in SSL, and requires clients to provide client certificates. Those certificates must be added to the server trust store.

Specified by:

setClientAuthRequired in interface ServerSSLSupport<NetServer>

Returns:

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

setUsePooledBuffers

public NetServer 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<NetServer>

Returns:

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

isUsePooledBuffers

public boolean isUsePooledBuffers()

Specified by:

isUsePooledBuffers in interface TCPSupport<NetServer>

Returns:

true if pooled buffers are used