public interface NetServer
This class is a thread safe and can safely be used by different threads.
If an instance is instantiated from an event loop then the handlers of the instance will always be called on that same event loop. If an instance is instantiated from some other arbitrary Java thread then and event loop will be assigned to the instance and used when any of its handlers are called.
Instances cannot be used from worker verticles
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the server.
|
void |
close(Handler<java.lang.Void> done)
Close the server.
|
NetServer |
connectHandler(Handler<NetSocket> connectHandler)
Supply a connect handler for this server.
|
java.lang.Integer |
getAcceptBacklog() |
java.lang.String |
getKeyStorePassword() |
java.lang.String |
getKeyStorePath() |
java.lang.Integer |
getReceiveBufferSize() |
java.lang.Integer |
getSendBufferSize() |
java.lang.Integer |
getTrafficClass() |
java.lang.String |
getTrustStorePassword() |
java.lang.String |
getTrustStorePath() |
java.lang.Boolean |
isReuseAddress() |
java.lang.Boolean |
isSoLinger() |
boolean |
isSSL() |
java.lang.Boolean |
isTCPKeepAlive() |
java.lang.Boolean |
isTCPNoDelay() |
NetServer |
listen(int port)
Instruct the server to listen for incoming connections on the specified
port and all available interfaces. |
NetServer |
listen(int port,
java.lang.String host)
Instruct the server to listen for incoming connections on the specified
port and host . |
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(boolean linger)
Set the TCP soLinger setting for connections created by this instance to
reuse . |
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
reuse . |
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 connectHandler(Handler<NetSocket> connectHandler)
NetSocket
and passes it to the
connect handler.NetServer listen(int port)
port
and all available interfaces.NetServer listen(int port, java.lang.String host)
port
and host
. host
can
be a host name or an IP address.void close()
void close(Handler<java.lang.Void> done)
done
will be called
when the close is complete.NetServer setSSL(boolean ssl)
ssl
is true
, this signifies that any connections will be SSL connections.NetServer setKeyStorePath(java.lang.String path)
setSSL(boolean)
has been set to true
.The SSL key store is a standard Java Key Store which should contain the server certificate.
NetServer setKeyStorePassword(java.lang.String pwd)
setSSL(boolean)
has been set to true
.NetServer setTrustStorePath(java.lang.String path)
setSSL(boolean)
has been set to true
.The trust store is a standard Java Key Store, and should contain the certificates of any clients that the server trusts - this is only necessary if client authentication is enabled.
NetServer setTrustStorePassword(java.lang.String pwd)
setSSL(boolean)
has been set to true
.NetServer setClientAuthRequired(boolean required)
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.NetServer setTCPNoDelay(boolean tcpNoDelay)
tcpNoDelay
is set to true
then Nagle's algorithm
will turned off for the TCP connections created by this instance.NetServer setSendBufferSize(int size)
size
in bytes.NetServer setReceiveBufferSize(int size)
size
in bytes.NetServer setTCPKeepAlive(boolean keepAlive)
keepAlive
.NetServer setReuseAddress(boolean reuse)
reuse
.NetServer setSoLinger(boolean linger)
reuse
.NetServer setTrafficClass(int trafficClass)
reuse
.NetServer setAcceptBacklog(int backlog)
java.lang.Boolean isTCPNoDelay()
java.lang.Integer getSendBufferSize()
java.lang.Integer getReceiveBufferSize()
java.lang.Boolean isTCPKeepAlive()
java.lang.Boolean isReuseAddress()
java.lang.Boolean isSoLinger()
java.lang.Integer getTrafficClass()
java.lang.Integer getAcceptBacklog()
boolean isSSL()
java.lang.String getKeyStorePath()
java.lang.String getKeyStorePassword()
java.lang.String getTrustStorePath()
java.lang.String getTrustStorePassword()